Skip to content


Repository files navigation

latest docs


The COSIMA Cookbook is a framework for analysing output from ocean-sea ice models. The focus is on the ACCESS-OM2 suite of models being developed and run by members of COSIMA: Consortium for Ocean-Sea Ice Modelling in Australia. But this framework is suited to analysing any MOM5/MOM6 output, as well as output from other models.

The cookbook is structured as follows:

  • This repository includes boiler-plate code and scripts that underpin the cookbook.
  • The cosima-recipes repository includes example notebooks on which you can base your analyses.
  • The cosima-recipes template provides you with a template if you want to contribute your own scripts to the analysis.

Getting Started

The easiest way to use the COSIMA Cookbook is through NCI's HPC systems (either VDI or Gadi). The cookbook is preinstalled in the latest conda/analysis3 environment.

Once you have an account on the VDI, you should:

  1. Clone the cosima-recipes repository to your local file space.
  2. Start a jupyter notebook session using the following commands:
>> module use /g/data/hh5/public/modules/
>> module load conda/analysis3-unstable
>> jupyter notebook
  1. Navigate to one of the COSIMA recipes and run the analysis.

Alternatively, you might prefer to download vdi_jupyter or the gadi_jupyter scripts hosted in the CLEx CMS Github Repository coecms/nci_scripts. These scripts will allow you to open a Jupyter notebook in your local browser window.

Using the Cookbook

The COSIMA Cookbook relies on several components:

  1. There needs to be a database of simulations -- on the NCI system, model output that is stored in the COSIMA space on the /g/data/ik11/ directory.
  2. Once you have access to data, the best place to start is the cosima-recipes repository which includes a series of jupyter notebooks containing examples that guide you through to use the cookbook to load model output and then proceed doing simple (or elaborate) computations. The best starting point of exploring the cosima-recipes is the Documented Examples. A collection of useful examples leveraging the cosima-cookbook is also found here.

Contributing to the Cookbook

If you like the cookbook, you may like to interact more closely with us:

  • Contributions of new notebooks or analysis scripts are always welcome. Please check out the cosima-recipes repository.
  • If you find a problem, or have a suggestion for improvement, please log an issue.
  • All code submitted as part of the cosima-cookbook itself must be formatted with black

Conditions of use for ACCESS-OM2 data

We request that users of ACCESS-OM2 model code or output data:

  1. consider citing Kiss et al. (2020) (

  2. include an acknowledgement such as the following:

    The authors thank the Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA; for making the ACCESS-OM2 suite of models available at

  3. let us know of any publications which use these models or data so we can add them to our list.

Documentation Status