Skip to content
logo
IMAS-Python 2.1.0.post2.dev7 documentation
imas.ids_base.IDSDoc
Initializing search
    IMAS-Python
    IMAS-Python
      • IMAS-Python manual
      • Installing IMAS-Python
      • IMAS-Python 5 minute introduction
      • Using multiple DD versions in the same environment
      • IDS validation
      • Resampling
      • IDS metadata
      • Lazy loading
      • MDSplus in IMAS-Python
      • Identifiers
      • Configuring IMAS-Python
      • IMAS-Python Command Line tool
      • IMAS netCDF files & Xarray
      • Changelog
      • IMAS-Python Examples
      • IMAS-Python 101
      • Advanced IMAS-Python
      • API reference
      • API autosummary
        • imas
          • imas.PUBLISHED_DOCUMENTATION_ROOT
          • imas.OLDEST_SUPPORTED_VERSION
          • imas.backends
          • imas.convert_core_edge_plasma
          • imas.db_entry
          • imas.dd_zip
          • imas.exception
          • imas.ids_base
            • imas.ids_base.IDSBase
            • imas.ids_base.IDSDoc
              • Cimas.ids_base.IDSDoc
                • M__init__
          • imas.ids_convert
          • imas.ids_coordinates
          • imas.ids_data_type
          • imas.ids_defs
          • imas.ids_factory
          • imas.ids_identifiers
          • imas.ids_metadata
          • imas.ids_path
          • imas.ids_primitive
          • imas.ids_struct_array
          • imas.ids_structure
          • imas.ids_toplevel
          • imas.setup_logging
          • imas.training
          • imas.util
      • IMAS-Python architecture
      • Code style and linting
      • CI configuration
      • Benchmarking IMAS-Python
      • IMAS-Python development and release process
    • Cimas.ids_base.IDSDoc
      • M__init__

    imas.ids_base.IDSDoc¶

    class imas.ids_base.IDSDoc(original_doc: str)¶

    Bases: object

    Helper class to show DD documentation on IDS objects.

    This object implements the descriptor protocol, see: https://docs.python.org/3/howto/descriptor.html.

    __init__(original_doc: str)¶

    Methods

    __init__(original_doc)


    Last update: 2026-01-28
    Back to top
    Previous imas.ids_base.IDSBase
    Next imas.ids_convert
    © Copyright 2020-2026, ITER Organization.
    Created using Sphinx 6.2.1. and Sphinx-Immaterial