Open
Conversation
Clarify options for compiling ACCESS-OM3 with Spack and provide additional instructions. From discussion with @aekiss (#186 (comment))
README.md
Outdated
| 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). However it is possible to 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/). Both options are possible, however the first option requires "collaborator" access to this repository (raise [an issue](https://github.com/ACCESS-NRI/ACCESS-OM3/issues/new) on this repository to gain access). |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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. 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/). Both options are possible, however the first option requires "collaborator" access to this repository (raise [an issue](https://github.com/ACCESS-NRI/ACCESS-OM3/issues/new) on this repository to gain access). | |
| 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). |
Collaborator
There was a problem hiding this comment.
Or alternatively, just :
ACCESS-OM3 is built and deployed automatically to gadi on NCI (see below). To customise a build, follow the instructions at the config documentation.
Collaborator
Author
There was a problem hiding this comment.
I was stumbling on the wording here, how about:
There are two main ways to do this
becomes
There are two recommended ways to do this
I was trying to not exclude random options that are more painful (e.g. installing spack on your laptop etc).
The changes read well. :)
Collaborator
Author
There was a problem hiding this comment.
Got caught up chatting to Helen, so didn't post it!
Or alternatively, just :
ACCESS-OM3 is built and deployed automatically to
gadion NCI (see below). To customise a build, follow the instructions at the config documentation.
Yeah, I do like low maintenance options -- can we do that for the other sections? Your call...
Does the config doc talk about the PR release workflow? I think we really want to push that as a simple starting point.
Co-authored-by: Anton Steketee <79179784+anton-seaice@users.noreply.github.com>
Comment on lines
35
to
+48
| @@ -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/). | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
Suggested change
| ACCESS-OM3 is built and deployed automatically to gadi on NCI (see below). To customise a build, follow the instructions in the [config documentation](https://access-om3-configs.access-hive.org.au/infrastructure/Building/). | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify options for compiling ACCESS-OM3 with Spack and provide additional instructions.
From discussion with @aekiss (#186 (comment))
i.e.