Skip to main content

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.

Metadata

Release files for ncas-amof-netcdf-template 2.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ncas-amof-netcdf-template 2.6.1
File Size Uploaded Provenance Actions
ncas_amof_netcdf_template-2.6.1.tar.gz 34.0 kB Without provenance Details for ncas_amof_netcdf_template-2.6.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ncas-amof-netcdf-template 2.6.1
File Interpreter ABI Platform Actions
ncas_amof_netcdf_template-2.6.1-py3-none-any.whl Python 3 none any Details for ncas_amof_netcdf_template-2.6.1-py3-none-any.whl

Total release size: 61.7 kB

Release files / ncas_amof_netcdf_template-2.6.1.tar.gz

Download URL ncas_amof_netcdf_template-2.6.1.tar.gz
Size 34.0 kB
Tags Source
SHA-256 checksum
How to use checksums
050216730847beb06f1571528d718224adb3c0877957c38c951133d0f9521cd7
BLAKE2b-256 checksum
How to use checksums
6bff508b0d0122d62be825f54bef53471992d878bf1ef6bd0e24841947ac2f32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / ncas_amof_netcdf_template-2.6.1-py3-none-any.whl

Download URL ncas_amof_netcdf_template-2.6.1-py3-none-any.whl
Size 27.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b8c5739ce51f653ba8aae6a9918a4ccfe9d16d719f75b43a5428fe1a71f94de
BLAKE2b-256 checksum
How to use checksums
73eafed08d6cbb005a57461f8b6cf0b7911126d5da7cf3a18347a4aeb7595d75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for ncas-amof-netcdf-template 2.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page