Better names for Examples (#418)

* rename * renaming * update notebook title * rename
COSIMA · Jul 10, 2024 · 697e230 · 697e230
1 parent 8e0bba3
commit 697e230
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 21 deletions.
diff --git a/...ropic_Streamfunction_model_agnostic.ipynb → Examples/Barotropic_Streamfunction.ipynb b/...ropic_Streamfunction_model_agnostic.ipynb → Examples/Barotropic_Streamfunction.ipynb
@@ -7,7 +7,7 @@
     "tags": []
    },
    "source": [
-    "# Barotropic Streamfunction in MOM5/MOM6\n",
+    "# Barotropic Streamfunction\n",
     "\n",
     "The barotropic streamfunction ($\\psi$) is obtained from the integration of the velocity field starting from a physical boundary at which we know the transport is zero. The difference between to streamlines is a measure of the transport between them. \n",
     "\n",

diff --git a/...etic_energy_into_mean_and_transient.ipynb → ...y-Mean_Kinetic_Energy_Decomposition.ipynb b/...etic_energy_into_mean_and_transient.ipynb → ...y-Mean_Kinetic_Energy_Decomposition.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Kinetic Energy Mean-Transient Decomposition\n",
+    "# Eddy-mean kinetic energy decomposition\n",
     "\n",
     "Decomposing the kinetic energy into time-mean and transient components."
    ]
@@ -1807,9 +1807,9 @@
    }
   },
   "kernelspec": {
-   "display_name": "Python [conda env:analysis3-20.01]",
+   "display_name": "Python [conda env:analysis3-24.01]",
    "language": "python",
-   "name": "conda-env-analysis3-20.01-py"
+   "name": "conda-env-analysis3-24.01-py"
   },
   "language_info": {
    "codemirror_mode": {
@@ -1821,7 +1821,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.10.13"
   },
   "thumbnail_figure": 1
  },

diff --git a/Examples/Age_at_the_Bottom.ipynb → ...s/Extract_Variables_at_Ocean_Bottom.ipynb b/Examples/Age_at_the_Bottom.ipynb → ...s/Extract_Variables_at_Ocean_Bottom.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Age at the Bottom of the Ocean\n",
+    "# Extract variables at bottom of ocean: an example with Age\n",
     "\n",
     "This notebook shows a simple example of plotting ocean Ideal Age. Ideal Age is a fictitious tracer which is set to zero in the surface grid-cell every timestep, and is aged by 1 year per year otherwise. It is a useful proxy for nutrients, such as carbon or oxygen (but not an exact analogue). \n",
     "\n",
@@ -4237,7 +4237,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:analysis3-22.10]",
+   "display_name": "Python [conda env:analysis3-22.10] *",
    "language": "python",
    "name": "conda-env-analysis3-22.10-py"
   },

diff --git a/..._Meridional_Overturning_Circulation.ipynb → .../Meridional_Overturning_Circulation.ipynb b/..._Meridional_Overturning_Circulation.ipynb → .../Meridional_Overturning_Circulation.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Zonally Averaged Overturning Circulation\n",
+    "# Meridional Overturning Circulation\n",
     "\n",
     "This notebook shows a simple example of calculation the zonally averaged global meridional overturning circulation - in density space - using output from either `MOM5` or `MOM6`.\n",
     "\n",

diff --git a/Examples/NearestNeighbourDistance.ipynb → Examples/Nearest_Neighbour_Distance.ipynb b/Examples/NearestNeighbourDistance.ipynb → Examples/Nearest_Neighbour_Distance.ipynb
@@ -5,7 +5,8 @@
    "id": "d5a466a9-0be2-48ea-8648-49ad2c97a359",
    "metadata": {},
    "source": [
-    "# Calculating pairwise distances between a contour and every grid cell\n",
+    "# Calculate pairwise distances between a contour and grid cells\n",
+    "\n",
     "In this notebook, we will demonstrate how to calculate the distance from every grid cell to the nearest grid cell along a contour. We will demonstrate this by computing the distance from each grid cell in a data array to the sea ice edge. We will use monthly sea ice concentration from ACCESS-OM2-01 over the Southern Ocean to perform these calculations.  \n",
     "  \n",
     "*Useful definitions*  \n",
@@ -2091,7 +2092,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:analysis3-22.10]",
+   "display_name": "Python [conda env:analysis3-22.10] *",
    "language": "python",
    "name": "conda-env-analysis3-22.10-py"
   },

diff --git a/Examples/SeaIce_Obs_Model_Compare.ipynb → ..._Area_Concentration_Volume_with_Obs.ipynb b/Examples/SeaIce_Obs_Model_Compare.ipynb → ..._Area_Concentration_Volume_with_Obs.ipynb
@@ -4577,7 +4577,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -5077,7 +5076,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.13"
+   "version": "3.9.15"
   }
  },
  "nbformat": 4,

diff --git a/Examples/SeaIce_Plot_Example.ipynb → Examples/Sea_Ice_Coordinates.ipynb b/Examples/SeaIce_Plot_Example.ipynb → Examples/Sea_Ice_Coordinates.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Sea ice plotting examples"
+    "# Sea ice coordinates"
    ]
   },
   {
@@ -2287,7 +2287,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,

diff --git a/Examples/SeaIceSeasonality_DFA.ipynb → ...ples/Sea_Ice_Seasonality_Statistics.ipynb b/Examples/SeaIceSeasonality_DFA.ipynb → ...ples/Sea_Ice_Seasonality_Statistics.ipynb
@@ -4,8 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Sea ice seasonality in the Southern Ocean\n",
-    "This script calculates days of sea ice advance, retreat, and total sea ice duration over the sea ice season (February 15 to February 14) in the Southern Ocean using outputs from ACCESS-OM2-01.  \n",
+    "# Sea ice seasonality statistics: an example in the Southern Ocean\n",
+    "\n",
+    "This notebook calculates days of sea ice advance, retreat, and total sea ice duration over the sea ice season (February 15 to February 14) in the Southern Ocean using outputs from ACCESS-OM2-01.  \n",
+    "\n",
     "**Requirements:** It is suggested you use the `conda/analysis3-20.01` (or later) kernel. This can be defined using the drop down list on the left hand corner, or type `!module load conda/analysis3` in a Python cell."
    ]
   },
@@ -1426,9 +1428,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:miniconda3-analysis3-22.07] *",
+   "display_name": "Python [conda env:analysis3-24.01]",
    "language": "python",
-   "name": "conda-env-miniconda3-analysis3-22.07-py"
+   "name": "conda-env-analysis3-24.01-py"
   },
   "language_info": {
    "codemirror_mode": {
@@ -1440,7 +1442,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.13"
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,

diff --git a/...mperatureSalinityDiagrams_mom5_mom6.ipynb → Examples/Temperature_Salinity_Diagram.ipynb b/...mperatureSalinityDiagrams_mom5_mom6.ipynb → Examples/Temperature_Salinity_Diagram.ipynb
@@ -5,7 +5,7 @@
    "id": "65fe6a4e-f751-40c3-80ed-12c66e728784",
    "metadata": {},
    "source": [
-    "# Temperature Salinity Diagram"
+    "# Temperature-Salinity Diagram"
    ]
   },
   {
@@ -940,7 +940,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,

diff --git a/...ion_from_depth_to_potential_density.ipynb → ...ion_from_Depth_to_Potential_Density.ipynb b/...ion_from_depth_to_potential_density.ipynb → ...ion_from_Depth_to_Potential_Density.ipynb