Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create how to build a model page #777

Closed
wants to merge 4 commits into from
Closed

Create how to build a model page #777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88a0783
Added how-to-build-page
atteggiani Sep 9, 2024
1dba805
Updated build_a_model page
atteggiani Sep 10, 2024
6d73976
Deleted the pack setup paragraph and added prerequisites on setting u…
atteggiani Sep 20, 2024
34af42a
Updated content of 'How to build an ACCESS model'
atteggiani Sep 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The following custom tags are available:
|**Code block**|\```<br>&emsp;code block<br>```|\<pre><br>&emsp;\<code>code block\</code><br>\</pre>|<pre><code>code block</code></pre>|
|**[Admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage) (not collapsible)**|!!! warning<br>&emsp;this is a warning admonition|\<div class="admonition warning"><br>&emsp;this is a warning<br>&emsp;admonition<br>\<div>|![warning admonition](docs/assets/assets_for_readme/warning_admonition.png)|
|**Collapsible [Admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)**|??? warning title<br>&emsp;this is a collapsible warning admonition|\<details class="warning"><br>&emsp;\<summary><br>&emsp;&emsp;\<p><br>&emsp;&emsp;&emsp;this is a collapsible<br>&emsp;&emsp;&emsp;warning admonition<br>&emsp;&emsp;\</p><br>&emsp;\</summary><br>\</details>|![collapsible warning admonition](docs/assets/assets_for_readme/collapsible_warning_admonition.gif)|
|**Tabs**|N/A|\<div class="tabLabels" label="your-tab-label"><br>&emsp;\<button id="id-tab1">Tab1\</button id="id-tab2"><br>&emsp;\<button>Tab2\</button><br>\</div><br>\<div contentfor="id-tab1"><br>&emsp;&emsp;Content for tab1<br>&emsp;\</div><br>&emsp;\<div contentfor="id-tab2"><br>&emsp;&emsp;Content for tab2<br>&emsp;\</div>|![tabs](docs/assets/assets_for_readme/tabs.gif)|
|**Tabs**|N/A|**Labels:**<br>\<div class="tabLabels" label="your-tab-label"><br>&emsp;\<button id="id-tab1"><br>&emsp;&emsp;Tab1<br>&emsp;\</button><br>&emsp;\<button id="id-tab2"><br>&emsp;&emsp;Tab2<br>&emsp;\</button><br>\</div><br><br>**Contents:**<br>\<div tabcontentfor="id-tab1"><br>&emsp;&emsp;Content for tab1<br>\</div><br>\<div contentfor="id-tab2"><br>&emsp;&emsp;Content for tab2<br>\</div><br><br>A content for a specific tab `id` can be included or not independently from the other contents.|![tabs](docs/assets/assets_for_readme/tabs.gif)|


# License
Expand Down
2 changes: 1 addition & 1 deletion docs/js/miscellaneous.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ function tabFunctionality() {
button.addEventListener('click', (e) => openTab(e.currentTarget));
})

// Add click event for links to tab IDs on the same page
// Add click event for links to tab IDs
document.querySelectorAll('[href^="#"]:not([class^="md"])').forEach(el => {
let href = el.getAttribute('href');
let tabEl = document.getElementById(href.slice(1,))
Expand Down
2 changes: 1 addition & 1 deletion docs/models/configurations/access-esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This means it can simulate both the physical climate and global biogeochemical c

[ACCESS-ESM1.5](https://www.publish.csiro.au/es/ES19035) [@Ziehn2020] is a fully-coupled climate model with land and ocean carbon cycle components. ACCESS-ESM1.5 was developed primarily to enable Australia to participate in the [Coupled Model Intercomparison Project Phase 6 (CMIP6)](https://wcrp-cmip.org/cmip6/) with an Earth System Model (ESM) version.

ACCESS-NRI has released ACCESS-ESM1.5 configurations as an adaptation of those originally developed by [CSIRO](https://www.csiro.au/en/research/environmental-impacts/climate-change/climate-science-centre) and [CLEX CMS](https://github.com/coecms/access-esm).
ACCESS-NRI has released [ACCESS-ESM1.5 configurations](https://github.com/ACCESS-NRI/access-esm1.5-configs) as an adaptation of those originally developed by [CSIRO](https://www.csiro.au/en/research/environmental-impacts/climate-change/climate-science-centre) and [CLEX CMS](https://github.com/coecms/access-esm).

There are currently two supported configurations:

Expand Down
6 changes: 3 additions & 3 deletions docs/models/configurations/access-om.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Each configuration also has a biogeochemical (BGC) configuration that uses the [

### Model Components
<div class="tabLabels" label="ACCESS-OM2-versions">
<button>ACCESS-OM2</button>
<button>ACCESS-OM2-025</button>
<button>ACCESS-OM2-01</button>
<button id="1deg">ACCESS-OM2</button>
<button id="025deg">ACCESS-OM2-025</button>
<button id='01deg'>ACCESS-OM2-01</button>
</div>

- **Ocean**: [MOM5](/models/model_components/ocean#mom5).<br>
Expand Down
578 changes: 578 additions & 0 deletions docs/models/run-a-model/build_a_model.md
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 10 additions & 2 deletions docs/models/run-a-model/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,24 @@ If you are unsure which ACCESS model is the right choice for your experiment, ta
<div class="card-image-container">
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/globe_visualisation/access_esm_globe_visualisation.png" alt="ACCESS-ESM">
</div>
<div class="card-text-container bold">
<div class="card-text-container bold">
Run ACCESS-ESM
</div>
</a>
<a href="/models/run-a-model/run-access-om" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/globe_visualisation/access_om_globe_visualisation.png" alt="ACCESS-OM">
</div>
<div class="card-text-container bold">
<div class="card-text-container bold">
Run ACCESS-OM
</div>
</a>
<a href="/models/run-a-model/build_a_model" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/globe_visualisation/access_om_globe_visualisation.png" alt="Build a model">
</div>
<div class="card-text-container bold">
Build an ACCESS model
</div>
</a>
</div>
4 changes: 4 additions & 0 deletions docs/models/run-a-model/run-access-esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,10 @@ Each of [{{ model }} components][model components] contains additional configura
These configuration options are specified in files located inside a subfolder of the _control_ directory, named according to the submodel's `name` specified in the `config.yaml` `submodels` section (e.g., configuration options for the _ocean_ component are in the `~/access-esm/preindustrial+concentrations/ocean` directory).<br>
To modify these options please refer to the User Guide of the respective model component.

### Create a custom {{ model }} build
All the executables needed to run {{ model }} are pre-built into independent configurations using _Spack_.<br>
To customise {{ model }}'s build (for example to run {{ model }} with changes in the source code of one of its component), refer to [Build {{ model }}](/models/run-a-model/build_a_model#{{model|lower}}).

### Controlling model output
Selecting the variables to save from a simulation can be a balance between enabling future analysis and minimising storage requirements. The choice and frequency of variables saved by each model can be configured from within each submodel's _control_ directory.

Expand Down
4 changes: 4 additions & 0 deletions docs/models/run-a-model/run-access-om.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,10 @@ These options are typically useful to modify the physics used in the model, the
These configuration options are specified in files located inside a subfolder of the _control_ directory, named according to the submodel's `name` specified in the `config.yaml` `submodels` section (e.g., configuration options for the _ocean_ component are in the `~/access-om2/1deg_jra55_ryf/ocean` directory).<br>
To modify these options please refer to the User Guide of the respective model component.

### Create a custom {{ model }} build
All the executables needed to run {{ model }} are pre-built into independent configurations using _Spack_.<br>
To customise {{ model }}'s build (for example to run {{ model }} with changes in the source code of one of its component), refer to [Build {{ model }}](/models/run-a-model/build_a_model#{{model|lower}}).

## Get Help

If you have questions or need help regarding {{ model }}, consider creating a topic in the [COSIMA category of the ACCESS-Hive Forum](https://forum.access-hive.org.au/c/cosima/29).<br>
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ nav:
- Run ACCESS-CM: models/run-a-model/run-access-cm.md
- Run ACCESS-ESM: models/run-a-model/run-access-esm.md
- Run ACCESS-OM: models/run-a-model/run-access-om.md
- Build an ACCESS Model: models/run-a-model/build_a_model.md

- Data and Model Evaluation:
- model_evaluation/index.md
Expand Down Expand Up @@ -215,6 +216,6 @@ extra_css:

extra_javascript:
- https://unpkg.com/[email protected]/dist/tablesort.min.js # For tablesort functionality
- https://cdn.jsdelivr.net/gh/atteggiani/animated-terminal@2.1/animated-terminal.min.js # Terminal animations
- https://cdn.jsdelivr.net/gh/atteggiani/animated-terminal@3.0/animated-terminal.min.js # Terminal animations
- js/custom-tags.js
- js/miscellaneous.js
Loading