Skip to content

Commit 28c0bcc

Browse files
committed
(#279) - Reorganise info between Building and Deployment pages.
1 parent d8ccbec commit 28c0bcc

2 files changed

Lines changed: 16 additions & 20 deletions

File tree

documentation/docs/pages/infrastructure/Building.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,9 @@
11
# Build infrastructure
22

3-
Most users of ACCESS-ESM1.6 will not need to build the model. Released versions of the model are deployed by ACCESS-NRI to Gadi and available to users. If you require your own build of the model, typically because you need to modify one or several model components, you will find the required information on this page.
3+
Most users of ACCESS-ESM1.6 will not need to build the model. Released versions of the model are deployed by ACCESS-NRI to Gadi and available to users. If you require your own build of the model, typically because you need to modify one or several model components, you will find the required information on this page. For more information on the available deployed builds, check the [Deployment](/documentation/docs/pages/infrastructure/Deployment.md) page.
44

55
ACCESS-NRI is using [Spack](https://spack.io/), a build from source package manager designed for use with high performance computing. Spack already contains support for compiling thousands of common software packages.
66

7-
## Existing deployments
8-
9-
ACCESS-ESM1.6 releases come with a pre-deployed executable on Gadi. Deployed builds are stored under the project `vk83` (hence requiring [membership to this project](https://my.nci.org.au/mancini/project/vk83/join) for access). You can see all deployed builds via:
10-
11-
```bash
12-
module use /g/data/vk83/modules
13-
module avail access-esm1p6
14-
```
15-
16-
There are development releases (identified with a `dev_` prefix to the date tag) and full releases (identified with only a date tag). We recommend new users start with the newest full release (i.e. with the most recent date tag).
17-
18-
These builds are optimised for the Sapphire-Rapid hardware from Intel (i.e., the *normalsr* queue), and may not run on Cascade-Lake (i.e., the *normal* queue) or older hardware.
19-
207
## Software structure
218

229
ACCESS-ESM1.6 being a Earth System model, it is constituted of several model components, each residing in its own repository on GitHub. In addition, some model components need other utilities at compilation time that are stored in separate repositories. This results in a complex software structure involving a large number of repositories:
Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# Deployment
22

3-
ACCESS-ESM1.6 is deployed automatically when a new version of the spack.yaml file is committed to the `main` branch or a dedicated `backport/VERSION` branch of the [ACCESS-NRI/ACCESS-ESM1.6](https://github.com/ACCESS-NRI/ACCESS-ESM1.6) repository.
3+
All released versions of ACCESS-ESM1.6 come with a pre-deployed build on _Gadi_. Deployed builds are stored under the project `vk83` (hence requiring [membership to this project](https://my.nci.org.au/mancini/project/vk83/join) for access). You can see all deployed builds via:
44

5-
ACCESS-ESM1.6 is deploed in /g/data/vk83. It is necessary to be a member of vk83 project to use ACCESS-NRI deployments of ACCESS-ESM1.6. All deployed versions are available as modules to load. To check all the released versions of ACCESS-ESM1.6 on Gadi:
6-
7-
```
5+
```bash
86
module use /g/data/vk83/modules
97
module avail access-esm1p6
108
```
119

12-
For users of ACCESS-ESM1.6 model configurations released by ACCESS-NRI, the exact location of the ACCESS-ESM1.6 model executables is not required. Model configurations will be updated with new model releases when necessary.
10+
There are development releases (identified with a `dev_` prefix to the date tag) and full releases (identified with only a date tag). We recommend new users start with the newest full release (i.e. with the most recent date tag).
11+
12+
These builds are optimised for the Sapphire-Rapid hardware from Intel (i.e., the *normalsr* queue), and may not run on Cascade-Lake (i.e., the *normal* queue) or older hardware.
13+
14+
The ACCESS-ESM1.6 model configurations released by ACCESS-NRI are setup to use the proper model release and will be updated when necessary.
15+
1316

1417
## Release information
1518

1619
The deployment process creates a GitHub release with the same tag as the deployed module. All releases are available under the [Releases page](https://github.com/ACCESS-NRI/ACCESS-ESM1.6/releases). Each release has a changelog and meta-data with detailed information about the build and deployment, including:
1720

1821
- paths on Gadi to all executables built in the deployment process (spack.location)
1922
- a spack.lock file, which is a complete build provenance document, listing all the components that were built and their dependencies, versions, compiler version, build flags and build architecture
20-
- the environment spack.yaml file used for deployment
23+
- the environment spack.yaml file used for deployment
24+
25+
## More details
26+
27+
The deployment is managed via GitHub Actions that are triggered when a new version of the spack.yaml file is committed to the `main` branch or a dedicated `backport/VERSION` branch of the [ACCESS-NRI/ACCESS-ESM1.6](https://github.com/ACCESS-NRI/ACCESS-ESM1.6) repository.
28+
29+
No manual deployments will be accepted.

0 commit comments

Comments
 (0)