NEMO Cookbook

Python recipes for reproducible analysis of NEMO ocean general circulation model outputs.

- Documentation - Report an Issue -

About

NEMO Cookbook is a collection of Python recipes for performing reproducible analyses of the Nucleus for European Modelling of the Ocean (NEMO) ocean general circulation model outputs.

Our aim is to provide Python implementations of the post-processing & analysis functions available in CDFTOOLS alongside new diagnostics (e.g., surface-forced water mass transformation), which are compatible with generalised vertical coordinate systems (e.g., MES).

Importantly, NEMO Cookbook does not aim to be a generic ocean circulation model analysis framework such as xgcm. As such, recipes do not require users to generate grid objects in advance of their calculations; only the necessary NEMO grid variables are required similar to CDFTOOLS.

Each recipe comprises of one or more functions built using the xarray, flox & dask libraries (think of these are your cooking utensils!) & the raw ingredients (ocean model outputs) - that's where you come in!

Getting Started

Installation

We recommend downloading and installing NEMO Cookbook into a new virtual environment via GitHub

First, clone the latest version of the nemo_cookbook repository using Git:

git clone [email protected]:NOC-MSM/nemo_cookbook.git

Next, install the dependencies in a new conda virtual environment:

cd nemo_cookbook

conda env create -f environment.yml

Finally, activate your new virtual environment and pip install NEMO Cookbook in editable mode:

conda activate env_nemo_cookbook

pip install -e .

Available Recipes

We are steadily adding more recipes to the NEMO Cookbook. Here, we include a list of currently available recipes & several more than are in progress.

Available:

1. Meridional Overturning Stream Function in an arbitrary tracer coordinates.

2. Meridional Overturning Stream Function in depth coordinates (z/z*).

3. Meridional Heat & Salt Transports.

4. Surface-Forced Overturning Stream Functions in potential density coordinates.

5. Volume census in temperature - salinity coordinates.

In Development:

1. Barotropic Stream Functions.

2. Meridional Overturning Stream Functions in depth coordinates (MES).

3. Ocean Heat Content & Mixed Layer Heat Content.

4. Sea Ice Diagnostics.

5. Vorticity Diagnostics.