imas-python 2.1.0.post1__tar.gz → 2.3.0__tar.gz

imas_python-2.3.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  # Enable version updates for Github Actions
+  - package-ecosystem: "github-actions"
+    # Look for `/.github/workflows` and `/action.yml` or `.yaml`
+    directory: "/"
+    # Check for updates once a week
+    schedule:
+      interval: "weekly"
+

{imas_python-2.1.0.post1 → imas_python-2.3.0}/.github/workflows/linting.yml

@@ -12,10 +12,10 @@ jobs:
 
     steps:
       - name: Checkout IMAS-Python sources
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           # until saxonche is available in 3.13
           # https://saxonica.plan.io/issues/6561

{imas_python-2.1.0.post1 → imas_python-2.3.0}/.github/workflows/publish.yml

@@ -10,11 +10,11 @@ jobs:
     name: Build distribution
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         fetch-depth: 0 
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         # until saxonche is available in 3.13
         # https://saxonica.plan.io/issues/6561
@@ -25,7 +25,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build .
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: python-package-distributions
         path: dist/
@@ -43,7 +43,7 @@ jobs:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: python-package-distributions
         path: dist/
@@ -63,7 +63,7 @@ jobs:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: python-package-distributions
         path: dist/

{imas_python-2.1.0.post1 → imas_python-2.3.0}/.github/workflows/test_with_pytest.yml

@@ -14,11 +14,11 @@ jobs:
     
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Python ${{ matrix.python-version }}
 
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Display Python version
@@ -37,13 +37,13 @@ jobs:
           python -m pytest -n=auto --cov=imas --cov-report=term-missing --cov-report=xml:coverage.xml --cov-report=html:htmlcov --junit-xml=junit.xml
 
       - name: Upload coverage report ${{ matrix.python-version }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: coverage-report-${{ matrix.python-version }}
           path: htmlcov
 
       - name: Upload test report ${{ matrix.python-version }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: test-report-${{ matrix.python-version }}
           path: junit.xml

{imas_python-2.1.0.post1 → imas_python-2.3.0}/.readthedocs.yml

@@ -20,4 +20,4 @@ python:
 sphinx:
   builder: html
   configuration: docs/source/conf.py
-  fail_on_warning: false
+  fail_on_warning: true

{imas_python-2.1.0.post1/imas_python.egg-info → imas_python-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: imas-python
-Version: 2.1.0.post1
+Version: 2.3.0
 Summary: Pythonic wrappers for the IMAS Access Layer
 Author: ITER Organization
 Author-email: Karel Lucas van de Plassche <karelvandeplassche@gmail.com>, Daan van Vugt <dvanvugt@ignitioncomputing.com>, Maarten Sebregts <msebregts@ignitioncomputing.com>, imas-support@iter.org

{imas_python-2.1.0.post1 → imas_python-2.3.0}/conftest.py

@@ -9,7 +9,6 @@
 import functools
 import logging
 import os
-import sys
 from copy import deepcopy
 from pathlib import Path
 
@@ -22,7 +21,6 @@ import numpy as np
 import pytest
 from packaging.version import Version
 
-from imas.backends.imas_core.imas_interface import has_imas as _has_imas
 from imas.backends.imas_core.imas_interface import ll_interface, lowlevel
 from imas.dd_zip import dd_etree, dd_xml_versions, latest_dd_version
 from imas.ids_defs import (
@@ -39,17 +37,7 @@ logger.setLevel(logging.INFO)
 
 os.environ["IMAS_AL_DISABLE_VALIDATE"] = "1"
 
-
-try:
-    import imas  # noqa
-except ImportError:
-
-    class SkipOnIMASAccess:
-        def __getattr__(self, attr):
-            pytest.skip("This test requires the `imas` HLI, which is not available.")
-
-    # Any test that tries to access an attribute from the `imas` package will be skipped
-    sys.modules["imas"] = SkipOnIMASAccess()
+import imas  # noqa
 
 
 def pytest_addoption(parser):
@@ -78,7 +66,6 @@ except ImasCoreBackendException as iex:
     if "not available" in str(iex.message):
         _BACKENDS.pop("mdsplus")
 
-
 try:
     import pytest_xdist
 except ImportError:
@@ -91,28 +78,11 @@ except ImportError:
 @pytest.fixture(params=_BACKENDS)
 def backend(pytestconfig: pytest.Config, request: pytest.FixtureRequest):
     backends_provided = any(map(pytestconfig.getoption, _BACKENDS))
-    if not _has_imas:
-        if backends_provided:
-            raise RuntimeError(
-                "Explicit backends are provided, but IMAS is not available."
-            )
-        pytest.skip("No IMAS available, skip tests using a backend")
     if backends_provided and not pytestconfig.getoption(request.param):
         pytest.skip(f"Tests for {request.param} backend are skipped.")
     return _BACKENDS[request.param]
 
 
-@pytest.fixture()
-def has_imas():
-    return _has_imas
-
-
-@pytest.fixture()
-def requires_imas():
-    if not _has_imas:
-        pytest.skip("No IMAS available")
-
-
 def pytest_generate_tests(metafunc):
     if "ids_name" in metafunc.fixturenames:
         if metafunc.config.getoption("ids"):
@@ -214,7 +184,7 @@ def _lowlevel_wrapper(original_method):
 
 
 @pytest.fixture
-def log_lowlevel_calls(monkeypatch, requires_imas):
+def log_lowlevel_calls(monkeypatch):
     """Debugging fixture to log calls to the imas lowlevel module."""
     for al_function in dir(lowlevel):
         if al_function.startswith("ual_") or al_function.startswith("al"):

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/api.rst

@@ -7,16 +7,24 @@ This page provides an auto-generated summary of IMAS-Python's API. For more deta
 and examples, refer to the relevant chapters in the main part of the
 documentation.
 
-IMAS-Python IDS manipulation
-----------------------------
+IMAS-Python public API
+----------------------
 
 .. currentmodule:: imas
 
 .. autosummary::
 
+   convert_core_edge_plasma.convert_to_plasma_profiles
+   convert_core_edge_plasma.convert_to_plasma_sources
+   convert_core_edge_plasma.convert_to_plasma_transport
    db_entry.DBEntry
+   ids_convert.convert_ids
+   ids_data_type.IDSDataType
    ids_factory.IDSFactory
-   ids_toplevel.IDSToplevel
+   ids_identifiers.identifiers
+   ids_metadata.IDSMetadata
+   ids_metadata.IDSType
    ids_primitive.IDSPrimitive
-   ids_structure.IDSStructure
    ids_struct_array.IDSStructArray
+   ids_structure.IDSStructure
+   ids_toplevel.IDSToplevel

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/changelog.rst

@@ -3,6 +3,55 @@
 Changelog
 =========
 
+What's new in IMAS-Python 2.3.0
+-------------------------------
+
+Features
+''''''''
+
+- :merge:`131`: introduce alias and units metadata in the :ref:`Identifiers` API
+- :merge:`104`: add a :py:func:`imas.db_entry.DBEntry.list_filled_paths` function (requires imas_core >= 5.7 for HDF5 backend)
+
+Improvements
+''''''''''''
+
+- :issue:`116`: migrate `magnetics` obsolescent fields (`method -> ip`, `bpol_probe -> b_field_pol_probe`) with a value during a 3to4 conversion 
+- :merge:`112`: include metadata variables when writing an IDS to a netCDF files with the function `to_xarray`, allowing to read back the IDS with a `get` (see :ref:`Store Xarray Datasets in IMAS-compatible netCDF file`)
+  - improve documentation w.r.t netcdf URI and UDA backend usage limitations and associated workarounds
+
+Bug fixes
+'''''''''
+
+- :issue:`118`: fix deprecation warning with copy keyword for __array__ implementation (Numpy > 2)
+- :issue:`117`: fix 3to4 conversion of name/identifier when identifier is empty
+- :merge:`105`: fix training data assets that failed loading
+
+  
+
+What's new in IMAS-Python 2.2.0
+-------------------------------
+
+Features
+''''''''
+- :issue:`44`: add `--convert-to-plasma-ids` option to `imas convert`  
+
+Improvements
+''''''''''''
+
+- :merge:`100`: remove legacy tool `extract_test_data` 
+- :merge:`98`: support MDSplus models configuration change introduced in imas_core >= 5.6
+- :issue:`97`: better documentation, exception message and control of DD compatibility when using UDA backend
+- :merge:`95`: defer loading the default DD definitions
+- :issue:`91`: remove hidden `has_imas` attribute (may break compatibility of applications that used it!)
+
+Bug fixes
+'''''''''
+
+- :merge:`100`: fix incorrect type hints
+- :issue:`89`: properly unpack 0D data when reading an IDS from a netCDF file
+
+
+
 What's new in IMAS-Python 2.1.0
 -------------------------------
 

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/conf.py

@@ -34,6 +34,9 @@ copyright = f"2020-{datetime.datetime.now().year}, ITER Organization"
 author = "ITER Organization"
 src_host = "https://github.com/iterorganization/"
 
+# Warn about missing references
+nitpicky = True
+
 # Parse urls here for convenience, to be re-used
 # ITER docs
 iter_projects = "https://github.com/iterorganization/"

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/identifiers.rst

@@ -14,13 +14,16 @@ enumerated list of options for defining, for example:
 - These may have alternative naming conventions supported through aliases 
   (e.g., "235U" and "U_235" for Uranium 235).
 
-Identifiers are a list of possible valid labels. Each label has up to four
-representations:
+Identifiers are a list of possible valid options. Each option has three representations
+that are stored in an IDS:
 
 1. An index (integer)
 2. A name (short string)
 3. A description (long string)
-4. List of aliases (list of short strings)
+
+.. seealso::
+    `Data Dictionary documentation for identifiers
+    <https://imas-data-dictionary.readthedocs.io/en/latest/identifiers.html>`__
 
 
 Identifiers in IMAS-Python
@@ -32,6 +35,20 @@ constructed on-demand from the loaded Data Dictionary definitions.
 All identifier enums can be accessed through ``imas.identifiers``. A list of
 the available identifiers is stored as ``imas.identifiers.identifiers``.
 
+Each identifier option provides the following attributes:
+
+- ``name``: the name of the option.
+- ``index``: the integer index value of the option.
+- ``description``: a longer string describing the option.
+- ``aliases``: a list of aliases that can be used instead of the name.
+- ``units``: optional information about the units of the quantities that are affected by
+  the identifier option. Take, for example, the `poloidal plan coordinate identifier
+  <https://imas-data-dictionary.readthedocs.io/en/stable/generated/identifier/poloidal_plane_coordinates_identifier.html>`__
+  which affects the units of ``grid/dim1`` and ``grid/dim2``.
+
+.. versionadded:: 2.1.0 ``aliases`` for identifiers.
+.. versionadded:: 2.3.0 ``units`` metadata.
+
 .. code-block:: python
     :caption: Accessing identifiers
 
@@ -47,6 +64,9 @@ the available identifiers is stored as ``imas.identifiers.identifiers``.
     print(csid.total.index)
     print(csid.total.description)
 
+    # Search identifier options by their index value
+    print(csid(1))
+
     # Access identifiers with aliases (when available)
     mid = imas.identifiers.materials_identifier
     print(mid["235U"].name)        # Access by canonical name
@@ -57,12 +77,12 @@ the available identifiers is stored as ``imas.identifiers.identifiers``.
     assert mid["235U"].name is mid.U_235.name
 
     # Item access is also possible
-    print(identifiers["edge_source_identifier"])
+    print(imas.identifiers["edge_source_identifier"])
 
     # You can use imas.util.inspect to list all options
-    imas.util.inspect(identifiers.ggd_identifier)
+    imas.util.inspect(imas.identifiers.ggd_identifier)
     # And also to get more details of a specific option
-    imas.util.inspect(identifiers.ggd_identifier.SN)
+    imas.util.inspect(imas.identifiers.ggd_identifier.SN)
 
     # When an IDS node is an identifier, you can use
     # metadata.identifier_enum to get the identifier
@@ -186,6 +206,7 @@ material_identifier["235U"].
     mat.names[0] = mid.U_235.name  # enum value via alias
     mat.names[0] = mid["U_235"].name  # enum value via alias
 
+
 Compare identifiers
 -------------------
 

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/intro.rst

@@ -86,17 +86,6 @@ get an error message if this is not possible:
 Load and store an IDS to disk with IMAS-Core
 ''''''''''''''''''''''''''''''''''''''''''''
 
-.. note::
-
-    - This functionality requires the IMAS-Core, until this library is openly available
-      on GitHub you may need to fetch it from `git.iter.org <https://git.iter.org/>`_
-      (requires to have an ITER account). Using IMAS-Core also enable slicing methods
-      :py:meth:`~imas.db_entry.DBEntry.get_slice`, 
-      :py:meth:`~imas.db_entry.DBEntry.put_slice` and
-      :py:meth:`~imas.db_entry.DBEntry.get_sample` (with IMAS-Core>=5.4).
-    - If you can't have access to it, you can save IDS to disk with the built-in
-      netCDF backend :ref:`Load and store an IDS to disk with netCDF`
-
 To store an IDS to disk, we need to indicate the following URI to the
 IMAS-Core: ``imas:<backend>?path=<path_to_folder>`` or using the legacy query keys
 ``imas:<backend>?user=<user>;database=<database>;version=<version>;pulse=<pulse>;run=<run>``
@@ -115,11 +104,9 @@ In IMAS-Python you do this as follows:
     >>> # now store the core_profiles IDS we just populated
     >>> dbentry.put(core_profiles)
 
-.. image:: imas_structure.png
-
 To load an IDS from disk, you need to specify the same information as
 when storing the IDS (see above). Once the data entry is opened, you
-can use ``<IDS>.get()`` to load IDS data from disk: 
+can use ``dbentry.get()`` to load IDS data from disk: 
 
 .. code-block:: python
 
@@ -146,7 +133,7 @@ In IMAS-Python you do this as follows:
 
 To load an IDS from disk, you need to specify the same file information as
 when storing the IDS. Once the data entry is opened, you
-can use ``<IDS>.get()`` to load IDS data from disk: 
+can use ``dbentry.get()`` to load IDS data from disk: 
 
 .. code-block:: python
 
@@ -154,3 +141,26 @@ can use ``<IDS>.get()`` to load IDS data from disk:
     >>> dbentry2 = imas.DBEntry("mypulsefile.nc","r")
     >>> core_profiles2 = dbentry2.get("core_profiles")
     >>> print(core_profiles2.ids_properties.comment.value)
+
+
+Data Entry API overview
+'''''''''''''''''''''''
+
+See the documentation of :py:class:`imas.DBEntry <imas.db_entry.DBEntry>` for more
+details on reading and writing IDSs to disk. Useful functions include:
+
+- :py:meth:`~imas.db_entry.DBEntry.put` and :py:meth:`~imas.db_entry.DBEntry.put_slice`
+  to write a full IDS or write append a time slice to existing data.
+- :py:meth:`~imas.db_entry.DBEntry.get`, :py:meth:`~imas.db_entry.DBEntry.get_slice` and
+  :py:meth:`~imas.db_entry.DBEntry.get_sample` to read all time slices, a single time
+  slice, or a sample of time slices from disk. ``get_slice()`` and ``get_sample()`` can
+  also interpolate data to a requested point in time.
+
+  All three ``get()`` methods have a ``lazy`` mode, which will only load data from disk
+  when you need it. This can greatly speed up data access in some scenarios. See
+  :ref:`Lazy loading` for more details.
+- :py:meth:`~imas.db_entry.DBEntry.list_all_occurrences` to query whether there are any
+  occurrences of a certain IDS stored on disk.
+- :py:meth:`~imas.db_entry.DBEntry.list_filled_paths` to query which Data Dictionary
+  paths have data filled inside a specific IDS.
+

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/multi-dd.rst

@@ -276,27 +276,90 @@ You need to explicitly convert the data, which you can do as follows:
       entry.put(imas.convert_ids(equilibrium, entry.dd_version))
 
 
+.. _`UDA backend and DD versions`:
 
-.. _`DD background`:
+UDA backend caching and Data Dictionary versions
+------------------------------------------------
 
-Background information
-----------------------
+If you try to load data from a different Data Dictionary version with the UDA backend,
+you may see the following error:
+
+.. code-block:: text
+
+  The Data Dictionary version of the data (3.38.1) is different from the Data
+  Dictionary version of the DBEntry (3.42.0). This is not supported when using the
+  UDA backend.
+
+There are two possible workarounds. The first one requires passing an additional option
+in the IMAS UDA URI: please see the `imas-core documentation
+<https://imas-core.readthedocs.io/en/stable/user_guide/backends_guide.html#query-keys-specific-for-the-uda-backend>`__
+for more details on URI options.
+
+1. Use UDA fetch to bypass the cache problem. You can do this by appending ``&fetch=1``
+   to the URI when you create the :py:class:`~imas.db_entry.DBEntry`.
+
+   Note that this will download the entire IDS files from the remote server, this may
+   not be desired if you only want to read a single time slice.
+2. Explicitly provide the data dictionary version when you create the
+   :py:class:`~imas.db_entry.DBEntry`, setting it to match the Data Dictionary version
+   of the data you want to load. To obtain the version of the data on the remote server
+   from the field `ids_properties.put_version.data_dictionary` via a _lazy_ ``get()``
+   with ``autoconvert=False`` option and using the ``&cache_mode=none`` query in the URI.
+   
+   Note that you may need to call ``imas.convert_ids`` to convert the IDS to your
+   desired Data Dictionary version.
+
+The two possible workarounds are shown in the examples below:
+
+.. md-tab-set::
+
+    .. md-tab-item:: Original code
+
+      .. code-block:: python
 
-Since IMAS-Python needs to have access to multiple DD versions it was chosen to
-bundle these with the code at build-time, in setup.py. If a git clone of the
-Data Dictionary succeeds, the setup tools automatically download saxon and
-generate ``IDSDef.xml`` for each of the tagged versions in the DD git
-repository. These are then gathered into ``IDSDef.zip``, which is
-distributed inside the IMAS-Python package.
+        import imas
 
-To update the set of data dictionaries new versions can be added to the zipfile.
-A reinstall of the package will ensure that all available versions are included
-in IMAS-Python. Additionally an explicit path to an XML file can be specified, which
-is useful for development.
+        URI = (
+            "imas://uda.iter.org:56565/uda?backend=hdf5"
+            "&path=/work/imas/shared/imasdb/ITER/3/121013/50"
+        )
+        with imas.DBEntry(URI, "r") as entry:
+            cp = entry.get("core_profiles")
 
-Automated tests have been provided that check the loading of all of the DD
-versions tagged in the data-dictionary git repository.
+    .. md-tab-item:: 1. Use UDA fetch
 
+      .. code-block:: python
+
+        import imas
+
+        URI = (
+            "imas://uda.iter.org:56565/uda?backend=hdf5"
+            "&path=/work/imas/shared/imasdb/ITER/3/121013/50&fetch=1"
+        )
+        with imas.DBEntry(URI, "r") as entry:
+            cp = entry.get("core_profiles")
+
+    .. md-tab-item:: 2. Explicitly provide the DD version
+
+      .. code-block:: python
+
+        import imas
+
+        URI = (
+            "imas://uda.iter.org:56565/uda?backend=hdf5"
+            "&path=/work/imas/shared/imasdb/ITER/3/121013/50"
+        )
+        with imas.DBEntry(URI, "r", dd_version="3.38.1") as entry:
+            cp = entry.get("core_profiles")
+
+        # Optional: convert the IDS to your desired DD version
+        cp = imas.convert_ids(cp, "3.42.0")
+
+
+.. _`DD background`:
+
+Background information
+----------------------
 
 Data Dictionary definitions
 '''''''''''''''''''''''''''

{imas_python-2.1.0.post1 → imas_python-2.3.0}/docs/source/netcdf.rst

@@ -183,3 +183,41 @@ specific paths inside the IDS. The latter variant can also be combined with
     #   profiles_1d.grid.rho_tor
     #   profiles_1d.grid.rho_tor_norm
     #   profiles_1d.grid.psi
+
+
+.. _`Store Xarray Datasets in IMAS-compatible netCDF file`:
+    
+Store Xarray Datasets in IMAS-compatible netCDF file
+''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+.. versionadded:: 2.3.0 :py:meth:`~imas.util.to_xarray` now includes the required
+    metadata to load the IDS from a netCDF file.
+
+The following snippet shows how to store an IMAS Xarray dataset in an IMAS-compatible
+netCDF file. The group name in the netCDF file must correspond to ``<IDS
+Name>/<occurrence>`` (``core_profiles/0`` in the snippet).
+
+.. code-block:: python
+    :caption: Store IMAS Xarray dataset in an IMAS-compatible netCDF file
+
+    import imas.training
+    import netCDF4
+
+    with imas.training.get_training_db_entry() as training_entry:
+        core_profiles = training_entry.get("core_profiles")
+        xrds = imas.util.to_xarray(core_profiles)
+    
+    # Store the xarray dataset in an IMAS-compatible netCDF dataset
+    filename = "data.nc"
+    xrds.to_netcdf(
+        filename,
+        group="core_profiles/0",  # Update to the correct IDS name and occurrence
+        # auto_complex=True,      # Uncomment if the dataset contains complex data
+    )
+    # Set global DD version metadata
+    with netCDF4.Dataset(filename, "a") as ds: 
+        ds.data_dictionary_version = imas.util.get_data_dictionary_version(ids)
+
+    # Test that we can get the IDS from the netCDF file
+    with imas.DBEntry(filename, "r") as entry:
+        ids2 = entry.get("core_profiles")

imas_python-2.3.0/imas/__init__.py

@@ -0,0 +1,58 @@
+# This file is part of IMAS-Python.
+# You should have received the IMAS-Python LICENSE file with this project.
+
+from packaging.version import Version as _V
+
+# Import logging _first_
+# isort: off
+from . import setup_logging  # noqa: F401
+
+# isort: on
+
+# Ensure that `imas.util` is loaded when importing imas
+from . import util  # noqa: F401
+
+# Public API:
+from ._version import version as __version__
+from ._version import version_tuple
+from .convert_core_edge_plasma import (
+    convert_to_plasma_profiles,
+    convert_to_plasma_sources,
+    convert_to_plasma_transport,
+)
+from .db_entry import DBEntry
+from .ids_convert import convert_ids
+from .ids_data_type import IDSDataType
+from .ids_factory import IDSFactory
+from .ids_identifiers import identifiers
+from .ids_metadata import IDSMetadata, IDSType
+from .ids_primitive import IDSPrimitive
+from .ids_struct_array import IDSStructArray
+from .ids_structure import IDSStructure
+from .ids_toplevel import IDSToplevel
+
+PUBLISHED_DOCUMENTATION_ROOT = "https://imas-python.readthedocs.io/en/latest/"
+"""URL to the published documentation."""
+OLDEST_SUPPORTED_VERSION = _V("3.22.0")
+"""Oldest Data Dictionary version that is supported by IMAS-Python."""
+
+__all__ = [
+    "__version__",
+    "version_tuple",
+    "DBEntry",
+    "IDSDataType",
+    "IDSFactory",
+    "IDSMetadata",
+    "IDSPrimitive",
+    "IDSStructure",
+    "IDSStructArray",
+    "IDSToplevel",
+    "IDSType",
+    "convert_ids",
+    "convert_to_plasma_profiles",
+    "convert_to_plasma_sources",
+    "convert_to_plasma_transport",
+    "identifiers",
+    "PUBLISHED_DOCUMENTATION_ROOT",
+    "OLDEST_SUPPORTED_VERSION",
+]