Skip to content

Summary

Welcome to the NEMO Cookbook Recipe page 👋

Each recipe uses the NEMODataTree and NEMODataArray data structures and their associated methods to calculate a diagnostic using NEMO ocean model outputs.

Just like the Cosima Cookook, each recipe is a self-contained and internally documented Jupyter notebook.

There are several ways to explore our available Recipes:

  1. Open a static version of the recipe in your browser by selecting View in Docs.
  2. Open the recipe in preview mode as a cloud-hosted marimo notebook using Open in molab. > You can also fork your Recipes and edit it iteractively in the browser using molab!
  3. Open the recipe as an interactive cloud hosted Jupyter notebook using Open In Colab. > Note that using Google Colab requires you to pip install nemo_cookbook and its dependencies at the start of your notebook!
  4. Clone the NEMO Cookbook GitHub repository and run the Jupyter notebooks directly from the recipes/ directory yourself.

📖 Available Recipes

  • Meridional Overturning - Tracer

    Meridional overturning stream function in an arbitrary tracer coordinates.

    View in Docs

    Open in molab Open In Colab

  • Meridional Overturning - Vertical

    Meridional overturning stream function in vertical coordinates (z/z*).

    View in Docs

    Open in molab Open In Colab

  • Ocean Heat Transport

    Global meridional ocean heat transport.

    View in Docs

    Open in molab Open In Colab

  • Volume Census

    Seawater volume census in discrete temperature - salinity coordinates.

    View in Docs

    Open in molab Open In Colab

  • Water Mass Transformation

    Surface-forced water mass transformation in discrete potential density coordinates.

    View in Docs

    Open in molab Open In Colab

  • Sea Ice Diagnostics

    Arctic Ocean sea ice area and sea ice extent.

    View in Docs

    Open in molab Open In Colab

  • Masked Statistics

    Grid-aware masked statistics using bounding boxes and geographical polyons.

    View in Docs

    Open in molab Open In Colab

  • Barotropic Stream Function

    Regional barotropic stream functions using grid-aware integration.

    View in Docs

    Open in molab Open In Colab

  • Ocean Heat Content

    Upper ocean heat content using depth integration.

    View in Docs

    Open in molab Open In Colab

  • Vertical Coordinate Transformations

    Transforming vertical coordinates using conservative remapping.

    View in Docs

    Open in molab Open In Colab

  • Extracting Hydrographic Sections

    Extracting volume transports and properties along the Overturning in the Subpolar North Atlantic array.

    View in Docs

    Open in molab Open In Colab

  • Extracting Variables along the Boundary of Masked Regions

    Extracting scalar and vector variables along the boundary of the Barent Sea.

    View in Docs

    Open in molab Open In Colab

  • Regridding using xESMF

    Regridding global sea surface temperature from the NEMO curvilinear grid to a regular rectilinear grid using xESMF.

    View in Docs

    Open in molab Open In Colab

🔨 Recipes In Development

  1. Meridional overturning stream functions in multi-envelope sigma coordinates.

  2. Ocean heat content & mixed layer heat content.

  3. Vorticity diagnostics.

  4. Eddy kinetic energy.

  5. Geostrophic velocities from sea surface height.

Contributing New Recipes...

If you've used NEMODataTree to calculate a commonly used diagnostic not currently included in the Recipe Lists above, we'd strongly encourage you to visit the Contributing page to learn more about contributing to the NEMO Cookbook.