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.

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

Add Page on How-To Prerelease #851

Merged
merged 8 commits into from
Jan 30, 2025
Merged
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/create_a_prerelease/comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 13 additions & 5 deletions docs/css/access-nri.css
Original file line number Diff line number Diff line change
Expand Up @@ -1089,13 +1089,14 @@ img.terminalSwitch:hover {
}

/* ===============================================================
Virtural terminal colours for Spack output
Virtural terminal colours for Spack and Git output
*/

.spack-red {
color: #FF6E67;
}
.spack-highlighted {
.spack-highlighted,
.git-highlighted {
color: #FFFFFF;
font-weight: 600;
}
Expand All @@ -1105,7 +1106,8 @@ img.terminalSwitch:hover {
.spack-indigo {
color: #6871FF;
}
.spack-green{
.spack-green,
.git-green {
color: #00C200;
}
.spack-pink {
Expand All @@ -1120,6 +1122,12 @@ img.terminalSwitch:hover {
color: #60FA67;
}

.git-red {
color: #C91A00;
}
.git-cyan {
color: #00C6C7;
}

/* ===============================================================
General styling for html tabs
Expand Down Expand Up @@ -1218,8 +1226,8 @@ img.intro-img {
/* Gifs, videos and example images (For example the ones in 'how to run' a model */
.example-img {
display: block;
width: 100%;
border-radius: 0.6rem;
width: 90%;
border-radius: 0.2rem;
}

/* Justified text */
Expand Down
9 changes: 5 additions & 4 deletions docs/js/custom-tags.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,13 @@ class SimulatedTerminalInfo extends HTMLElement {

connectedCallback() {
this.innerHTML = `<div class="admonition info">
In this documentation, the same code is sometimes shown in a highlighted code-block
In this documentation, the same code is sometimes shown in a highlighted code block
and also in a simulated terminal.<br>
The <b>code-blocks</b> show the commands to be run in a terminal. They can be easily copied
The <b>code blocks</b> show the commands to be run in a terminal. They can be easily copied
by clicking on the icon over the right side of the code block.<br>
The <b>simulated terminals</b> are examples of the output to expect when the commands are
run. Sometimes they might slightly differ from the real outputs.
The <b>simulated terminals</b> are produced using <a href="https://github.com/atteggiani/animated-terminal.js" target="_blank" class="external-link">animated-terminal.js</a>
and provide examples of the output to expect when the commands are run.
Sometimes they might slightly differ from the real outputs.
</div>`
}
}
Expand Down
8 changes: 5 additions & 3 deletions docs/models/run-a-model/build_a_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@

## About

The instructions below outline how to build an ACCESS model and its dependencies, using the build-from-source package manager [Spack](https://spack.readthedocs.io).<br>
The following instructions below outline how to build an ACCESS model and its dependencies, using the build-from-source package manager [Spack](https://spack.readthedocs.io).<br>
This build workflow is specifically designed to run on the [National Computating Infrastructure (NCI)](https://nci.org.au/about-us/who-we-are) supercomputer [_Gadi_][gadi].

As an example, in the following instructions we will show how to modify [mom5 component](/models/model_components/ocean/#mom5) for [ACCESS-ESM1.5](/models/configurations/access-esm/#access-esm15) and re-compile the relevant ACCESS-ESM1.5 dependencies. All the other components and packages (i.e., dependencies) will remain the same as the official [ACCESS-ESM1.5 release]({{esm1_5_build_config}}).
The following instructions outline how to trigger a prerelease build of [ACCESS-OM2][om2 config] after modifying its [MOM5 component]. All other components of the official [ACCESS-OM2 release][om2 repo] will remain unchanged.

As an example, in the following instructions we will show how to modify [MOM5 component](/models/model_components/ocean/#mom5) for [ACCESS-ESM1.5](/models/configurations/access-esm/#access-esm15) and re-compile the relevant ACCESS-ESM1.5 dependencies. All other components and packages (i.e., dependencies) of the official [ACCESS-ESM1.5 release]({{esm1_5_build_config}}) will remain unchanged.

!!! tip
The instructions below remain valid (with simple tweaks) for any model or package.
The following instructions are valid (with simple tweaks) for all [ACCESS models].

## Prerequisites

Expand Down
312 changes: 312 additions & 0 deletions docs/models/run-a-model/create-a-prerelease.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ nav:
- Run ACCESS-ESM: models/run-a-model/run-access-esm.md
- Run ACCESS-OM: models/run-a-model/run-access-om.md
- Modify an ACCESS model's source code: models/run-a-model/build_a_model.md
- Creating Prereleases and Releases for an ACCESS Model: models/run-a-model/create-a-prerelease.md

- Data and Model Evaluation:
- model_evaluation/index.md
Expand Down
Loading