cfmeta

cfmeta is a basic utility for generating and parsing CMIP5 file paths.

Requirements

For basic functionality cfmeta has no special requirements. The netCDF option requires the netCDF4 package.

Installing cfmeta

cfmeta can be installed from the Python package index:

pip install cfmeta[netCDF]

from Github:

pip install git+git://https://github.com/basilveerman/cfmeta#egg=cfmeta

Usage

Documentation is hosted at ReadTheDocs

Contributing

Generating Documentation

Generated using the make doc command

If required, documentation can be updated on gh-pages as such:

git branch -D gh-pages
git branch -D draft
git checkout -b draft
git add -f doc/build/html
git commit -am"Deploy docs on gh-pages"
git subtree split --prefix doc/build/html -b gh-pages
git push -f origin gh-pages:gh-pages
git checkout master

Releasing

1. Update version string in setup.py
2. Build updated api docs and commit any changes bash make doc git add doc/source/*.rst git commit -m"Update api docs"
3. Commit and tag the new version bash git add setup.py git commit -m"Bump to version <VERSION_NUMBER>" git tag -am"<VERSION_NUMBER>" <VERSION_NUMBER> git push --follow-tags
4. Build and upload the new version bash python setup.py sdist bdist_wheel twine upload dist/*