xnemogcm 0.2

Interface to open NEMO global circulation model output dataset and create a xgcm grid.

xnemogcm

Interface to open NEMO global circulation model output dataset and create a xgcm grid.

One can be interested by the XORCA python package, that does a similar work for all NEMO output grid. xnemogcm is designed to be more simple and adapted to a simple idealized configuration.

Usage

from xnemogcm import open_nemo_and_domain_cfg
ds = open_nemo_and_domain_cfg(datadir='/path/to/data')

# Interface with xgcm
from xnemogcm import get_metrics
import xgcm
grid = xgcm.Grid(ds, metrics=get_metrics(ds), periodic=False)

Installation

Installation via pip:

pip install git+https://github.com/rcaneill/xnemogcm.git@master

Requirements for dev

We use pipenv to set up a virtual environment containing all needed packages to run xnemogcm and the tests. To install all the dependencies, type pipenv install after cloning the directory. This will create a new virtual environment. Typing pipenv shell in the package directory will activate the virtual environment.