Skip to content

Python interface to netCDF files written according to the CF Metadata conventions

License

Notifications You must be signed in to change notification settings

TUW-GEO/pynetcf

Repository files navigation

https://coveralls.io/repos/github/TUW-GEO/pynetcf/badge.svg?branch=master https://readthedocs.org/projects/pynetcf/badge/?version=latest

pynetcf

Basic python classes that map to netCDF files on disk written according to the Climate and Forecast metadata conventions

This is a first draft which has a lot of room for improvements, this is especially true for the time series based representations.

Citation

If you use the software in a publication then please cite it using the Zenodo DOI. Be aware that this badge links to the latest package version.

Please select your specific version at https://doi.org/10.5281/zenodo.846767 to get the DOI of that version. You should normally always use the DOI for the specific version of your record in citations. This is to ensure that other researchers can access the exact research artefact you used for reproducibility.

You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning

Installation

This package should be installable through pip:

pip install pynetcf

Contribute

We are happy if you want to contribute. Please raise an issue explaining what is missing or if you find a bug. We will also gladly accept pull requests against our master branch for new features or bug fixes.

Development setup

For Development we also recommend a conda environment. You can create one including test dependencies and debugger by running conda env create -f environment.yml. This will create a new pynetcf environment which you can activate by using source activate pynetcf.

Guidelines

If you want to contribute please follow these steps:

  • Fork the pynetcf repository to your account
  • make a new feature branch from the pynetcf master branch
  • Add your feature
  • Please include tests for your contributions in one of the test directories. We use py.test so a simple function called test_my_feature is enough
  • submit a pull request to our master branch

Note

This project has been set up using PyScaffold 4.2.3. For details and usage information on PyScaffold see https://pyscaffold.org/.

About

Python interface to netCDF files written according to the CF Metadata conventions

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages