Skip to main content

Package to create NCAS AMOF netCDF files.

Project description

ncas-amof-netcdf-template

PyPI Conda (channel only) PyPI - Python Version

Documentation Status GitHub Workflow Status pre-commit.ci status

Ruff Code style: black codecov

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ncas_amof_netcdf_template-2.5.1.tar.gz (33.8 kB view details)

Uploaded Source

Built Distribution

ncas_amof_netcdf_template-2.5.1-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file ncas_amof_netcdf_template-2.5.1.tar.gz.

File metadata

File hashes

Hashes for ncas_amof_netcdf_template-2.5.1.tar.gz
Algorithm Hash digest
SHA256 31de225d54459889633f66985c63f847d89d17380751050ca4890859f34a58a6
MD5 b1d6610372160fc9cebc26044b441f0d
BLAKE2b-256 43a6f29042d79ebbb2f946b9b76cc6a9c7640eb3c5f08c03c21d847a68e4390e

See more details on using hashes here.

File details

Details for the file ncas_amof_netcdf_template-2.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ncas_amof_netcdf_template-2.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 46f070a869a82636e0c815e1408de1b4838623ed60f62671b393556bc919e554
MD5 9cc48de05bbd780480680f46e7a8c4c4
BLAKE2b-256 112dfcca3c699d156120ded9ebe31b3b06eb876e5da47ff21c0729fdfcab6dd8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page