Split Tutorials into Basics+Advanced and move all recipes one directory level up (COSIMA#606)

* restucture

* fix docs

* fix docs

* restucture

* aus spelling!

* some more restructure

* Improve formatting in README.md

Updated formatting for tutorial and recipe sections in README.

* tweaks

* split lessons

* split lessons

* split lessons

* split lessons

* split lessons

* split lessons

* fix dir names

* split lessons

* fix url

* fix dir names

* not a notebook, a recipe

* relabel some dishes

* move images in mains

* remove cookbook refs

* restructure readme

* exclude READMEs

* rename

* fix icons

* simpler title

* try to shorten the title

* more short titles for toc

* restructure docs

* more short titles for toc

* sections in toc

* rename

* rename landing tutorial

* change depth for lessons toc

* change depth for lessons toc

* add icon for dask-intake tutorial

Author: navidcy

.github/workflows/sphinx.yml

@@ -29,6 +29,8 @@ jobs:
           sudo apt-get install -y pandoc
       - name: Ensure sphinx builds (warnings allowed)
         run: |
-          cp -r Recipes/ docs/
-          cp -r Cooking-Lessons-101-Tutorials/ docs/
+          cp -r 01-Cooking-Lessons-101/ docs/
+          cp -r 02-Appetisers/ docs/
+          cp -r 03-Mains/ docs/
+          cp -r 04-Local-Dishes/ docs/
           make -C docs html O=-n

.readthedocs.yml

@@ -12,8 +12,10 @@ build:
     python: "3"
   jobs:
     post_checkout:
-      - cp -r Recipes/ docs/
-      - cp -r Cooking-Lessons-101-Tutorials/ docs/
+      - cp -r 01-Cooking-Lessons-101/ docs/
+      - cp -r 02-Appetisers/ docs/
+      - cp -r 03-Mains/ docs/
+      - cp -r 04-Local-Dishes/ docs/
 
 python:
   install:

Cooking-Lessons-101-Tutorials/COSIMA_CookBook_Tutorial.ipynb renamed to 01-Cooking-Lessons-101/01-Basics/01-Loading-Slicing-Dicing-Output.ipynb

@@ -4,14 +4,16 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# How to use the COSIMA Cookbook\n",
+    "# Introduction: loading, slicing, dicing model output\n",
     "\n",
-    "This tutorial is designed to help new users get to grips with the COSIMA Cookbook. The COSIMA Cookbook collection of recipes for analysing ocean and sea ice model output, using a common method of loading the output.\n",
+    "This tutorial is designed to help new users get to grips with the COSIMA Cookbook.\n",
     "\n",
-    "It assumes that:\n",
-    " * You have access to the ACCESS-NRI Intake Catalog (through project `xp65`).\n",
-    " * You can fire up a Jupyter notebook on NCI's ARE.\n",
-    " * You can access an appropriate set of `conda` packages to load the appropriate python libraries (such as through the `hh5` conda packages, which I've used here)."
+    "The COSIMA Cookbook is collection of recipes for analysing ocean and sea ice model output, using a common method of loading the output.\n",
+    "\n",
+    "The tutorial requires:\n",
+    " * Access to the ACCESS-NRI Intake Catalog (through project `xp65`).\n",
+    " * Ability to open a Jupyter notebook on the NCI's Gadi HPC (e.g., via the ARE).\n",
+    " * Access an appropriate set of `conda` packages to load the appropriate python libraries (such as through the `xp65` conda packages)."
    ]
   },
   {
@@ -2464,7 +2466,7 @@
     "We often perform operations such as averaging on dataarrays. Again, knowledge of the coordinates can be a big help here, as you can instruct the `mean()` method to operate along given coordinates. The case below takes a temporal and zonal average of potential density.\n",
     "\n",
     "#### IMPORTANT\n",
-    "To be precise, it is actually a mean in the $i$-grid direction, which is only zonal outside the tripolar region in the Arctic, i.e., *south of 65N* in the ACCESS-OM2 models. To compute the zonal mean correctly one needs to be a bit more careful; see [`Recipes/True_Zonal_Mean.ipynb`](https://cosima-recipes.readthedocs.io/en/latest/Recipes/True_Zonal_Mean.html)."
+    "To be precise, it is actually a numerical mean in the $i$-grid direction, which is only zonal outside the tripolar region in the Arctic, i.e., *south of 65N* in the ACCESS-OM2 models. To compute the zonal mean correctly one needs to be a bit more careful; see [`02-Appetisers/True_Zonal_Mean.ipynb`](https://cosima-recipes.readthedocs.io/en/latest/02-Appetisers/True_Zonal_Mean.html)."
    ]
   },
   {
@@ -2576,19 +2578,21 @@
    "source": [
     "## 3. More Advanced Stuff\n",
     "\n",
-    "### 3.1 Making a map with cartopy\n",
-    "The maps shown in this tutorial are not publication quality, are missing coastlines and in fact distort data in the Arctic (due to the tripole grid used there). We suggest going through the [`Tutorials/Making_Maps_with_Cartopy`](https://cosima-recipes.readthedocs.io/en/latest/Tutorials/Making_Maps_with_Cartopy.html) tutorial."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
+    "### 3.1 Maps with cartopy\n",
+    "The maps shown in this tutorial are not publication quality, are missing coastlines and in fact distort data in the Arctic (due to the tripole grid used there). We suggest going through the [`Maps_with_Cartopy`](https://cosima-recipes.readthedocs.io/en/latest/01-Cooking-Lessons-101/01-Basics/Making_Maps_with_Cartopy.html) tutorial.\n",
+    "\n",
     "### 3.2 Distributed computing\n",
     "\n",
     "Many of our recipes use multiple cores for their calculations, usually via the using `dask` to set up a local cluster on your node for distributed computation. "
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
   {
    "cell_type": "code",
    "execution_count": 18,
@@ -4908,9 +4912,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:analysis3-unstable]",
+   "display_name": "Python [conda env:analysis3-25.08] *",
    "language": "python",
-   "name": "conda-env-analysis3-unstable-py"
+   "name": "conda-env-analysis3-25.08-py"
   },
   "language_info": {
    "codemirror_mode": {

Cooking-Lessons-101-Tutorials/ACCESS-NRI_Intake_Catalog.ipynb renamed to 01-Cooking-Lessons-101/01-Basics/02-ACCESS-NRI_Intake_Catalog.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# How to use the ACCESS-NRI Intake catalog to load model output"
+    "# ACCESS-NRI Intake catalog for loading model output"
    ]
   },
   {
@@ -19,14 +19,14 @@
     "\n",
     "This is a concise version of the longer [ACCESS-NRI Intake catalog documentation](https://access-nri-intake-catalog.readthedocs.io/) and related [COSIMA training workshop](https://github.com/ACCESS-Hive/cosima-training-workshop-2023/blob/main/Intake.ipynb). Users are encouraged to refer to these for more detail and demonstrations.\n",
     "\n",
-    "Requirements: The `conda/analysis3` (tested on `analysis3-23.07`) module from `/g/data/hh5/public/modules`. "
+    "Requirements: The `conda/analysis3` module from `/g/data/xp65/public/modules`. "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Too Long; Didn't Read: \n"
+    "### Too Long; Didn't Read: "
    ]
   },
   {
@@ -7966,9 +7966,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python [conda env:analysis3_edge-25.08]",
    "language": "python",
-   "name": "python3"
+   "name": "conda-env-analysis3_edge-25.08-py"
   },
   "language_info": {
    "codemirror_mode": {
@@ -7980,7 +7980,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.9"
+   "version": "3.11.13"
   }
  },
  "nbformat": 4,

Cooking-Lessons-101-Tutorials/Making_Maps_with_Cartopy.ipynb renamed to 01-Cooking-Lessons-101/01-Basics/03-Maps_with_Cartopy.ipynb

@@ -7,11 +7,11 @@
     "tags": []
    },
    "source": [
-    "# Making Maps with Cartopy\n",
+    "# Maps with Cartopy\n",
     "\n",
     "This tutorial runs through a series of examples that demonstrate how to make maps using data from the Intake Catalog. This tutorial focusses on mapping with `Cartopy`.\n",
     "\n",
-    "Note that these examples are just to give you ideas of how you might be able to make nice maps, but you should expect to adjust and modify to your own use case.\n"
+    "Note that these examples are just to give you ideas of how you might be able to make nice maps, but you should expect to adjust and modify to your own use case."
    ]
   },
   {