Skip to content

Rename Tutorials directory #532

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 15 commits into from
Jun 19, 2025
Merged
Show file tree
Hide file tree
Changes from 7 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
2 changes: 1 addition & 1 deletion .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ jobs:
- name: Ensure sphinx builds (warnings allowed)
run: |
cp -r Recipes/ docs/
cp -r Tutorials/ docs/
cp -r Cooking-Lessons-101-Tutorials/ docs/
make -C docs html O=-n
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ local_cc_test.db-journal
dask-worker-space/

docs/_build/
docs/DocumentedExamples/
docs/Tutorials/
docs/Recipes/
docs/Cooking-Lessons-101-Tutorials/

**/SWMT_temp/
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ build:
jobs:
post_checkout:
- cp -r Recipes/ docs/
- cp -r Tutorials/ docs/
- cp -r Cooking-Lessons-101-Tutorials/ docs/

python:
install:
Expand Down
9 changes: 9 additions & 0 deletions Cooking-Lessons-101-Tutorials/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
‼️ ⚠️ **Warning** ⛔️ 🚨

Seems that you are about to view a cooking lesson (i.e. a tutorial) using Github's native Jupyter notebook viewer...

This is **NOT** the best way to view a recipes or cooking lessons; you won't be getting the best possible experience via Github's native Jupyter notebook viewer.

We'd strongly urge you to browse through the recipes or cooking lessons is via the website:

https://cosima-recipes.readthedocs.io/en/latest/cooking-lessons-101.html
File renamed without changes
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ Hence, users who put together a pull request for a new contribution, should ensu

## Contents

### [Tutorials](https://cosima-recipes.readthedocs.io/en/latest/tutorials.html)
### [Cooking Lessons 101 (Tutorials)](https://cosima-recipes.readthedocs.io/en/latest/cooking-lessons-101.html)

The starting point should be the [COSIMA_CookBook_Tutorial](https://cosima-recipes.readthedocs.io/en/latest/Tutorials/COSIMA_CookBook_Tutorial.html) that showcases how we can use Intake catalog to interrogate about available output and load them. The [ACCESS-NRI_Intake_Catalog](https://cosima-recipes.readthedocs.io/en/latest/Tutorials/ACCESS-NRI_Intake_Catalog.html) 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!)
The starting point should be the [COSIMA_CookBook_Tutorial](https://cosima-recipes.readthedocs.io/en/latest/Cooking-Lessons-101-Tutorials/COSIMA_CookBook_Tutorial.html) that showcases how we can use Intake catalog to interrogate about available output and load them. The [ACCESS-NRI_Intake_Catalog](https://cosima-recipes.readthedocs.io/en/latest/Cooking-Lessons-101-Tutorials/ACCESS-NRI_Intake_Catalog.html) 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](https://cosima-recipes.readthedocs.io/en/latest/Tutorials/Making_Maps_with_Cartopy.html)) or tools (e.g., [Model Agnostic Analysis](https://cosima-recipes.readthedocs.io/en/latest/Tutorials/Model_Agnostic_Analysis.html)).
Also included here are some other tutorials, related to techniques (e.g., [Making_Maps_with_Cartopy.ipynb](https://cosima-recipes.readthedocs.io/en/latest/Cooking-Lessons-101-Tutorials/Making_Maps_with_Cartopy.html)) or tools (e.g., [Model Agnostic Analysis](https://cosima-recipes.readthedocs.io/en/latest/Cooking-Lessons-101-Tutorials/Model_Agnostic_Analysis.html)).


### [Recipes](https://cosima-recipes.readthedocs.io/en/latest/recipes.html)
Expand Down Expand Up @@ -82,4 +82,3 @@ We request that users of ACCESS-OM2 model [code](https://github.com/access-nri/a
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](https://zenodo.org/badge/DOI/10.5281/zenodo.14353852.svg)](https://doi.org/10.5281/zenodo.14353852)

11 changes: 8 additions & 3 deletions Recipes/README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
Documented Examples
===================
‼️ ⚠️ **Warning** ⛔️ 🚨

These are some examples of what you can do with the COSIMA Cookbook
Seems that you are about to view a recipe using Github's native Jupyter notebook viewer...

This is **NOT** the best way to view a recipe; you won't be getting the best possible experience via Github's native Jupyter notebook viewer.

We'd strongly urge you to browse through the recipes is via the website:

https://cosima-recipes.readthedocs.io/en/latest/recipes/index.html
4 changes: 0 additions & 4 deletions Tutorials/README.rst

This file was deleted.

12 changes: 6 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
exclude_patterns = [
'_build', 'Thumbs.db', '.DS_Store',
'Recipes/README.rst', 'Tutorials/README.rst',
'Tutorials/Template_For_Notebooks.ipynb'
'Cooking-Lessons-101-Tutorials/Template_For_Notebooks.ipynb'
]


Expand All @@ -66,9 +66,9 @@

nbsphinx_execute = "never"
nbsphinx_thumbnails = {
"Tutorials/ACCESS-NRI_Intake_Catalog": "_static/thumbnails/intake.png",
"Tutorials/Make_Your_Own_Database": "_static/thumbnails/database.png",
"Tutorials/Submitting_analysis_jobs_to_gadi": "_static/thumbnails/gadi.png",
"Tutorials/Using_Explorer_tools": "_static/thumbnails/explore.png",
"Tutorials/COSIMA_CookBook_Tutorial": "_static/thumbnails/cookbook.png",
"Cooking-Lessons-101-Tutorials/ACCESS-NRI_Intake_Catalog": "_static/thumbnails/intake.png",
"Cooking-Lessons-101-Tutorials/Make_Your_Own_Database": "_static/thumbnails/database.png",
"Cooking-Lessons-101-Tutorials/Submitting_analysis_jobs_to_gadi": "_static/thumbnails/gadi.png",
"Cooking-Lessons-101-Tutorials/Using_Explorer_tools": "_static/thumbnails/explore.png",
"Cooking-Lessons-101-Tutorials/COSIMA_CookBook_Tutorial": "_static/thumbnails/cookbook.png",
}
9 changes: 9 additions & 0 deletions docs/cooking-lessons-101.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Cooking Lessons 101 (Tutorials)
===============================

.. nbgallery::
:name: cooking-lessons-101-gallery
:glob:
:hidden:

Cooking-Lessons-101-Tutorials/*
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ All the recipes combined form a cookbook 📒!

Happy cooking! 😉 🥙 🍱 🍲

To get started you should first take the :doc:`Cooking Lessons 101 <tutorials>` (i.e., our Tutorials).
To get started you should first take the :doc:`Cooking Lessons 101 <cooking-lessons-101>` (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)!

The :doc:`COSIMA Cookbook tutorial <Tutorials/COSIMA_CookBook_Tutorial>` is perhaps the best place to start.
The :doc:`COSIMA Cookbook tutorial <Cooking-Lessons-101-Tutorials/COSIMA_CookBook_Tutorial>` is perhaps the best place to start.

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

tutorials
cooking-lessons-101
recipes/index
guidelines
contributing
Expand Down
2 changes: 1 addition & 1 deletion docs/recipes/appetisers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Appetisers (easy)
:glob:
:hidden:

../Recipes/appetisers-easy/*
../Recipes/Appetisers-Easy/*
2 changes: 1 addition & 1 deletion docs/recipes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ 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)
to start after you've been through the :doc:`../cooking-lessons-101`), :doc:`mains` (i.e. elaborate/advanced recipes)
and :doc:`local-dishes` (i.e. recipes for regional configurations).

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/recipes/local-dishes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Local dishes (Regional configurations)
:glob:
:hidden:

../Recipes/local-dishes-regional/*
../Recipes/Local-Dishes-regional/*
2 changes: 1 addition & 1 deletion docs/recipes/mains.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Main dishes (advanced)
:glob:
:hidden:

../Recipes/mains-advanced/*
../Recipes/Mains-Advanced/*
9 changes: 0 additions & 9 deletions docs/tutorials.rst

This file was deleted.