Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/source/courses/advanced/dd_versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Bundled Data Dictionary definitions

IMAS-Python comes bundled [#DDdefs]_ with many versions of the Data Dictionary definitions.
You can find out which versions are available by calling
:py:meth:`imas.dd_zip.dd_xml_versions`.
``imas.dd_zip.dd_xml_versions``.


Converting an IDS between Data Dictionary versions
Expand Down Expand Up @@ -290,6 +290,6 @@ build, you can use them like you normally would.

.. rubric:: Footnotes

.. [#DDdefs] To be more precise, the Data Dictionary definitions are generated when the
IMAS-Python package is created. See :ref:`this reference <DD background>` for more
details.
.. [#DDdefs] To be more precise, the Data Dictionary definitions are provided by the
`IMAS Data Dictionaries <http://pypi.org/project/imas-data-dictionaries/>`__
package.
4 changes: 0 additions & 4 deletions docs/source/imas_architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,7 @@ Data Dictionary building and loading
The following submodules are responsible for building the Data Dictionary and loading DD
definitions at runtime.

- :py:mod:`imas.dd_helpers` handles building the ``IDSDef.zip`` file, containing all
versions of the Data Dictionary since ``3.22.0``.

- :py:mod:`imas.dd_zip` handles loading the Data Dictionary definitions at run time.
These definitions can be loaded from an ``IDSDef.zip`` or from a custom XML file.


.. _imas_architecture/IDS_nodes:
Expand Down
23 changes: 8 additions & 15 deletions docs/source/multi-dd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -207,21 +207,14 @@ Automated tests have been provided that check the loading of all of the DD
versions tagged in the data-dictionary git repository.


Extending the DD set
''''''''''''''''''''
Data Dictionary definitions
'''''''''''''''''''''''''''

Use the command ``python setup.py build_DD`` to build a new ``IDSDef.zip``. This
fetches all tags from the data dictionary git repository and builds the ``IDSDef.zip``.
The Data Dictionary definitions used by IMAS-Python are provided by the `IMAS Data
Dictionaries <http://pypi.org/project/imas-data-dictionaries/>`__ package.
Please update this package if you need a more recent version of the data dictionary. For
example, using ``pip``:

IMAS-Python searches for an ``IDSDef.zip`` in the following locations:
.. code-block:: bash

1. The environment variable ``$IMAS_DDZIP`` (path to a zip file)
2. The file ``./IDSDef.zip`` in the current working directory
3. In the local configuration folder: ``~/.config/imas/IDSDef.zip``, or
``$XDG_CONFIG_DIR/imas/IDSDef.zip`` (if the environment variable
``$XDG_CONFIG_DIR`` is set)
4. The zipfile bundled with the IMAS-Python installation: ``assets/IDSDef.zip``

All paths are searched in order when loading the definitions of a specific data
dictionary version: the first zip file that contains the definitions of the requested
version is used.
pip install --upgrade imas-data-dictionaries
1 change: 0 additions & 1 deletion imas/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
# Load the IMAS-Python IMAS AL/DD core
from . import (
db_entry,
dd_helpers,
dd_zip,
util,
)
Expand Down
167 changes: 0 additions & 167 deletions imas/dd_helpers.py

This file was deleted.

Loading
Loading