A utility to describe the structure of NetCDF4 datasets.
Reads a NetCDF4 file and reports the group structure and information about any dimensions, variables, and attributes that are defined.
Build and install the package with...
$ python -m pip install .The optional test suite may be installed and run with:
$ python -m pip install .[test]
$ pytest --cov=ncmetadata testsusage: ncmetadata [-h] [-o {category,group}] [-e <group0>,<group1>,...] [-m] [-d] filename
Extracts metadata from netCDF4 files
positional arguments:
filename
options:
-h, --help show this help message and exit
-o {category,group} --order-by {category,group}
(default group)
-e <group0>,<group1>,..., --exclude-groups <group0>,<group1>,...
Exclude each of the named <group> arguments
-m, --omit-metadata Output only netCDF file contents, not file metadata
-d, --omit-digest Do not include a hash digest in file metadataThe --order-by option allows the resulting output to be arranged in one of two ways:
1. By `group` creates a listing of dimensions, variables, and attributes for
each netCDF group within a file.
2. By `category` creates a listing of the properties of each group organised into
separate examples for each category of dimension, variable, and attribute.
The --omit-digest option prevents calculation of a SHA256 hash for the processed file.
This may be desirable for very large files or test workflows to avoid the potentially
time-consuming hashing operation.
For example, to report on the contents of the netCDF4 file test.nc using the default
output options...
$ ncmetadata test.nc