Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

COSIMA

Ocean and sea-ice model analysis tools and examples.
https://github.com/cosima/cosima-recipes

Category: Cryosphere
Sub Category: Sea Ice

Keywords

climate-analysis climate-model climate-science jupyter ocean-modelling python sea-ice

Keywords from Contributors

ocean climate oceanography eddies med-team model-evaluation mom6 regional-model

Last synced: about 13 hours ago
JSON representation

Repository metadata

A cookbook 📒 of recipes (i.e., examples) for analysing ocean and sea ice model output. 👩🏽‍🍳🌊👨🏻‍🍳

README.md

COSIMA Cookbook

This repository is a Cookbook of Recipes 👩🏽‍🍳 👨🏻‍🍳.
A collection of recipes and tutorials for analysing ocean and sea ice model output produced by the Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA).

We explain: a "recipe" here is an example of an analysis of some ocean-sea ice model output or some ocean-related observational datasets.
Each "recipe" comes in a self-contained and well-documented Jupyter notebook.
All the recipes combined form a cookbook 📒!

Most recipes use output from the ACCESS-OM2 model, while some also use results from configurations of the Modular Ocean Model 6 (MOM6) and remote sensing observations.

To access the data used in these recipes you need an account with the Australian-based National Computational Infrastructure (NCI).

To get started, clone this repository in your local space on one of the NCI HPC machines so you can have access to model output. You should then be able to run these recipes (i.e., example analyses) through an Australian Research Environment (ARE) JupyterLab session running python or via any other way you might want to run a Jupyter notebook on an NCI HPC machine. You need to join projects hh5, xp65, ik11, cj50 and ol01 to run the recipes and access the data analysed.

If you plan to use an ARE session, then remember to include the projects in the Storage line: gdata/xp65+gdata/ik11+gdata/cj50+gdata/hh5+gdata/ol01 as well as any of your own project you need access to. In Module directories, set /g/data/hh5/public/modules and in Modules set conda/analysis3. Use a Compute Size of large or greater.

If you have never used the NCI see these first steps instructions and getting started with ARE.

Contributing

Have you made a recipe for analysing something that is not already included in this cookbook?
You are more than welcome to share it and include it in the cookbook!
Consider contributing your recipe back to the repository.
We are always delighted to expand our cookbook with more recipes.
If the process of contributing to the repository sounds a bit intimidating to you, rest assured that we will guide you and help you with submitting your contribution.

To make a contribution follow the steps laid out in the beginner's guide on how to contribute. If they sound intimidating then don't worry!
Just raise an issue explaining briefly what the contribution you want to make is and we'll help out with the process!

Contributors to the COSIMA Cookbook are added to the citable DOI entry associated with the repository.
Hence, users who put together a pull request for a new contribution, should ensure that the pull request also modifies the .zenodo.json file to include their affiliation details.

Contents

Tutorials

The starting point should be the COSIMA_CookBook_Tutorial that showcases how we can use Intake catalog to interrogate about available output and load them. The ACCESS-NRI_Intake_Catalog tutorial outlines the basic philosophy of the Intake catalog and how to transition from using the deprecated cosima_cookbook-way of loading variables. (If this 👉 cosima_cookbook.getvar means nothing to you then don't worry, it's already deprecated and you are better off not learning what that is in the first place!)

Also included here are some other tutorials, related to techniques (e.g., Making_Maps_with_Cartopy.ipynb) or tools (e.g., Model Agnostic Analysis).

Recipes

The main part of this cookbook: All the recipes! These are Jupyter notebooks for either simple or not-so-simple diagnostics and analyses. All notebooks are aimed to be self-contained and well-documented and explained.
If you can find a recipe that suits your purposes, then this is the best place to start.

ACCESS-OM2-GMD-Paper-Figs

Jupyter notebooks to reproduce (as far as possible) the figures from the ACCESS-OM2 model announcement paper (GMD, 2020). These notebooks are mostly uncommented, but they should be functional. They are intended to demonstrate methods to undertake the calculations used in the paper.

Loading model output: use intake; avoid deprecated cosima_cookbook

We are in the process of transitioning recipes from using the deprecated cosima-cookbook infrastructure to load model output to using an intake catalogue. That said, you will find recipes that use either method to access model data.

We strongly urge you to transition to intake catalogue and (pretty please 🥺) help us with converting all the recipes to using that!

Conditions of use for ACCESS-OM2 output

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

  1. citing Kiss et al. (2020) (http://doi.org/10.5194/gmd-13-401-2020)

  2. including an acknowledgement such as the following:

    The authors thank the vibrant community of the Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA; http://www.cosima.org.au) for making the ACCESS-OM2 suite of models available at https://github.com/COSIMA/access-om2.

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

Citation

If you use a recipe from the Cookbook for your research or teaching, or have based your analysis on one of the recipes, we would be grateful if you could cite:

DOI

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 426
Total Committers: 48
Avg Commits per committer: 8.875
Development Distribution Score (DDS): 0.559

Commits in past year: 92
Committers in past year: 18
Avg Commits per committer in past year: 5.111
Development Distribution Score (DDS) in past year: 0.554

Name Email Commits
Navid C. Constantinou n****y 188
Andy Hogg A****g@a****u 59
Angus Gibson a****s@a****e 28
Romain Beucher r****r@a****u 17
Anton Steketee 7****e 15
Aidan Heerdegen a****n@a****u 13
Ryan Holmes h****m@g****m 11
Adele Morrison a****n@a****u 8
Lidefi87 l****7@h****m 7
Andrew Kiss 3****s 6
Julia Neme j****e@u****u 5
claireyung 6****g 5
Micael Oliveira m****a@a****u 5
Wilma Huneke W****e@a****u 4
Charles Turner 5****1 4
ongqingyee 5****e 4
Ed Doddridge e****e 4
Claire Yung c****4@v****l 3
Christina Schmidt 3****a 3
James Munroe j****e@m****a 3
James Munroe j****4@g****u 2
Claire Yung c****4@v****l 2
Fabio Boeira Dias f****d@g****m 2
jemmajeffree 9****e 2
Wilton Aguiar 7****r 2
Hannah 6****n 2
janzika 3****a 1
Abhishek Savita a****4@g****u 1
Abhishek Savita a****4@v****l 1
Andy Hogg a****7@g****u 1
and 18 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 177
Total pull requests: 234
Average time to close issues: about 1 year
Average time to close pull requests: 25 days
Total issue authors: 35
Total pull request authors: 37
Average comments per issue: 6.47
Average comments per pull request: 6.24
Merged pull request: 167
Bot issues: 0
Bot pull requests: 0

Past year issues: 62
Past year pull requests: 151
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 20 days
Past year issue authors: 19
Past year pull request authors: 23
Past year average comments per issue: 6.79
Past year average comments per pull request: 4.98
Past year merged pull request: 97
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cosima/cosima-recipes

Top Issue Authors

  • navidcy (66)
  • adele-morrison (24)
  • AndyHoggANU (13)
  • anton-seaice (8)
  • aekiss (7)
  • taimoorsohail (5)
  • aidanheerdegen (5)
  • claireyung (4)
  • jmunroe (4)
  • hrsdawson (3)
  • schmidt-christina (3)
  • rbeucher (3)
  • julia-neme (2)
  • dougiesquire (2)
  • Oler2008 (2)

Top Pull Request Authors

  • navidcy (76)
  • rbeucher (39)
  • anton-seaice (16)
  • charles-turner-1 (13)
  • julia-neme (13)
  • angus-g (9)
  • lidefi87 (5)
  • AndyHoggANU (5)
  • adele-morrison (5)
  • claireyung (4)
  • micaeljtoliveira (4)
  • edoddridge (3)
  • willaguiar (3)
  • ashjbarnes (3)
  • vsilvafelipe (2)

Top Issue Labels

  • 🕹️ hackathon 4.0 (55)
  • 💻 hackathon 2.0 (36)
  • ❓ question (18)
  • 🐣 good first issue (17)
  • 🎮 hackathon 3.0 (17)
  • 📔 tutorial (13)
  • 🛸 updating (11)
  • 📺 hackathon 1.0 (10)
  • 🐞 bug (9)
  • 🧜🏽‍♀️ enhancement (8)
  • 🧹 cleanup (8)
  • MOM5 📜 (7)
  • MOM6 🛸 (7)
  • documentation 📜 (5)
  • 🐣 new example (5)
  • testing 🧪 (4)
  • MOM5+MOM6 ❤️ (3)
  • technical (3)
  • 🐣 new recipe (3)
  • performance 🏎️ (1)
  • 🛟 help wanted (1)
  • ARD (1)
  • ❌ invalid (1)

Top Pull Request Labels

  • 🕹️ hackathon 4.0 (60)
  • 🛸 updating (30)
  • 💻 hackathon 2.0 (24)
  • documentation 📜 (20)
  • 🎮 hackathon 3.0 (14)
  • 🧹 cleanup (13)
  • 📔 tutorial (11)
  • MOM5+MOM6 ❤️ (9)
  • ready to review ❣️ (8)
  • 🐞 bug (7)
  • 🐣 new example (6)
  • testing 🧪 (6)
  • 🐣 new recipe (5)
  • stale❓😐 (5)
  • 🧜🏽‍♀️ enhancement (4)
  • MOM5 📜 (4)
  • technical (2)
  • performance 🏎️ (2)
  • MOM6 🛸 (1)
  • 🛟 help wanted (1)

Dependencies

docs/requirements.txt pypi
  • sphinx *
  • sphinx-nbexamples *
.github/workflows/sphinx.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite

Score: 8.699514748210193