1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
legacyapi vs new API feature comparison
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In general both API should be comparable in handling netCDF4 files. The
:ref:`legacyapi <legacyapi>` is more in line with `netCDF4-python`_ , whereas the
:ref:`new API <api>` aligns to `h5py`_. Still, there are some
differences which are outlined in the following table.
.. _netCDF4-python: https://unidata.github.io/netcdf4-python/
.. _h5py: https://www.h5py.org/
.. include:: <isopub.txt>
+---------------------+-------------------------+----------------+------------------+
| feature | legacyapi | new api | type |
+=====================+=========================+================+==================+
| 1D boolean indexer | |check| | |check| | Variable/Dataset |
+---------------------+-------------------------+----------------+------------------+
| resize on write | |check| | |cross| | Dimension |
| | | | Variable/Dataset |
+---------------------+-------------------------+----------------+------------------+
| resize dimension | only current dimension | dimension and | Dimension |
| | | all connected | Variable/Dataset |
| | | variables | |
+---------------------+-------------------------+----------------+------------------+
| group name | name only | full path | Group |
+---------------------+-------------------------+----------------+------------------+
| phony_dims | kwarg | kwarg | Dimension |
+---------------------+-------------------------+----------------+------------------+
| decode_vlen_strings | |check| | kwarg | Variable/Dataset |
+---------------------+-------------------------+----------------+------------------+
| chunk sizes | ``h5netcdf``-style | kwarg | Variable/Dataset |
+---------------------+-------------------------+----------------+------------------+
| dimension ``.size`` | max size dimension | size dimension | Dimension |
| | and connected variables | | |
+---------------------+-------------------------+----------------+------------------+
| | | | Attribute |
| valid netcdf | kwarg | kwarg | Variable/Dataset |
+---------------------+-------------------------+----------------+------------------+
| ``h5py.Empty`` | | | |
| string attrs | ``b""`` | ``b""`` | Attribute |
+---------------------+-------------------------+----------------+------------------+
| endian | |check| | |cross| | Variable/Dataset |
+---------------------+-------------------------+----------------+------------------+
| track order | |cross| | |cross| | File/Group |
| | | | Dataset |
+---------------------+-------------------------+----------------+------------------+
|
