ncas-amof-netcdf-template 2.6.0

Package to create NCAS AMOF netCDF files.

ncas-amof-netcdf-template

Makes 'just-add-data' AMOF-compliant netCDF4 file for either a given NCAS instrument or one of the defined data products.

A full description on how to install and use this module can be found through the documentation.

Requirements

• Python 3.10 or above
• Python modules:
  • netCDF4
  • NumPy
  • Requests
  • pandas
  • PyYAML

Installation

Releases of ncas-amof-netcdf-template can be installed using conda,

conda install -c conda-forge ncas-amof-netcdf-template

or by using pip,

pip install ncas-amof-netcdf-template

or releases can be downloaded from GitHub and installed using

pip install .

Usage

A fuller description of how to use this module can be found in the documentation.

import ncas_amof_netcdf_template as nant
nant.create_netcdf.main(instrument, products = product date = None, dimension_lengths = {}, loc = 'land')

where:

• instrument - name of NCAS instrument, e.g. "ncas-ceilometer-3"
• products - data product to use to make netCDF file with.
• date - date for data, YYYYmmdd format, default to today's date. Optional.
• dimension_lengths - dictionary of lengths of dimensions, e.g. {'time':96, 'altitude':45}. If length for required dimensions are not given, then python will ask for user input, default empty. Optional.
• loc - one of 'land', 'air', 'sea', or 'trajectory', default is 'land'. Optional.
• verbose - additional level of information and warnings to print. Only 1 additional layer of warnings are currently available.

All products associated with an instrument can be printed by

import ncas_amof_netcdf_template as nant
nant.create_netcdf.list_products(instrument)

where instrument is replaced with the name of the NCAS instrument.

Contributing

Contributions are welcome from everyone, provided they enhance and improve the capabilities of this package, and code can be distributed under the conditions of the licence. When contributing, users should create a new branch under their forked repository.

Note that pre-commit-ci will run on all pull requests to this repository, however autofix is disabled. It is recommended that users ensure their contributions pass these checks before submitting pull requests, however users can type pre-commit.ci autofix into a comment after a failed pre-commit-ci run to automatically fix issues. See pre-commit for more details.

Licence

This package is available under the MIT licence.