Welcome to neutralNEMO’s documentation!

neutralNEMO is a Python library which helps users calculate neutral surfaces from NEMO model outputs.

This library makes it easier to use the highly-optimized algorithms of the neutralocean package (Stanley et al., 2021) with model outputs from NEMO.

The package contains routines to correctly load temperature and salinity data alongside the necessary horizontal and vertical grid information.

A streamlined routine is also included to calculate an approximately neutral density surface (an omega surface) which is fixed to a specific location in time and space. Additional options to calculate the Veronis density and potential density surfaces are also included.

Take a look at the Installation page and examples of use (ORCA example and Rectilinear example) to find out how to get started with neutralNEMO.

Note

This project is under active development.

I am keen to here how others get on with the library when they use it on their model runs. If it works well for you, please spread the word and let me know as it will make my day! If you do encounter any problems, please contact me or raise an issue on GitHub, I will try to help in any way I can.

Contents

• ORCA example
  • Example files
  • Loading grid data
  • Create a grid object
  • Load T-S data
  • Define the equation of state
  • Calculate surfaces
• Rectilinear example
  • Example files
  • Loading grid data
  • Create a grid object
  • Load T-S data
  • Define the equation of state
  • Calculate surfaces
• Public Function Reference
  • Surface Calculation
    • load_tsdata()
    • find_omega_surfs()
  • Grid Interpretation
    • build_nemo_hgrid()
    • load_hgriddata()
    • load_zgriddata()
  • Equation of State
    • NEMO_eos()
    • calc_seos()
    • calc_seos_s_t()
    • calc_eos()
    • calc_eos_s_t()