cosima-recipes
A cookbook 📒 of recipes (i.e., examples) for analysing ocean and sea ice model output. 👩🏽🍳🌊👨🏻🍳
Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 14 DOI reference(s) in README -
✓Academic publication links
Links to: scholar.google, zenodo.org -
✓Committers with academic emails
11 of 49 committers (22.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
A cookbook 📒 of recipes (i.e., examples) for analysing ocean and sea ice model output. 👩🏽🍳🌊👨🏻🍳
Basic Info
- Host: GitHub
- Owner: COSIMA
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://cosima-recipes.readthedocs.io
- Size: 192 MB
Statistics
- Stars: 55
- Watchers: 14
- Forks: 70
- Open Issues: 41
- Releases: 4
Topics
Metadata Files
README.md
COSIMA Cookbook
This repository is a Cookbook of Recipes 👩🏽🍳 👨🏻🍳. A collection of cooking lessons and recipes for analysing ocean and sea ice model output produced by the Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA).
We explain: a "cooking lesson" here is a tutorial that teaches you something generic (e.g. about plotting or loading data); a "recipe" is an example of an analysis of some ocean-sea ice model output or some ocean-related observational datasets. Both "cooking lessons" and "recipes" come in self-contained and well-documented Jupyter notebooks. All the lessons and 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 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/ol01 as well as any of your own project you need access to. In Module directories, set /g/data/xp65/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
Cooking Lessons 101 (Tutorials)
The starting point should be the COSIMACookBookTutorial that showcases how we can use Intake catalog to interrogate about available output and load them. The ACCESS-NRIIntakeCatalog 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., MakingMapswith_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
Recipes have been transitioned to load model output to using an intake catalogue. The deprecated cosima-cookbook infrastructure
is no longer in use, and is not available on xp65 environments.
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.
- 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:
Owner
- Name: COSIMA
- Login: COSIMA
- Kind: organization
- Location: Australia
- Website: http://cosima.org.au
- Repositories: 70
- Profile: https://github.com/COSIMA
Consortium for Ocean-Sea Ice Modelling in Australia
GitHub Events
Total
- Create event: 50
- Commit comment event: 1
- Release event: 3
- Delete event: 71
- Member event: 2
- Pull request event: 117
- Fork event: 5
- Issues event: 90
- Watch event: 7
- Issue comment event: 622
- Push event: 251
- Gollum event: 2
- Pull request review comment event: 73
- Pull request review event: 127
Last Year
- Create event: 50
- Commit comment event: 1
- Release event: 3
- Delete event: 71
- Member event: 2
- Pull request event: 117
- Fork event: 5
- Issues event: 90
- Watch event: 7
- Issue comment event: 622
- Push event: 251
- Gollum event: 2
- Pull request review comment event: 73
- Pull request review event: 127
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Navid C. Constantinou | n****y | 192 |
| Andy Hogg | A****g@a****u | 59 |
| Angus Gibson | a****s@a****e | 29 |
| Romain Beucher | r****r@a****u | 26 |
| Anton Steketee | 7****e | 16 |
| Charles Turner | 5****1 | 14 |
| Aidan Heerdegen | a****n@a****u | 13 |
| Ryan Holmes | h****m@g****m | 11 |
| Adele Morrison | a****n@a****u | 9 |
| Marc White | m****6@g****m | 7 |
| Lidefi87 | l****7@h****m | 7 |
| Andrew Kiss | 3****s | 6 |
| Julia Neme | j****e@u****u | 6 |
| claireyung | 6****g | 5 |
| Micael Oliveira | m****a@a****u | 5 |
| ongqingyee | 5****e | 4 |
| Wilma Huneke | W****e@a****u | 4 |
| Ed Doddridge | e****e | 4 |
| Claire Yung | c****4@v****l | 3 |
| James Munroe | j****e@m****a | 3 |
| Christina Schmidt | 3****a | 3 |
| James Munroe | j****4@g****u | 2 |
| Claire Yung | c****4@v****l | 2 |
| Wilton Aguiar | 7****r | 2 |
| jemmajeffree | 9****e | 2 |
| Hannah | 6****n | 2 |
| Fabio Boeira Dias | f****d@g****m | 2 |
| Felipe Vilela da Silva | f****a@a****r | 1 |
| Abhishek Savita | a****4@g****u | 1 |
| Abhishek Savita | a****4@v****l | 1 |
| and 19 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 173
- Total pull requests: 372
- Average time to close issues: over 1 year
- Average time to close pull requests: about 1 month
- Total issue authors: 38
- Total pull request authors: 39
- Average comments per issue: 4.05
- Average comments per pull request: 5.94
- Merged pull requests: 274
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 53
- Pull requests: 114
- Average time to close issues: about 1 month
- Average time to close pull requests: 11 days
- Issue authors: 19
- Pull request authors: 15
- Average comments per issue: 2.49
- Average comments per pull request: 4.61
- Merged pull requests: 92
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- navidcy (51)
- adele-morrison (36)
- AndyHoggANU (12)
- anton-seaice (7)
- rbeucher (6)
- aidanheerdegen (5)
- julia-neme (4)
- claireyung (4)
- charles-turner-1 (4)
- jmunroe (4)
- aekiss (3)
- schmidt-christina (3)
- taimoorsohail (3)
- dougiesquire (2)
- wghuneke (2)
Pull Request Authors
- navidcy (120)
- rbeucher (76)
- charles-turner-1 (34)
- anton-seaice (22)
- julia-neme (15)
- angus-g (13)
- adele-morrison (12)
- marc-white (11)
- AndyHoggANU (7)
- lidefi87 (5)
- claireyung (4)
- ashjbarnes (4)
- micaeljtoliveira (4)
- edoddridge (3)
- chrisb13 (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 8
proxy.golang.org: github.com/cosima/cosima-recipes
- Documentation: https://pkg.go.dev/github.com/cosima/cosima-recipes#section-documentation
- License: apache-2.0
-
Latest release: v0.1.3
published 6 months ago
Rankings
proxy.golang.org: github.com/COSIMA/cosima-recipes
- Documentation: https://pkg.go.dev/github.com/COSIMA/cosima-recipes#section-documentation
- License: apache-2.0
-
Latest release: v0.1.3
published 6 months ago
Rankings
Dependencies
- sphinx *
- sphinx-nbexamples *
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite