Skip to content

Commit 62506e0

Browse files
committed
Update netcdf documentation
1 parent ae9af2a commit 62506e0

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

docs/source/netcdf.rst

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ IMAS netCDF files
1111

1212
IMAS-Python supports reading IDSs from and writing IDSs to IMAS netCDF files. This
1313
feature is currently in alpha status, and its functionality may change in
14-
upcoming minor releases of IMAS-Python.
14+
upcoming (minor) releases of IMAS-Python.
1515

1616
A detailed description of the IMAS netCDF format and conventions can be found on
1717
the :ref:`IMAS conventions for the netCDF data format` page.
@@ -42,6 +42,34 @@ will be used for :py:meth:`~imas.db_entry.DBEntry.get` and
4242
imas.util.print_tree(cp2)
4343
4444
45+
Implemented features of a netCDF ``DBEntry``
46+
--------------------------------------------
47+
48+
A netCDF ``DBEntry`` doesn't implement all features that are supported by
49+
``imas_core``. The following table provides an overview of the implemented
50+
features that are supported by DBEntries using ``imas_core`` respectively
51+
``netCDF``:
52+
53+
.. list-table::
54+
:header-rows: 1
55+
56+
* - Feature
57+
- ``imas_core``
58+
- ``netCDF``
59+
* - :ref:`Lazy loading`
60+
- Yes
61+
- Yes
62+
* - :ref:`Automatic conversion between DD versions <Conversion of IDSs between DD versions>`
63+
- When reading and writing
64+
- When reading
65+
* - ``get_slice`` / ``put_slice``
66+
- Yes
67+
- Not implemented
68+
* - ``get_sample``
69+
- Yes (requires ``imas_core >= 5.4.0``)
70+
- Not implemented
71+
72+
4573
Using IMAS netCDF files with 3rd-party tools
4674
--------------------------------------------
4775

0 commit comments

Comments
 (0)