imas-python 0.1.dev1643__tar.gz → 0.1.dev1647__tar.gz

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: imas-python
-Version: 0.1.dev1643
+Version: 0.1.dev1647
 Summary: Pythonic wrappers for the IMAS Access Layer
 Author: imas-python developers
 Author-email: Olivier Hoenen <olivier.hoenen@iter.org>

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/docs/source/changelog.rst

@@ -40,13 +40,13 @@ New features
 - imas-python 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
+  :py:const:`~imaspy.ids_defs.FLEXBUFFERS_SERIALIZER_PROTOCOL` that is
   implemented in Access Layer Core 5.3. This is a much faster and more efficient
   serialization format than the
-  :py:const:`~imas.ids_defs.ASCII_SERIALIZER_PROTOCOL`. The Flexbuffers
+  :py:const:`~imaspy.ids_defs.ASCII_SERIALIZER_PROTOCOL`. The Flexbuffers
   serializer protocol requires ``imas_core`` version 5.3 or newer. It is the
   default serializer format when it is available. This features is not available
-  when the variable :py:const:`~imas.ids_defs.FLEXBUFFERS_SERIALIZER_PROTOCOL`
+  when the variable :py:const:`~imaspy.ids_defs.FLEXBUFFERS_SERIALIZER_PROTOCOL`
   is set to ``None``.
 - Preview feature: :ref:`IMAS netCDF files`. Store IDSs in a self-describing
   netCDF file, which can be used for sharing and/or archiving data.
@@ -54,21 +54,21 @@ New features
   This feature is in `preview` status, meaning that it may change in upcoming
   minor releases of imas-python.
 
-- Additional utility functions in :py:mod:`imas.util`:
+- Additional utility functions in :py:mod:`imaspy.util`:
 
-  - :py:func:`imas.util.tree_iter` can be used to iterate over all nodes inside
+  - :py:func:`imaspy.util.tree_iter` can be used to iterate over all nodes inside
     an IDS.
-  - :py:func:`imas.util.get_parent` can be used to get the parent element of
+  - :py:func:`imaspy.util.get_parent` can be used to get the parent element of
     an IDS node.
-  - :py:func:`imas.util.get_time_mode` is a convenience function to get the
+  - :py:func:`imaspy.util.get_time_mode` is a convenience function to get the
     ``ids_properties/homogeneous_time`` value for any node in the IDS.
-  - :py:func:`imas.util.get_toplevel` returns the IDS Toplevel element for any
+  - :py:func:`imaspy.util.get_toplevel` returns the IDS Toplevel element for any
     node in the IDS.
-  - :py:func:`imas.util.is_lazy_loaded` will indicate whether an IDS is lazy
+  - :py:func:`imaspy.util.is_lazy_loaded` will indicate whether an IDS is lazy
     loaded.
-  - :py:func:`imas.util.get_full_path` returns the full path (including Array
+  - :py:func:`imaspy.util.get_full_path` returns the full path (including Array
     of Structure indices) of a node.
-  - :py:func:`imas.util.get_data_dictionary_version` returns the Data
+  - :py:func:`imaspy.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
@@ -84,18 +84,18 @@ New features
 
     pip install 'imas[imas-core] @ git+ssh://git@github.com/iterorganization/imas-core.git'
 
-- A diff tool for IDSs: :py:func:`imas.util.idsdiff`.
+- A diff tool for IDSs: :py:func:`imaspy.util.idsdiff`.
 - Implement ``==`` equality checking for IDS Structures and Arrays of Structures
   (`IMAS-5120 <https://jira.iter.org/browse/IMAS-5120>`__).
 - Add option to ignore unknown Data Dictionary versions of data stored in the
   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
+  During a :py:meth:`~imaspy.db_entry.DBEntry.get` or
+  :py:meth:`~imaspy.db_entry.DBEntry.get_slice`, imas-python 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
   setting the parameter
-  :py:param:`~imas.db_entry.DBEntry.get.ignore_unknown_dd_version` to
+  :py:param:`~imaspy.db_entry.DBEntry.get.ignore_unknown_dd_version` to
   ``True``, and imas-python will do its best to load the data anyway.
 
 - A new command line tool exists for analyzing which Data Dictionary fields are
@@ -128,18 +128,18 @@ Breaking changes
 Bug fixes
 '''''''''
 
-- Fixed a bug in :py:func:`imas.util.inspect` when inspecting lazy loaded IDSs.
+- Fixed a bug in :py:func:`imaspy.util.inspect` when inspecting lazy loaded IDSs.
 - Fixed a bug when converting the ``neutron_diagnostics`` IDS to/from Data
   Dictionary version ``3.41.0``.
 - Fixed a bug that allowed setting arbitrary attributes on IDS structures. It is
   only allowed to use attributes defined by the Data Dictionary.
-- Fixed a bug with :py:func:`~imas.ids_toplevel.IDSToplevel.serialize` when
+- Fixed a bug with :py:func:`~imaspy.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
   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 imas-python. :py:attr:`imaspy.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
@@ -157,16 +157,16 @@ Bug fixes
 Improved performance
 ''''''''''''''''''''
 
-- Improved performance of :py:meth:`~imas.ids_toplevel.IDSToplevel.validate`.
+- Improved performance of :py:meth:`~imaspy.ids_toplevel.IDSToplevel.validate`.
 - Improved creation of imas-python 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.
+  them with :py:meth:`~imaspy.db_entry.DBEntry.get` /
+  :py:meth:`~imaspy.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.
-- 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` /
-  :py:meth:`~imas.db_entry.DBEntry.put_slice` for IDSs with many nested arrays
+- Improved the performance of :py:meth:`~imaspy.db_entry.DBEntry.get` /
+  :py:meth:`~imaspy.db_entry.DBEntry.get_slice` /
+  :py:meth:`~imaspy.db_entry.DBEntry.put` /
+  :py:meth:`~imaspy.db_entry.DBEntry.put_slice` for IDSs with many nested arrays
   of structures. This performance improvement is most noticeable for IDSs with
   filled GGD grids and data structures (up to 25% faster).
 
@@ -195,7 +195,7 @@ recent DD versions. Further details on IDS conversion can be found in
 - Automatically convert data between 0D and 1D when possible (`IMAS-5170
   <https://jira.iter.org/browse/IMAS-5170>`__).
   The following type changes are now automatically supported by
-  :py:func:`imas.convert_ids <imas.ids_convert.convert_ids>`:
+  :py:func:`imaspy.convert_ids <imaspy.ids_convert.convert_ids>`:
 
   - INT_0D to INT_1D
   - FLT_0D to FLT_1D

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/docs/source/courses/basic/create.rst

@@ -153,10 +153,8 @@ Exercise 5
             pulse = 1
             run = 1
 
-        After a successful ``put``, the ids file will be created. If you are using
-        AL4, you should see a file ``imas-course_1_1_core_profiles.ids`` in your 
-        working directory with the contents of the IDS. 
-        If you are using AL5, this file can be found under
+        After a successful ``put``, the ids file will be created. 
+        this file can be found under
         ``~/public/imasdb/imas-course/3/1/1/core_profiles.ids`` 
 
         .. hint::

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/docs/source/courses/basic/explore.rst

@@ -30,8 +30,7 @@ Exercise 1
         Find out the names of the available IDSs.
 
         .. hint::
-            The module ``imas.ids_names`` contains information on the available IDSs in
-            AL4.
+            The module ``imas.ids_names`` contains information on the available IDSs.
 
             In imas-python, you can use :py:class:`~imas.ids_factory.IDSFactory` to figure
             out which IDSs are avaible.

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/docs/source/courses/basic_user_training.rst

@@ -6,13 +6,7 @@ imas-python 101
 In this imas-python training, we introduce you to the basic concepts and features of
 imas-python. You will need some basic familiarity with Python. For a refresher, see
 the `Python tutorial <https://docs.python.org/3/tutorial/>`_. We also assume
-some basic knowledge of the ITER IMAS infrastructure, see
-https://imas.iter.org. To get access to the nessecary knowledge and tooling
-to start using imas-python, including an already installed imas-python, follow the excellent
-`Getting Started <https://confluence.iter.org/display/IMP/Getting+Started>`_
-until "How to read / write IMAS data", after which you can follow the imas-python
-specific guide below.
-
+some basic knowledge of the ITER IMAS infrastructure.
 
 .. toctree::
     :caption: Training contents

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/docs/source/imas_architecture.rst

@@ -56,7 +56,7 @@ immutable.
 
         Although an :py:class:`~imas.ids_path.IDSPath` in imas-python implements roughly
         the same concept as `the "IDS Path syntax" in the Data Dictionary
-        <https://github.com/iterorganization/imas-data-dictionary/browse/html_documentation/utilities/IDS-path-syntax.md?at=refs%2Fheads%2Fdevelop%2F3>`__,
+        <https://github.com/iterorganization/imas-data-dictionary/blob/develop/html_documentation/utilities/IDS-path-syntax.md>`__,
         they are not necessarily the same thing!
 
         At the moment of writing this (January 2024), the IDS path definition in the

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/imas/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.dev1643'
-__version_tuple__ = version_tuple = (0, 1, 'dev1643')
+__version__ = version = '0.1.dev1647'
+__version_tuple__ = version_tuple = (0, 1, 'dev1647')

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/imas/db_entry.py

@@ -55,13 +55,13 @@ class DBEntry:
 
         import imas
 
-        # AL4-style constructor:
+        # old constructor:
         with imas.DBEntry(imas.ids_defs.HDF5_BACKEND, "test", 1, 12) as dbentry:
             # dbentry is now opened and can be used for reading data:
             ids = dbentry.get(...)
         # The dbentry is now closed
 
-        # AL5-style constructor also allows creating the Data Entry with the mode
+        # new constructor also allows creating the Data Entry with the mode
         # argument
         with imas.DBEntry("imas:hdf5?path=testdb", "w") as dbentry:
             # dbentry is now created and can be used for writing data:

{imas_python-0.1.dev1643 → imas_python-0.1.dev1647}/imas_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: imas-python
-Version: 0.1.dev1643
+Version: 0.1.dev1647
 Summary: Pythonic wrappers for the IMAS Access Layer
 Author: imas-python developers
 Author-email: Olivier Hoenen <olivier.hoenen@iter.org>