From 2da1e6b55219fa3e31bff05df25866a97fc08582 Mon Sep 17 00:00:00 2001 From: flicj191 Date: Mon, 18 Dec 2023 11:58:17 +1100 Subject: [PATCH 1/4] create tutorials tab --- docs/tutorials/esmvaltool.md | 5 +++++ docs/tutorials/ilamb.md | 2 ++ docs/tutorials/index.md | 16 ++++++++++++++++ docs/tutorials/intake.md | 4 ++++ docs/tutorials/models.md | 5 +++++ docs/tutorials/payu.md | 3 +++ mkdocs.yml | 19 +++++++++++++------ 7 files changed, 48 insertions(+), 6 deletions(-) create mode 100644 docs/tutorials/esmvaltool.md create mode 100644 docs/tutorials/ilamb.md create mode 100644 docs/tutorials/index.md create mode 100644 docs/tutorials/intake.md create mode 100644 docs/tutorials/models.md create mode 100644 docs/tutorials/payu.md diff --git a/docs/tutorials/esmvaltool.md b/docs/tutorials/esmvaltool.md new file mode 100644 index 000000000..4bd9d2657 --- /dev/null +++ b/docs/tutorials/esmvaltool.md @@ -0,0 +1,5 @@ +## 2023 video series +- Video series + +## 2023 ACCESS workshop + - Working with ESMValTool \ No newline at end of file diff --git a/docs/tutorials/ilamb.md b/docs/tutorials/ilamb.md new file mode 100644 index 000000000..f104f9ffd --- /dev/null +++ b/docs/tutorials/ilamb.md @@ -0,0 +1,2 @@ +## 2023 ACCESS workshop +- Working with ILAMB \ No newline at end of file diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 000000000..e86c31ea7 --- /dev/null +++ b/docs/tutorials/index.md @@ -0,0 +1,16 @@ +# Training and Tutorials + +This space is intended to colate training materials created by ACCESS-NRI. +The training material can be directly relevant to ACCESS and its model components, such as: + +- using coupled models and model components +- using configurations +- using model evaluation tools and workflows + +It is also intended for training material around more peripheral topics that are essential for the community, such as: + +- HPC +- version control +- essential software packages + +ACCESS-NRI encourages the members of the community to [contact us](mailto:access.nri@anu.edu.au) to share their suggestions. diff --git a/docs/tutorials/intake.md b/docs/tutorials/intake.md new file mode 100644 index 000000000..8127dd54e --- /dev/null +++ b/docs/tutorials/intake.md @@ -0,0 +1,4 @@ +## 2023 ACCESS workshop +1. Getting set up on the ARE +2. Using the ACCESS-NRI Intake catalog +3. Indexing a new model run \ No newline at end of file diff --git a/docs/tutorials/models.md b/docs/tutorials/models.md new file mode 100644 index 000000000..3fdefb1af --- /dev/null +++ b/docs/tutorials/models.md @@ -0,0 +1,5 @@ +## 2023 ACCESS workshop +1. Running ACCESS-CM2 from ARE/Gadi +2. Changing a suite run length +3. Changing model physics options +4. Troubleshooting example \ No newline at end of file diff --git a/docs/tutorials/payu.md b/docs/tutorials/payu.md new file mode 100644 index 000000000..2d5a88a60 --- /dev/null +++ b/docs/tutorials/payu.md @@ -0,0 +1,3 @@ +## Tutorial coming Jan 2024 + +- diff --git a/mkdocs.yml b/mkdocs.yml index 5ff66aae6..a97374d60 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -148,6 +148,13 @@ nav: # - Live-Diagnostics on Gadi: model_evaluation/model_evaluation_live_diagnostics.md # - Evaluation Recipe Gallery: model_evaluation/model_evaluation_recipe_gallery.md + - Tutorials: + - tutorials/index.md + - ESMValTool: tutorials/esmvaltool.md + - ILAMB: tutorials/ilamb.md + - ACCESS-NRI intake Catalogue: tutorials/intake.md + - ACCESS Models: tutorials/models.md + - Payu: tutorials/payu.md - Community Resources: - community_resources/index.md # TEMPORARY for Workshop @@ -166,12 +173,12 @@ nav: - Evaluation Recipes: community_resources/community_med/community_med_recipes.md - Glossaries: community_resources/glossaries.md # - Training: - # - Training: community_resources/training/index.md - # - Git Version Control: community_resources/training/git-version-control.md - # - High Performance Computing (HPC): community_resources/training/hpc.md - # - ACCESS Training: community_resources/training/ACCESS_training.md - # - NCI Training: community_resources/training/nci-training.md - # - Additional Training: community_resources/training/additional_training.md + # - Training: drafts/training/index.md + # - Git Version Control: drafts/training/git-version-control.md + # - High Performance Computing (HPC): drafts/training/hpc.md + # - ACCESS Training: drafts/training/ACCESS_training.md + # - NCI Training: drafts/training/nci-training.md + # - Additional Training: drafts/training/additional_training.md - About: - about/index.md - Contact: about/contact.md From 05c27635848f8501ed7c6f896ca2e0e6052e272e Mon Sep 17 00:00:00 2001 From: flicj191 Date: Wed, 20 Dec 2023 15:18:53 +1100 Subject: [PATCH 2/4] edit intros and order --- docs/tutorials/esmvaltool.md | 8 +++++++- docs/tutorials/ilamb.md | 2 ++ docs/tutorials/intake.md | 2 ++ docs/tutorials/models.md | 2 ++ docs/tutorials/payu.md | 2 ++ mkdocs.yml | 5 +++-- 6 files changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/esmvaltool.md b/docs/tutorials/esmvaltool.md index 4bd9d2657..3ab1d8d66 100644 --- a/docs/tutorials/esmvaltool.md +++ b/docs/tutorials/esmvaltool.md @@ -1,5 +1,11 @@ +The Earth System Model Evaluation Tool (ESMValTool) is a tool developed for evaluation of Earth System Models in CMIP (Climate Model Intercomparison Projects). See here for an introduction and information for usage on Gadi. + ## 2023 video series -- Video series +1. What is ESMValTool? +2. ESMValTool - NCI quickstart guide +3. ESMValTool - The config user file +4. Understanding ESMValTool recipes +5. ESMValTool: Write your own recipes and diagnostics ## 2023 ACCESS workshop - Working with ESMValTool \ No newline at end of file diff --git a/docs/tutorials/ilamb.md b/docs/tutorials/ilamb.md index f104f9ffd..63f20e71f 100644 --- a/docs/tutorials/ilamb.md +++ b/docs/tutorials/ilamb.md @@ -1,2 +1,4 @@ +The International Land Model Benchmarking (ILAMB) benchmarking system is a python framework used to quantitatively compare a defined set of observable variables with a number of land models. For an introduction, see here. + ## 2023 ACCESS workshop - Working with ILAMB \ No newline at end of file diff --git a/docs/tutorials/intake.md b/docs/tutorials/intake.md index 8127dd54e..ba424ba05 100644 --- a/docs/tutorials/intake.md +++ b/docs/tutorials/intake.md @@ -1,3 +1,5 @@ +The ACCESS-NRI Intake catalog aims to provide a way for Python users to discover and load data across a broad range of climate data products available on *Gadi*. For an introduction, start here. + ## 2023 ACCESS workshop 1. Getting set up on the ARE 2. Using the ACCESS-NRI Intake catalog diff --git a/docs/tutorials/models.md b/docs/tutorials/models.md index 3fdefb1af..1300a0b26 100644 --- a/docs/tutorials/models.md +++ b/docs/tutorials/models.md @@ -1,3 +1,5 @@ +For an intoduction on how to run a model see here. + ## 2023 ACCESS workshop 1. Running ACCESS-CM2 from ARE/Gadi 2. Changing a suite run length diff --git a/docs/tutorials/payu.md b/docs/tutorials/payu.md index 2d5a88a60..70117c89f 100644 --- a/docs/tutorials/payu.md +++ b/docs/tutorials/payu.md @@ -1,3 +1,5 @@ +Payu is used in the run of ACCESS-OM + ## Tutorial coming Jan 2024 - diff --git a/mkdocs.yml b/mkdocs.yml index a97374d60..4ef28ef69 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -150,11 +150,12 @@ nav: - Tutorials: - tutorials/index.md + - ACCESS-CM2 Model: tutorials/models.md + - ACCESS-NRI intake Catalogue: tutorials/intake.md - ESMValTool: tutorials/esmvaltool.md - ILAMB: tutorials/ilamb.md - - ACCESS-NRI intake Catalogue: tutorials/intake.md - - ACCESS Models: tutorials/models.md - Payu: tutorials/payu.md + - Community Resources: - community_resources/index.md # TEMPORARY for Workshop From 5291b9f3d4885e78bea2426ef7125949f6f6578a Mon Sep 17 00:00:00 2001 From: flicj191 Date: Thu, 18 Jan 2024 10:24:34 +1100 Subject: [PATCH 3/4] remove date in payu tutorial --- docs/tutorials/payu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/payu.md b/docs/tutorials/payu.md index 70117c89f..ee6fb4d4e 100644 --- a/docs/tutorials/payu.md +++ b/docs/tutorials/payu.md @@ -1,5 +1,5 @@ Payu is used in the run of ACCESS-OM -## Tutorial coming Jan 2024 +## Tutorial coming - From 4d32c610831264b9f19f49ad62ab20de5aa48286 Mon Sep 17 00:00:00 2001 From: flicj191 Date: Thu, 18 Jan 2024 11:09:39 +1100 Subject: [PATCH 4/4] update tutorial landing page --- docs/tutorials/index.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index e86c31ea7..edb92e8a9 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -7,10 +7,4 @@ The training material can be directly relevant to ACCESS and its model component - using configurations - using model evaluation tools and workflows -It is also intended for training material around more peripheral topics that are essential for the community, such as: - -- HPC -- version control -- essential software packages - -ACCESS-NRI encourages the members of the community to [contact us](mailto:access.nri@anu.edu.au) to share their suggestions. +ACCESS-NRI encourages the members of the community to contact us to share their suggestions.