Skip to content

Update README with Spack compilation options #187

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

Open
chrisb13 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README with Spack compilation options #187

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c6ea6f
Update README with Spack compilation options
chrisb13 Feb 12, 2026
10d71ea
Apply suggestions from code review
chrisb13 Feb 12, 2026
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ ACCESS-NRI is using [spack](https://spack.io), a build from source package manag

Spack automatically builds all the components and their dependencies, producing model component executables. Spack already contains support for compiling thousands of common software packages. Spack packages for the components are defined in the [spack packages repository](https://github.com/ACCESS-NRI/spack_packages/).

ACCESS-OM3 is built and deployed automatically to `gadi` on NCI (see below). However it is possible to use spack to compile the model using the `spack.yaml` environment file in this repository. To do so follow the [instructions on for configuring spack on `gadi`](https://access-hive.org.au/getting_started/spack/).
ACCESS-OM3 is built and deployed automatically to `gadi` on NCI (see below). To change model component versions or modify the model's source code, users use spack to compile the model using the `spack.yaml` environment file in this repository. There are two main ways to do this: i) use the pre-release github workflow ([instructions](https://docs.access-hive.org.au/models/build_a_model/create_a_prerelease/)) or ii) follow the [instructions on for configuring spack on `gadi`](https://access-hive.org.au/getting_started/spack/). The first option is simpler to understand, however requires "collaborator" access to this repository - (raise [an issue](https://github.com/ACCESS-NRI/ACCESS-OM3/issues/new) on this repository to gain access).

Then clone this repository and run the following commands on `gadi`:
The second option requires access to gadi and is as follows. Clone this repository and run the following commands on `gadi`:

```bash
spack env create access-om3 spack.yaml
Expand All @@ -44,6 +44,8 @@ spack install

to create a spack environment called `access-om3` and build all the components, the locations of which can be found using `spack find --paths`.

Further details of how to build and modify ACCESS-OM3 are found on the ACCESS-OM3 [configuration documentation](https://access-om3-configs.access-hive.org.au/infrastructure/Building/).

### Deployment

ACCESS-OM3 is deployed automatically when a new version of the [`spack.yaml`](./spack.yaml) file is committed to `main` or a dedicated `backport/VERSION` branch. All the ACCESS-OM3 components are built using `spack` on `gadi` and installed under the [`vk83`](https://my.nci.org.au/mancini/project/vk83) project in `/g/data/vk83`. It is necessary to be a member of [`vk83`](https://my.nci.org.au/mancini/project/vk83) project to use ACCESS-NRI deployments of ACCESS-OM3.
Expand Down