diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json
index 704c73023..94a670688 100644
--- a/.github/workflows/mlc_config.json
+++ b/.github/workflows/mlc_config.json
@@ -9,9 +9,6 @@
{
"pattern": "linkedin.com"
},
- {
- "pattern": "https://opus.nci.org.au/display/Help/ARE+User+Guide"
- },
{
"pattern": "^http://www.bom.gov.au"
}
diff --git a/README.md b/README.md
index 6de839851..39efd1907 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,42 @@
# ACCESS-Hive
-[![ACCESS-Hive Badge](docs/assets/badge.svg)](https://access-hive.org.au/)
+[![ACCESS-Hive Badge](docs/assets/badge.svg)][website]
[![github-contributors](https://img.shields.io/github/contributors/ACCESS-Hive/access-hive.github.io?color=blue&style=plastic)][github-repo]
[![forum-users](https://img.shields.io/discourse/users?color=blue&label=forum&server=https%3A%2F%2Fforum.access-hive.org.au&style=plastic)][forum]
-[![Link Check](https://github.com/ACCESS-Hive/access-hive.github.io/actions/workflows/scheduled_link_check.yml/badge.svg)](https://github.com/ACCESS-Hive/access-hive.github.io/actions/workflows/scheduled_link_check.yml)
Documentation hub for the Earth System models, ACCESS, and their community.
-This repository uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the website which accessible at this URL:
-
+This repository uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the website which accessible at this URL:
https://access-hive.org.au/
+# How to Contribute
If you wish to add documentation to the ACCESS-Hive website see the [contribution guide](https://access-hive.org.au/about/contribute/) for instructions.
-# How to Contribute [Draft TEST]
-
-- Pull the latest version of `development` branch locally by using the following commands:
+## Styling guidelines for contribution
+Please follow the guidelines below so as to make the Hive consistent among the pages contributed by different people.
+
+- Always prefer HTML syntax to Markdown when possible;
+- Titles/subtitles should NOT include: code lines/blocks, bold (titles are usually already bold), italic, links;
+- Code lines/blocks need to be used for lines/blocks of code and terminal commands;
+- Italic needs to be used when referring to specific proper nouns (for example *Gadi* or *Accessdev*);
+- Bold can be used to highlight some words (please do not overuse it);
+- Links should be coded using HTML syntax. External links (links that go to a website other than https://access-hive.org.au) need to specify `target="_blank"` (see HTML cheatsheet below);
+- To signal an important note within the text, consider using a "warning note" (see HTML cheatsheet below);
+- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see HTML cheatsheet below);
+
+
+### HTML Cheatsheet for the Hive
+|Style|HTML Syntax|Rendered example|
+|---|---|---|
+|**Bold**|\bold\|**bold**|
+|**Italic**|\italic\|*italic*|
+|**Code line**|\this is a code line\|`this is a code line`|
+|**Code block**|\
|![tabs](docs/assets/assets_for_readme/tabs.gif)|
+
+
# License
-The ACCESS-Hive site is covered by [the CC-BY 4.0 license][License].
+The ACCESS-Hive site is covered by the [CC-BY 4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode).
However, the material linked to from ACCESS-Hive is covered by various licensing agreements. Our users should directly refer to the terms and conditions of any material they are using to understand their rights and responsibilities.
-[License]: License.md
+[website]: https://access-hive.org.au
[github-repo]: https://github.com/ACCESS-Hive/access-hive.github.io.git
[forum]: https://forum.access-hive.org.au
diff --git a/docs/about/index.md b/docs/about/index.md
index be6ebc748..15f2c9900 100644
--- a/docs/about/index.md
+++ b/docs/about/index.md
@@ -19,7 +19,7 @@
Alternatively, you can login through the ARE Gadi Terminal.
@@ -81,7 +81,7 @@ You will be prompted to enter your NCI password, and then you will be connected
# - Obtain access to data without permission; ## - Damage, delete, alter or insert data without permission; ## Use of this system requires acceptance of the Conditions of Use; #
-# published at http://nci.org.au/users/nci-terms-and-conditions-access; #
+# published at https://nci.org.au/users/nci-terms-and-conditions-access; ################################################################################| gadi.nci.org.au - 260,760 processor InfiniBand x86_64 cluster |===============================================================================
@@ -257,7 +257,7 @@ For example, if you want to change your default project to `tm70` on Gadi# - Obtain access to data without permission; ## - Damage, delete, alter or insert data without permission; ## Use of this system requires acceptance of the Conditions of Use; #
-# published at http://nci.org.au/users/nci-terms-and-conditions-access; #
+# published at https://nci.org.au/users/nci-terms-and-conditions-access; ################################################################################| gadi.nci.org.au - 260,760 processor InfiniBand x86_64 cluster |===============================================================================
diff --git a/docs/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md b/docs/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md
index ffea26989..62195a69e 100644
--- a/docs/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md
+++ b/docs/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md
@@ -8,7 +8,7 @@ COSIMA is the Consortium for Ocean-Sea Ice Modelling in Australia, which brings
The COSIMA Cookbook is developed and maintained by COSIMA. While ACCESS-NRI does not own the code, it actively supports the use of the COSIMA Cookbook and its collection of cosima-recipes on Gadi.
ACCESS-NRI provides access to the latest version of COSIMA Cookbook via the `hh5` `access-med` conda environment for Model Evaluation on Gadi.
- The COSIMA Cookbook framework focuses on the [ACCESS-OM2](../../models/configurations/access-om.md) suite of models being developed and run by members of COSIMA. Nevertheless, this framework is suited to analysing any MOM5/ MOM6 output as well as output from other models.
+ The COSIMA Cookbook framework focuses on the ACCESS-OM2 suite of models being developed and run by members of COSIMA. Nevertheless, this framework is suited to analysing any MOM5/ MOM6 output as well as output from other models.
## Getting Started
diff --git a/docs/models/configurations/access-om.md b/docs/models/configurations/access-om.md
index 91b18c263..2ac013287 100644
--- a/docs/models/configurations/access-om.md
+++ b/docs/models/configurations/access-om.md
@@ -14,7 +14,6 @@ The atmospheric fields that drive the model are provided by a data source, usual
The ACCESS-OM2 has versions at three different spatial resolutions: ACCESS-OM2, ACCESS-OM2-025 and ACCESS-OM2-01.
### Model Components
-
diff --git a/docs/models/run-a-model/run-access-cm.md b/docs/models/run-a-model/run-access-cm.md
index 00a0fd4f8..df85b61ab 100644
--- a/docs/models/run-a-model/run-access-cm.md
+++ b/docs/models/run-a-model/run-access-cm.md
@@ -1,5 +1,6 @@
{% set model = "ACCESS-CM" %}
# Run {{ model }}
+
Important for accessdev users!
@@ -11,7 +12,7 @@
### General prerequisites
Before running {{ model }}, you need to fulfil general prerequisites outlined in the First Steps section.
-If you are unsure whether {{ model }} is the right choice for your experiment, take a look at the overview of [ACCESS Models](/models).
+If you are unsure whether {{ model }} is the right choice for your experiment, take a look at the overview of ACCESS Models.
### Model-specific prerequisites
diff --git a/docs/tutorials/esmvaltool.md b/docs/tutorials/esmvaltool.md
new file mode 100644
index 000000000..3ab1d8d66
--- /dev/null
+++ b/docs/tutorials/esmvaltool.md
@@ -0,0 +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
+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
new file mode 100644
index 000000000..63f20e71f
--- /dev/null
+++ b/docs/tutorials/ilamb.md
@@ -0,0 +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/index.md b/docs/tutorials/index.md
new file mode 100644
index 000000000..edb92e8a9
--- /dev/null
+++ b/docs/tutorials/index.md
@@ -0,0 +1,10 @@
+# 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
+
+ACCESS-NRI encourages the members of the community to contact us to share their suggestions.
diff --git a/docs/tutorials/intake.md b/docs/tutorials/intake.md
new file mode 100644
index 000000000..ba424ba05
--- /dev/null
+++ b/docs/tutorials/intake.md
@@ -0,0 +1,6 @@
+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
+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..1300a0b26
--- /dev/null
+++ b/docs/tutorials/models.md
@@ -0,0 +1,7 @@
+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
+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..ee6fb4d4e
--- /dev/null
+++ b/docs/tutorials/payu.md
@@ -0,0 +1,5 @@
+Payu is used in the run of ACCESS-OM
+
+## Tutorial coming
+
+-
diff --git a/drafts/configurations/access-am.md b/drafts/configurations/access-am.md
new file mode 100644
index 000000000..5217737d5
--- /dev/null
+++ b/drafts/configurations/access-am.md
@@ -0,0 +1,35 @@
+# ACCESS-AM
+
+
+
+
+The ACCESS Atmosphere Model (ACCESS-AM) is a global model with atmosphere and land surface components. It is often used in Atmospheric Model Intercomparison Project (AMIP) experiments where it is driven by historically observed sea surface temperature and sea ice data.
+
+ACCESS-NRI will release supported ACCESS-AM configurations. The first release, ACCESS-AM2, will be derived from the [CSIRO ACCESS-CM2 configuration](./access-cm.md#access-cm2) and will include [atmosphere] and [land] components.
+
+## ACCESS-AM2
+
+This is the model configuration used for the AMIP experiments contributed to the World Climate Research Programme’s Coupled Model Intercomparison Project Phase 6 (CMIP6). Note that the CMIP model naming is the same for both the AM and CM configurations, so the CMIP6 experiments are ACCESS-CM2 AMIP rather than ACCESS-AM2.
+
+The component models are the same as ACCESS-CM2:
+
+- Atmosphere model (UM vn10.6, GA7.1 science configuration): N96 resolution (1.875° x 1.25°, 85 levels). Physical model only – no carbon cycle.
+
+- Land surface model (CABLE2.5)
+
+[**Citation** [@Bi2020]][ACCESS-CM2-cite]
+
+### Other configurations
+
+Some experiments already run with other atmospheric model configurations are listed at:
+
+ - [CLEX CMS wiki][UMexperiments]
+
+[atmosphere]: ../model_components/atmosphere.md
+[land]: ../model_components/land.md
+[UM-hive]: ../model_components/atmosphere.md#the-unified-model
+[JULES-hive]: ../model_components/land.md#jules
+[CABLE-hive]: ../model_components/land.md#cable
+[UMstart]: http://climate-cms.wikis.unsw.edu.au/Unified_Model
+[UMexperiments]: http://climate-cms.wikis.unsw.edu.au/UM_Experiments
+[ACCESS-CM2-cite]: https://www.publish.csiro.au/es/ES19040
diff --git a/mkdocs.yml b/mkdocs.yml
index 0dada5dfc..58d9e7951 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -144,6 +144,14 @@ nav:
- METplus: model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_metplus.md
# - Evaluation Recipe Gallery: model_evaluation/model_evaluation_recipe_gallery.md
+ - 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
+ - Payu: tutorials/payu.md
+
- Community Resources:
- community_resources/index.md
# TEMPORARY for Workshop
@@ -162,12 +170,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