Skip to content

Categorise recipes + rename recipes and tutorials to dishes and cooking lessons #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Jun 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
# 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)](http://cosima.org.au/).
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)](http://cosima.org.au/).

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 📒!
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](https://doi.org/10.5194/gmd-13-401-2020), while some also use results from configurations of the [Modular Ocean Model 6 (MOM6)](https://github.com/mom-ocean/MOM6) and remote sensing observations.

Expand Down
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@
# a list of builtin themes.
#
# html_theme = 'default'
html_theme_options = {
"sidebar_collapse": False,
"sidebar_includehidden": False,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
3 changes: 1 addition & 2 deletions docs/guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ format for the other entries already in there.
Images in notebooks
-------------------

If including external images (i.e. not plots generated in the code) in
If including external images (i.e., not plots generated in the code) in
notebooks, place them in the ``images/`` directory next to the
notebook. Use the syntax ``![image caption](images/image.png)`` to
include the image in the notebook.

15 changes: 7 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.


COSIMA Cookbook
===============

Expand All @@ -16,20 +17,18 @@ All the recipes combined form a cookbook 📒!

Happy cooking! 😉 🥙 🍱 🍲

To get started have a look at the tutorials_ and then browse through the
available recipes_ to find something the better suits your 'taste' (i.e., your needs)!
The `COSIMA Cookbook tutorial`_ is perhaps the best place to start.
To get started you should first take the :doc:`Cooking Lessons 101 <tutorials>` (i.e., our Tutorials).
After you've gone through them and feel comfortable, browse through the
available :doc:`recipes/index` (i.e., examples) to find something the better suits your 'taste' (i.e., your needs)!

.. _tutorials: tutorials.html
.. _recipes: recipes.html
.. _COSIMA Cookbook tutorial: https://cosima-recipes.readthedocs.io/en/latest/Tutorials/COSIMA_CookBook_Tutorial.html
The :doc:`COSIMA Cookbook tutorial <Tutorials/COSIMA_CookBook_Tutorial>` is perhaps the best place to start.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Contents:

tutorials
recipes
recipes/index
guidelines
contributing
GitHub Repository <https://github.com/cosima/cosima-recipes>
Expand Down
10 changes: 0 additions & 10 deletions docs/recipes.rst

This file was deleted.

9 changes: 9 additions & 0 deletions docs/recipes/appetisers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Appetisers (easy)
=================

.. nbgallery::
:name: recipe-gallery-appetisers
:glob:
:hidden:

../Recipes/appetisers-easy/*
13 changes: 13 additions & 0 deletions docs/recipes/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Recipes
=======

The recipes are split into :doc:`appetisers` (i.e., easier/simpler recipes -- a good place
to start after you've been through the :doc:`../tutorials`), :doc:`mains` (i.e. elaborate/advanced recipes)
and :doc:`local-dishes` (i.e. recipes for regional configurations).

.. toctree::
:maxdepth: 1

appetisers
mains
local-dishes
9 changes: 9 additions & 0 deletions docs/recipes/local-dishes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Local dishes (Regional configurations)
======================================

.. nbgallery::
:name: recipe-gallery-regional
:glob:
:hidden:

../Recipes/local-dishes-regional/*
9 changes: 9 additions & 0 deletions docs/recipes/mains.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Main dishes (advanced)
======================

.. nbgallery::
:name: recipe-gallery-mains
:glob:
:hidden:

../Recipes/mains-advanced/*
5 changes: 2 additions & 3 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Tutorials
=========
Cooking lessons 101 (Tutorials)
===============================

.. nbgallery::
:caption: Tutorials
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nice catch - harmonising and simplifying the look. 👍

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:)

:name: tutorial-gallery
:glob:
:hidden:
Expand Down