Metadata-Version: 2.1
Name: ncas_amof_netcdf_template
Version: 2.0.0b0
Summary: Package to create NCAS AMOF netCDF files.
Home-page: https://github.com/joshua-hampton/ncas_amof_netcdf_template
Author: Joshua M. Ralph-Hampton
Author-email: joshua.hampton@ncas.ac.uk
Keywords: NCAS,AMOF,netcdf,template,standard
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7, <4
Description-Content-Type: text/markdown
License-File: LICENSE

ncas-amof-netcdf-template
=========================
[![Documentation Status](https://readthedocs.org/projects/ncas-amof-netcdf-template/badge/?version=latest)](https://ncas-amof-netcdf-template.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/ncas-amof-netcdf-template.svg)](https://pypi.org/project/ncas-amof-netcdf-template/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ncas-amof-netcdf-template)


Makes 'just-add-data' AMOF-compliant netCDF4 file.

A full description on how to install and use this module can be found [through the documentation](https://ncas-amof-netcdf-template.readthedocs.io/).

Requirements
------------
* Python 3.7 or above
* Python modules:
  * [netCDF4](http://unidata.github.io/netcdf4-python/)
  * [NumPy](https://numpy.org/) 
  * [Requests](https://requests.readthedocs.io/en/latest/)
  * [pandas](https://pandas.pydata.org/)

Installation
------------
Releases of `ncas-amof-netcdf-template` can be installed from pip
```
pip install ncas-amof-netcdf-template
```
or releases can be [downloaded from GitHub](https://github.com/joshua-hampton/ncas_amof_netcdf_template/releases) and installed using
```
pip install .
```


Usage
-----

A fuller description of how to use this module can be found in the [documentation](https://ncas-amof-netcdf-template.readthedocs.io/en/latest/usage.html).

```python
import ncas_amof_netcdf_template as nant
nant.create_netcdf.main(instrument, date = None, dimension_lengths = {}, loc = 'land', products = None)
```
where:
- `instrument` - name of NCAS instrument, e.g. "ncas-ceilometer-3"
- `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.
- `products` - applicable products of desired NCAS instrument to make netCDF for. Setting products as `None` (default) makes netCDF file for all available products. 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
```python
import ncas_amof_netcdf_template as nant
nant.create_netcdf.list_products(instrument)
```
where `instrument` is replaced with the name of the NCAS instrument.


