imas-python 1.2.1.dev13__tar.gz → 2.0.0.post1__tar.gz

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/.github/workflows/linting.yml

@@ -1,11 +1,14 @@
 name: linting-and-code-formatting
 
-on: push
+on: 
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened]
 
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout IMAS-Python sources
@@ -14,7 +17,9 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          # until saxonche is available in 3.13
+          # https://saxonica.plan.io/issues/6561
+          python-version: "<3.13"
 
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/.github/workflows/publish.yml

@@ -1,11 +1,14 @@
 name: build-wheel-and-publish-test-pypi
 
-on: push
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened]
 
 jobs:
   build:
     name: Build distribution
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
       with:
@@ -13,7 +16,9 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.x"
+        # until saxonche is available in 3.13
+        # https://saxonica.plan.io/issues/6561
+        python-version: "<3.13"
     - name: Install pypa/build
       run: >-
         python3 -m pip install pip setuptools wheel build
@@ -27,9 +32,10 @@ jobs:
         
   publish-to-pypi:
     name: Publish IMAS-Python distribution to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
     needs:
     - build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     environment:
       name: pypi
       url: https://pypi.org/p/imas-python
@@ -46,9 +52,10 @@ jobs:
       
   publish-to-testpypi:
     name: Publish IMAS-Python distribution to TestPyPI
+    if: github.ref=='refs/heads/develop'  # only publish to TestPyPI on develop pushes
     needs:
     - build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     environment:
       name: testpypi
       url: https://test.pypi.org/p/imas-python
@@ -64,4 +71,4 @@ jobs:
       uses: pypa/gh-action-pypi-publish@unstable/v1
       with:
         repository-url: https://test.pypi.org/legacy/
-        verbose: true
+        verbose: true

imas_python-2.0.0.post1/.github/workflows/test_with_pytest.yml

@@ -0,0 +1,51 @@
+name: Test using pytest
+
+on: 
+    push:
+    pull_request:
+      types: [opened, synchronize, reopened]
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]  # Test on multiple Python versions
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+
+        uses: actions/setup-python@v4
+        with:
+          # until saxonche is available in 3.13
+          # https://saxonica.plan.io/issues/6561
+          python-version: ${{ matrix.python-version }}
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: Install dependencies
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          pip install --upgrade pip setuptools wheel
+          pip install .[test]
+
+      - name: Run tests
+        run: |
+          source venv/bin/activate
+          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
+        with:
+          name: coverage-report-${{ matrix.python-version }}
+          path: htmlcov
+
+      - name: Upload test report ${{ matrix.python-version }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-report-${{ matrix.python-version }}
+          path: junit.xml

imas_python-2.0.0.post1/.github/workflows/verify_sphinx_doc.yml

@@ -0,0 +1,53 @@
+name: verify-sphinx-doc-generation
+
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout IMAS-Python sources
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          with:
+          # until saxonche is available in 3.13
+          # https://saxonica.plan.io/issues/6561
+          python-version: "<3.13"
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+
+      - name: Set up Python virtual environment
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+
+      - name: Install build dependencies
+        run: |
+          pip install --upgrade pip setuptools wheel build
+
+      - name: Build package
+        run: |
+          rm -rf dist
+          python -m build .
+
+      - name: Install package and dependencies
+        run: |
+          pip install "$(readlink -f dist/*.whl)[docs,netcdf]"
+
+      - name: Debug dependencies
+        run: |
+          pip freeze
+
+      - name: Build Sphinx documentation
+        run: |
+          export SPHINXOPTS='-W -n --keep-going'
+          make -C docs clean html

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/CONTRIBUTING.md

@@ -9,28 +9,28 @@ Please first make sure you read and follow the
 ## You think you found a bug in the code, or have a question in its use
 1. use the [issue search](https://github.com/iterorganization/IMAS-Python/issues)
 to check if someone already created a similar issue;
-3. if not, make a **new issue** to describe your problem or question. 
+2. if not, make a **new issue** to describe your problem or question. 
 In the case of a bug suspiscion, please try to give all the relevant 
 information to allow reproducing the error or identifying 
 its root cause (version of the IMAS-Python, OS and relevant 
 dependencies, snippet of code);
-4. apply relevant labels to the issue.
+3. apply relevant labels to the issue.
 
 ## You want to make or ask some change to the code
 1. use the [issue search](https://github.com/iterorganization/IMAS-Python/issues)
 to check if someone already proposed a similar idea/change;
-3. if not, create a **new issue** to describe what change you would like to see 
+2. if not, create a **new issue** to describe what change you would like to see 
 implemented and specify it if you intend to work on it yourself or if some help 
 will be needed;
-4. wait until some kind of consensus is reached about your idea being relevant, 
+3. wait until some kind of consensus is reached about your idea being relevant, 
 at which time the issue will be assigned (to you or someone else who can work on 
 this topic);
-5. if you do the development yourself, fork the repository to your own Github 
+4. if you do the development yourself, fork the repository to your own Github 
 profile and create your own feature branch off of the latest develop commit. 
 Make sure to regularly sync your branch with the latest commits from `develop` 
 (find instructions 
 [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork));
-6. when your development is ready, create a pull request (find instructions 
+5. when your development is ready, create a pull request (find instructions 
 [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)).
 
 

{imas_python-1.2.1.dev13/imas_python.egg-info → imas_python-2.0.0.post1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: imas-python
-Version: 1.2.1.dev13
+Version: 2.0.0.post1
 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
@@ -215,7 +215,7 @@ Requires-Dist: xxhash>=2
 Requires-Dist: saxonche
 Requires-Dist: gitpython
 Provides-Extra: all
-Requires-Dist: imas[docs,h5py,imas-core,netcdf,test]; extra == "all"
+Requires-Dist: imas-python[docs,test]; extra == "all"
 Provides-Extra: docs
 Requires-Dist: sphinx<7.0.0,>=6.0.0; extra == "docs"
 Requires-Dist: sphinx-autosummary-accessors>=0.1.2; extra == "docs"
@@ -225,6 +225,8 @@ Provides-Extra: netcdf
 Requires-Dist: netCDF4>=1.4.1; extra == "netcdf"
 Provides-Extra: h5py
 Requires-Dist: h5py; extra == "h5py"
+Provides-Extra: xarray
+Requires-Dist: xarray; extra == "xarray"
 Provides-Extra: test
 Requires-Dist: pytest>=5.4.1; extra == "test"
 Requires-Dist: pytest-cov>=0.6; extra == "test"
@@ -234,13 +236,13 @@ Requires-Dist: matplotlib; extra == "test"
 Requires-Dist: asv==0.6.1; extra == "test"
 Requires-Dist: virtualenv; extra == "test"
 Requires-Dist: pint; extra == "test"
-Requires-Dist: xarray; extra == "test"
+Requires-Dist: imas-python[h5py,netcdf,xarray]; extra == "test"
 
 # IMAS-Python
 
-IMAS-Python is a pure-python library to handle arbitrarily nested data structures.
-It is designed for, but not necessarily bound to, interacting with Interface 
-Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS) 
+IMAS-Python (formerly known as IMASPy its for versions < 2) is a pure-python library to handle 
+arbitrarily nested data structures. It is designed for, but not necessarily bound to, interacting 
+with Interface Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS) 
 Data Model.
 
 
@@ -266,11 +268,17 @@ factory = imas.IDSFactory()
 equilibrium = factory.equilibrium()
 print(equilibrium)
 
-equilibrium.ids_properties.homogeneous_time = imas.ids_defs.IDS_TIME_MODE_HETEROGENEOUS
+equilibrium.ids_properties.homogeneous_time = imas.ids_defs.IDS_TIME_MODE_HOMOGENEOUS
 equilibrium.ids_properties.comment = "testing"
+equilibrium.time = [0.01]
 
-with imas.DBEntry("imas:hdf5?path=./testdb","w") as dbentry:
+with imas.DBEntry("imas:hdf5?path=./testdb", "w") as dbentry:
     dbentry.put(equilibrium)
+	
+# or without imas_core dependency
+with imas.DBEntry("./test.nc", "w") as dbentry:
+    dbentry.put(equilibrium)
+
 ```
 
 A quick 5 minutes introduction is available in the documentation generated from `/docs/sources/intro.rst`.

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/README.md

@@ -1,8 +1,8 @@
 # IMAS-Python
 
-IMAS-Python is a pure-python library to handle arbitrarily nested data structures.
-It is designed for, but not necessarily bound to, interacting with Interface 
-Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS) 
+IMAS-Python (formerly known as IMASPy its for versions < 2) is a pure-python library to handle 
+arbitrarily nested data structures. It is designed for, but not necessarily bound to, interacting 
+with Interface Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS) 
 Data Model.
 
 
@@ -28,11 +28,17 @@ factory = imas.IDSFactory()
 equilibrium = factory.equilibrium()
 print(equilibrium)
 
-equilibrium.ids_properties.homogeneous_time = imas.ids_defs.IDS_TIME_MODE_HETEROGENEOUS
+equilibrium.ids_properties.homogeneous_time = imas.ids_defs.IDS_TIME_MODE_HOMOGENEOUS
 equilibrium.ids_properties.comment = "testing"
+equilibrium.time = [0.01]
 
-with imas.DBEntry("imas:hdf5?path=./testdb","w") as dbentry:
+with imas.DBEntry("imas:hdf5?path=./testdb", "w") as dbentry:
     dbentry.put(equilibrium)
+	
+# or without imas_core dependency
+with imas.DBEntry("./test.nc", "w") as dbentry:
+    dbentry.put(equilibrium)
+
 ```
 
 A quick 5 minutes introduction is available in the documentation generated from `/docs/sources/intro.rst`.

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/ci/run_pytest.sh

@@ -13,7 +13,7 @@ source /etc/profile.d/modules.sh
 module purge
 # Modules are supplied as arguments in the CI job:
 if [ -z "$@" ]; then
-    module load IMAS-AL-Core
+    module load IMAS-AL-Core Java MDSplus 
 else
     module load $@
 fi

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/docs/Makefile

@@ -31,7 +31,7 @@ clean: Makefile
 # Seems to overwrite autosummary documentation though! So not using this rn
 MODULE_EXCLUDE="../imas/examples/**" "../imas/**"
 apidocs: Makefile
-	sphinx-apidoc --implicit-namespaces -o "$(GENERATEDDIR)" "$(PROJECT_ROOT)/imaspy/" $(MODULE_EXCLUDE)
+	sphinx-apidoc --implicit-namespaces -o "$(GENERATEDDIR)" "$(PROJECT_ROOT)/imas/" $(MODULE_EXCLUDE)
 
 # Sphinx will run this automatically
 autogen: Makefile

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/docs/source/changelog.rst

@@ -3,13 +3,33 @@
 Changelog
 =========
 
-What's new in IMAS-Python 1.2.0
---------------------------
+What's new in IMAS-Python 2.0.0
+-------------------------------
+
+Breaking change
+'''''''''''''''
+
+The package name was changed from ``imaspy`` to ``imas`` while porting the code to `GitHub <https://github.com/iterorganization/IMAS-Python>`__. This shall only affect the import statements in your code. 
+
+New features and improvements
+'''''''''''''''''''''''''''''
+
+- Add :py:func:`imas.util.to_xarray` to convert a full IDS or only specific paths herein to a Xarray ``Dataset``. See :ref:`Convert IMAS-Python IDSs directly to Xarray Datasets` for more details.
+- Implements automatic DD version conversion on :py:meth:`imas.db_entry.DBEntry.get` (conversion during :py:meth:`imas.db_entry.DBEntry.put` is not supported as this is rarely needed and easily worked around).
+- Enable lazy loading when reading data from a netCDF file.
+- Minor performance improvement loading data from a netCDF file.
+- Replace versioneer by setuptools-scm to determine the version of the code.
+- Use `saxonche <https://pypi.org/project/saxonche/>`__ instead of the JAR for XSL transforms (when building versions of the DD).
+- Updating the README, CONTRIBUTING guidelines and documentation after making the code open access.
+
+
+What's new in IMASPy 1.2.0
+-------------------------------
 
 New features and improvements
 '''''''''''''''''''''''''''''
 
-- Add :py:func:`imaspy.DBEntry.get_sample` (requires imas_core >= 5.4.0)
+- Add :py:func:`imaspy.DBEntry.get_sample <imas.db_entry.DBEntry.get_sample>` (requires imas_core >= 5.4.0)
 - Improved validation of netCDF files
 - Improve compatibility with the UDA backend in imas_core
 - Extend the support of netCDF to >= 1.4.1 (without complex numbers)
@@ -23,7 +43,7 @@ Bug fixes
 
 
 
-What's new in IMAS-Python 1.1.1
+What's new in IMASPy 1.1.1
 -------------------------------
 
 This is a small release that mainly fixes issues related to the recent Data
@@ -39,7 +59,7 @@ Bug fixes
     Dictionary 4.0.0 and 3.42.0. In other cases, the Data Dictionary version is
     now explicitly indicated.
 
-- :issue:`IMAS-5560`: Fix a bug where IMAS-Python would not correctly recognize that
+- :issue:`IMAS-5560`: Fix a bug where IMASPy would not correctly recognize that
   the UDA backend is used.
 - :issue:`IMAS-5541`: Fix a bug when converting a closed contour to Data
   Dictionary version 4.0.0.
@@ -49,7 +69,7 @@ Bug fixes
   recent Data Dictionary version than the on-disk data was stored with.
 
 
-What's new in IMAS-Python 1.1
+What's new in IMASPy 1.1
 -----------------------------
 
 New features
@@ -57,7 +77,7 @@ New features
 
 - :ref:`1.1/improved performance`.
 - :ref:`1.1/improved conversion`.
-- IMAS-Python 1.1 adds support for Identifiers defined by the Data Dictionary. This
+- IMASPy 1.1 adds support for Identifiers defined by the Data Dictionary. This
   functionality is described in detail in :ref:`Identifiers`.
 - Support for the new
   :py:const:`~imas.ids_defs.FLEXBUFFERS_SERIALIZER_PROTOCOL` that is
@@ -72,7 +92,7 @@ New features
   netCDF file, which can be used for sharing and/or archiving data.
   
   This feature is in `preview` status, meaning that it may change in upcoming
-  minor releases of IMAS-Python.
+  minor releases of IMASPy.
 
 - Additional utility functions in :py:mod:`imas.util`:
 
@@ -91,18 +111,18 @@ New features
   - :py:func:`imas.util.get_data_dictionary_version` returns the Data
     Dictionary version for which an IDS was created.
 
-- Add support for IMAS Access Layer Core 5.2 and later. IMAS-Python can now be used
+- Add support for IMAS Access Layer Core 5.2 and later. IMASPy can now be used
   with just the Access Layer Core package available, the full AL-Python HLI is
   no longer required.
 
   Since the Access Layer Core is now installable with ``pip`` as well (requires
   access to the git repository on
-  `<https://github.com/iterorganization/imas-core>`__), you can install
-  ``imas`` and ``imas_core`` in one go with:
+  `<https://git.iter.org/projects/IMAS/repos/al-core/>`__), you can install
+  ``imaspy`` and ``imas_core`` in one go with:
 
   .. code-block:: bash
 
-    pip install 'imas[imas-core] @ git+ssh://git@github.com/iterorganization/imas-core.git'
+    pip install 'imaspy[imas-core] @ git+ssh://git@git.iter.org/imas/imaspy.git'
 
 - A diff tool for IDSs: :py:func:`imas.util.idsdiff`.
 - Implement ``==`` equality checking for IDS Structures and Arrays of Structures
@@ -111,12 +131,12 @@ New features
   backend.
 
   During a :py:meth:`~imas.db_entry.DBEntry.get` or
-  :py:meth:`~imas.db_entry.DBEntry.get_slice`, IMAS-Python first reads the version
+  :py:meth:`~imas.db_entry.DBEntry.get_slice`, IMASPy first reads the version
   of the Data Dictionary that was used to store the IDS. When this version is
-  not known to IMAS-Python, an error is raised. This error can now be ignored by
+  not known to IMASPy, an error is raised. This error can now be ignored by
   setting the parameter
   :py:param:`~imas.db_entry.DBEntry.get.ignore_unknown_dd_version` to
-  ``True``, and IMAS-Python will do its best to load the data anyway.
+  ``True``, and IMASPy will do its best to load the data anyway.
 
 - A new command line tool exists for analyzing which Data Dictionary fields are
   used in provided Data Entries. This tool is explained in detail in
@@ -130,7 +150,7 @@ Breaking changes
 
 .. note::
 
-  We attempt to keep the public API of IMAS-Python stable with minor releases. The
+  We attempt to keep the public API of IMASPy stable with minor releases. The
   following breaking change is the result of an upgrade of the IMAS Access Layer.
 
 - Starting with Access Layer 5.2 or newer, the Access Layer will raise
@@ -141,8 +161,8 @@ Breaking changes
   You may need to update the :py:class:`Exception` classes in ``try/except``
   blocks to the new Exception classes raised by ``imas_core``.
 
-  When using an older version of the Access Layer, the behaviour of IMAS-Python is no
-  different than in IMAS-Python 1.0.
+  When using an older version of the Access Layer, the behaviour of IMASPy is no
+  different than in IMASPy 1.0.
 
 
 Bug fixes
@@ -156,10 +176,10 @@ Bug fixes
 - Fixed a bug with :py:func:`~imas.ids_toplevel.IDSToplevel.serialize` when
   the IDS is in a non-default Data Dictionary version.
 - Fixed a bug when assigning ``nan`` to a FLT_0D, which would lead to a
-  confusing and incorrect log message in IMAS-Python 1.0.
-- Fixed incorrect oldest supported DD version. Previously IMAS-Python indicated that
+  confusing and incorrect log message in IMASPy 1.0.
+- Fixed incorrect oldest supported DD version. Previously IMASPy indicated that
   DD ``3.21.1`` was supported, however ``3.22.0`` is the oldest Data Dictionary
-  tested (and provided) with IMAS-Python. :py:attr:`imas.OLDEST_SUPPORTED_VERSION`
+  tested (and provided) with IMASPy. :py:attr:`imas.OLDEST_SUPPORTED_VERSION`
   has been updated to reflect this.
 - Fixed a bug when using numpy functions, such as
   :external:py:func:`numpy.isclose` on scalar numbers. Previously an error was
@@ -178,11 +198,11 @@ Improved performance
 ''''''''''''''''''''
 
 - Improved performance of :py:meth:`~imas.ids_toplevel.IDSToplevel.validate`.
-- Improved creation of IMAS-Python IDS objects. This made filling IDSs and loading
+- Improved creation of IMASPy IDS objects. This made filling IDSs and loading
   them with :py:meth:`~imas.db_entry.DBEntry.get` /
   :py:meth:`~imas.db_entry.DBEntry.get_slice` 10-20% faster.
 - Improved the performance of lazy loading. This is most noticeable with the
-  ``HDF5`` backend, which is now up to 40x faster than with IMAS-Python 1.0.
+  ``HDF5`` backend, which is now up to 40x faster than with IMASPy 1.0.
 - Improved the performance of :py:meth:`~imas.db_entry.DBEntry.get` /
   :py:meth:`~imas.db_entry.DBEntry.get_slice` /
   :py:meth:`~imas.db_entry.DBEntry.put` /
@@ -200,7 +220,7 @@ Converting IDSs between Data Dictionary versions has several improvements for
 recent DD versions. Further details on IDS conversion can be found in
 :ref:`Conversion of IDSs between DD versions`.
 
-- The IMAS-Python Command Line Interface for converting Data Entries between different
+- The IMASPy Command Line Interface for converting Data Entries between different
   versions of the Data Dictionary has been improved. See :ref:`Command line tool
   reference` or execute ``imas convert --help`` in a shell for further
   details.
@@ -210,7 +230,7 @@ recent DD versions. Further details on IDS conversion can be found in
   For example, in the ``pulse_schedule`` IDS, the node
   ``ec/beam/power_launched/reference`` in Data Dictionary ``3.40.0`` was renamed
   from ``ec/launcher/power/reference/data`` in Data Dictionary ``3.39.0``. This
-  use case is now supported by IMAS-Python.
+  use case is now supported by IMASPy.
 
 - Automatically convert data between 0D and 1D when possible (`IMAS-5170
   <https://jira.iter.org/browse/IMAS-5170>`__).

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/docs/source/courses/advanced/imas_snippets/tensorized_ids_to_xarray.py

@@ -1,6 +1,7 @@
 import os
 
 import matplotlib
+
 # To avoid possible display issues when Matplotlib uses a non-GUI backend
 if "DISPLAY" not in os.environ:
     matplotlib.use("agg")
@@ -17,6 +18,39 @@ import xarray
 entry = imas.training.get_training_db_entry()
 cp = entry.get("core_profiles")
 
+#######################################################################################
+# Steps 2, 3 and 4, using imas.util.to_xarray
+# Create an xarray Dataset containing t_i_average and its coordinates
+xrds = imas.util.to_xarray(cp, "profiles_1d/t_i_average")
+# Note that profiles_1d.grid.rho_tor_norm is a 2D coordinate: its values may be
+# different at different times.
+#
+# Since the values at different time slices differ only minutely in this example, we'll
+# rename the `profiles_1d.grid.rho_tor_norm:i` dimension to `rho_tor_norm` and set the
+# values to the values of rho_tor_norm of the first time slice:
+xrds = xrds.rename({"profiles_1d.grid.rho_tor_norm:i": "rho_tor_norm"}).assign_coords(
+    {"rho_tor_norm": xrds["profiles_1d.grid.rho_tor_norm"].isel(time=0).data}
+)
+
+# Extract temperatures as an xarray DataArray
+temperature = xrds["profiles_1d.t_i_average"]
+
+# 5a. Select subset of temperature where 0.4 <= rho_tor_norm < 0.6:
+print(temperature.sel(rho_tor_norm=slice(0.4, 0.6)))
+
+# 5b. Interpolate temperature on a new grid: [0, 0.1, 0.2, ..., 0.9, 1.0]
+print(temperature.interp(rho_tor_norm=numpy.linspace(0, 1, 11)))
+
+# 5c. Interpolate temperature on a new time base: [10, 20]
+print(temperature.interp(time=[10, 20]))
+
+# 5d. Plot
+temperature.plot(x="time", norm=matplotlib.colors.LogNorm())
+plt.show()
+
+#######################################################################################
+# We can also manually build an xarray DataArray, this is shown below:
+
 # 2. Store the temperature of the first time slice
 temperature = cp.profiles_1d[0].t_i_average
 

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/docs/source/courses/advanced/xarray.rst

@@ -3,9 +3,12 @@ Create ``xarray.DataArray`` from an IDS
 
 .. info::
 
-    In this lesson you will create a ``DataArray`` manually. In a future version of
-    IMAS-Python we plan to include functionality that will automatically do this for you.
-    That should further simplify working with data inside IDSs.
+    This lesson was written before :py:func:`imas.util.to_xarray` was
+    implemented. This lesson is retained for educational purposes, however we
+    recommend to use :py:func:`imas.util.to_xarray` instead of manually creating
+    xarray ``DataArray``\ s.
+
+    See also: :ref:`Convert IMAS-Python IDSs directly to Xarray Datasets`.
 
 Let's start with an introduction of Xarray. According to `their website
 <https://docs.xarray.dev/en/stable/getting-started-guide/why-xarray.html>`_ (where you
@@ -61,6 +64,10 @@ Exercise 1: create a ``DataArray`` for ``profiles_1d/temperature``
 
     .. md-tab-item:: Solution
 
+        This exercise was created before the implementation of
+        :py:func:`imas.util.to_xarray`. The original approach is available below
+        for educational purposes.
+
         .. literalinclude:: imas_snippets/ids_to_xarray.py
 
 
@@ -96,4 +103,9 @@ the ``profiles_1d`` array of structures. When the grid is not changing in the ID
 
     .. md-tab-item:: Solution
 
+        This exercise was created before the implementation of
+        :py:func:`imas.util.to_xarray`. Below code sample is updated to provide
+        two alternatives: the first is based on :py:func:`imas.util.to_xarray`,
+        the second is the original, manual approach.
+
         .. literalinclude:: imas_snippets/tensorized_ids_to_xarray.py

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/docs/source/index.rst

@@ -11,6 +11,11 @@ data structures. IMAS-Python is designed for, but not necessarily bound to,
 interacting with Interface Data Structures (IDSs) as defined by the
 Integrated Modelling & Analysis Suite (IMAS) Data Model.
 
+.. note::
+
+    IMAS-Python was formerly known as IMASPy, and was renamed with the release
+    of the major version 2. 
+
 It provides:
 
 - An easy-to-install and easy-to-get started package by

{imas_python-1.2.1.dev13 → imas_python-2.0.0.post1}/docs/source/installing.rst

@@ -56,7 +56,7 @@ This is how to run the IMAS-Python test suite:
     # inside the IMAS-Python git repository
     pytest imas --mini
 
-    # run with a specific backend
+    # run with a specific backend, requires IMAS-Core installed
     pytest imas --ascii --mini
 
 And to build the IMAS-Python documentation, execute: