| Name | ncas-amof-netcdf-template JSON |
| Version |
2.4.0
JSON |
| download |
| home_page | |
| Summary | Package to create NCAS AMOF netCDF files. |
| upload_time | 2024-02-26 14:43:56 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | <4,>=3.8 |
| license | MIT License Copyright (c) 2023 Joshua Hampton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ncas
amof
netcdf
template
standard
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ncas-amof-netcdf-template
=========================
[](https://pypi.org/project/ncas-amof-netcdf-template/)
[](https://anaconda.org/conda-forge/ncas-amof-netcdf-template)
[](https://ncas-amof-netcdf-template.readthedocs.io/en/stable)
[](https://github.com/joshua-hampton/ncas_amof_netcdf_template/actions/workflows/run_tests.yml)
[](https://results.pre-commit.ci/latest/github/joshua-hampton/ncas_amof_netcdf_template/main)
[](https://github.com/charliermarsh/ruff)
[](https://github.com/psf/black)
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](https://ncas-amof-netcdf-template.readthedocs.io/en/stable).
Requirements
------------
* Python 3.8 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 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](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/stable/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.
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](#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](https://pre-commit.com/) for more details.
Licence
-------
This package is available under the [MIT licence](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "ncas-amof-netcdf-template",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "",
"keywords": "NCAS,AMOF,netcdf,template,standard",
"author": "",
"author_email": "\"Joshua M. Ralph-Hampton\" <joshua.hampton@ncas.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/0e/6a/a59b1f05775055d700a249a15b99cc3c5fdd40df793f426945a638a34290/ncas_amof_netcdf_template-2.4.0.tar.gz",
"platform": null,
"description": "ncas-amof-netcdf-template\n=========================\n[](https://pypi.org/project/ncas-amof-netcdf-template/)\n[](https://anaconda.org/conda-forge/ncas-amof-netcdf-template)\n\n\n[](https://ncas-amof-netcdf-template.readthedocs.io/en/stable)\n[](https://github.com/joshua-hampton/ncas_amof_netcdf_template/actions/workflows/run_tests.yml)\n[](https://results.pre-commit.ci/latest/github/joshua-hampton/ncas_amof_netcdf_template/main)\n\n[](https://github.com/charliermarsh/ruff)\n[](https://github.com/psf/black)\n\nMakes 'just-add-data' AMOF-compliant netCDF4 file for either a given NCAS instrument or one of the defined data products.\n\nA full description on how to install and use this module can be found [through the documentation](https://ncas-amof-netcdf-template.readthedocs.io/en/stable).\n\nRequirements\n------------\n* Python 3.8 or above\n* Python modules:\n * [netCDF4](http://unidata.github.io/netcdf4-python/)\n * [NumPy](https://numpy.org/)\n * [Requests](https://requests.readthedocs.io/en/latest/)\n * [pandas](https://pandas.pydata.org/)\n\nInstallation\n------------\nReleases of `ncas-amof-netcdf-template` can be installed using conda,\n```\nconda install -c conda-forge ncas-amof-netcdf-template\n```\nor by using pip,\n```\npip install ncas-amof-netcdf-template\n```\nor releases can be [downloaded from GitHub](https://github.com/joshua-hampton/ncas_amof_netcdf_template/releases) and installed using\n```\npip install .\n```\n\nUsage\n-----\n\nA fuller description of how to use this module can be found in the [documentation](https://ncas-amof-netcdf-template.readthedocs.io/en/stable/usage.html).\n\n```python\nimport ncas_amof_netcdf_template as nant\nnant.create_netcdf.main(instrument, date = None, dimension_lengths = {}, loc = 'land', products = None)\n```\nwhere:\n- `instrument` - name of NCAS instrument, e.g. \"ncas-ceilometer-3\"\n- `date` - date for data, YYYYmmdd format, default to today's date. Optional.\n- `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.\n- `loc` - one of 'land', 'air', 'sea', or 'trajectory', default is 'land'. Optional.\n- `products` - applicable products of desired NCAS instrument to make netCDF for. Setting products as `None` (default) makes netCDF file for all available products. Optional.\n- `verbose` - additional level of information and warnings to print. Only 1 additional layer of warnings are currently available.\n\nAll products associated with an instrument can be printed by\n```python\nimport ncas_amof_netcdf_template as nant\nnant.create_netcdf.list_products(instrument)\n```\nwhere `instrument` is replaced with the name of the NCAS instrument.\n\n\nContributing\n------------\nContributions 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](#licence). When contributing, users should create a new branch under their forked repository.\n\nNote 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](https://pre-commit.com/) for more details.\n\n\nLicence\n-------\nThis package is available under the [MIT licence](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Joshua Hampton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Package to create NCAS AMOF netCDF files.",
"version": "2.4.0",
"project_urls": {
"Documentation": "https://ncas-amof-netcdf-template.readthedocs.io/en/stable/",
"Homepage": "https://github.com/joshua-hampton/ncas_amof_netcdf_template"
},
"split_keywords": [
"ncas",
"amof",
"netcdf",
"template",
"standard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a40856809b8f0ce2e217f53af513f392c27ea71691cbc0096b73aa284213651",
"md5": "e654b1e4fbf7c062402cbebd591c0f61",
"sha256": "33fba964c476734cc2ecf6695bb41c55dc05b0761edbf4efce00ca7c5d7b10ea"
},
"downloads": -1,
"filename": "ncas_amof_netcdf_template-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e654b1e4fbf7c062402cbebd591c0f61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 20455,
"upload_time": "2024-02-26T14:43:54",
"upload_time_iso_8601": "2024-02-26T14:43:54.543321Z",
"url": "https://files.pythonhosted.org/packages/3a/40/856809b8f0ce2e217f53af513f392c27ea71691cbc0096b73aa284213651/ncas_amof_netcdf_template-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e6aa59b1f05775055d700a249a15b99cc3c5fdd40df793f426945a638a34290",
"md5": "27da1a430926a4097cdbec71ea7a4dee",
"sha256": "b7f149704792311d3c4556ea48637489fe6e5106e77a1da70f0ae3ad1b014bf5"
},
"downloads": -1,
"filename": "ncas_amof_netcdf_template-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "27da1a430926a4097cdbec71ea7a4dee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 26393,
"upload_time": "2024-02-26T14:43:56",
"upload_time_iso_8601": "2024-02-26T14:43:56.504847Z",
"url": "https://files.pythonhosted.org/packages/0e/6a/a59b1f05775055d700a249a15b99cc3c5fdd40df793f426945a638a34290/ncas_amof_netcdf_template-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 14:43:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joshua-hampton",
"github_project": "ncas_amof_netcdf_template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ncas-amof-netcdf-template"
}
