diff --git a/.github/workflows/linkspector.yml b/.github/workflows/linkspector.yml new file mode 100644 index 000000000..99cf437ac --- /dev/null +++ b/.github/workflows/linkspector.yml @@ -0,0 +1,13 @@ +# dirs: + # - docs +files: + - docs/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md +excludedDirs: + - drafts + - docs/css + - docs/js + - docs/fontello + - docs/fontawesome* + - docs/assets +baseUrl: https://access-hive.org.au/development-website/ +useGitIgnore: true \ No newline at end of file diff --git a/README.md b/README.md index 6de839851..fe5a575a2 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 vesrions) 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**|\
\this is a code block\\
|
this is a code block
| +|**Link (internal)**|\ACCESS-Hive link\|ACCESS-Hive link| +|**Link (external)**|\Google link\|Google link⎋| +|**Warning note**|\
this is a warning note\
|![warning note](docs/assets/assets_for_readme/warning_note.png)| +|**Tabs**|\
\this is a code block\\
|| + + # 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 +[forum]: https://forum.access-hive.org.au \ No newline at end of file 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 @@
How to contribute
- +
diff --git a/docs/assets/assets_for_readme/warning_note.png b/docs/assets/assets_for_readme/warning_note.png new file mode 100644 index 000000000..859fefda0 Binary files /dev/null and b/docs/assets/assets_for_readme/warning_note.png differ 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 fc30eac97..0b93cd210 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](/models/configurations/access-om) 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/run-a-model/run-access-cm.md b/docs/models/run-a-model/run-access-cm.md index 00a0fd4f8..27a522ab1 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!
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 + + +ACCESS AM model + +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