Welcome to NEMO CF’s documentation!¶

# NEMO CF

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/willirath/nemo_cf/master) [![PyPi status](https://img.shields.io/pypi/v/nemo_cf.svg)](https://pypi.python.org/pypi/nemo_cf) [![Travis Status](https://img.shields.io/travis/willirath/nemo_cf.svg)](https://travis-ci.com/willirath/nemo_cf) [![Docs status](https://readthedocs.org/projects/nemo-cf/badge/?version=latest)](https://nemo-cf.readthedocs.io/en/latest/?badge=latest)

Make NEMO output CF compliant

## Purpose of this tool

Starting from standard NEMO / XIOS2 output, we aim at creating datasets that have the following properties:

no un-ambiguous names and labels,
every variable contains information about the attached coordinates,
every variable has a unit, a long name, if possible a standard name.

Note that 1. implies that coordinate names like nav_lon and nav_lat should be replaced by the respective glam? and gphi fields.

## Materials

[NEMO book (pdf)](https://www.nemo-ocean.eu/wp-content/uploads/NEMO_book.pdf)
[CF conventions (v1.7)](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html)
The [UBC Salish Sea Model Project](https://salishsea.eos.ubc.ca/) erddap server [has lots of metadata suggestions](https://salishsea.eos.ubc.ca/erddap/griddap/index.html?page=1&itemsPerPage=1000).

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.

Installation¶

Stable release¶

To install NEMO CF, run this command in your terminal:

$ pip install nemo_cf

This is the preferred method to install NEMO CF, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for NEMO CF can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/willirath/nemo_cf

Or download the tarball:

$ curl -OJL https://github.com/willirath/nemo_cf/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

To use NEMO CF in a project:

import nemo_cf

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/willirath/nemo_cf/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

NEMO CF could always use more documentation, whether as part of the official NEMO CF docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/willirath/nemo_cf/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up nemo_cf for local development.

Fork the nemo_cf repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/nemo_cf.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv nemo_cf
$ cd nemo_cf/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 nemo_cf tests
$ python setup.py test or pytest
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/willirath/nemo_cf/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ pytest tests.test_nemo_cf

Deploying¶

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

# Credits

# Development Lead

Willi Rath <wrath@geomar.de>

# Contributors

None yet. Why not be the first?

# History

# 0.1.0 (2020-02-05)

First release on PyPI.