Developer docs: add multi-component development example #68
Conversation
This file contains 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
Apply suggestions from code review Co-authored-by: Tommy Gatti <[email protected]> Co-authored-by: Andrew Kiss <[email protected]> Co-authored-by: Tommy Gatti <[email protected]> Co-authored-by: Dougie Squire <[email protected]> Co-authored-by: Claire Carouge <[email protected]>
aekiss
reviewed
Sep 20, 2024
|
|
||
| ## Development environment | ||
|
|
||
| Spack [has environments](https://spack.readthedocs.io/en/latest/environments.html), which is similar to many other related implementations such as conda environments and python virtual environments. |
There was a problem hiding this comment.
Suggested change
| Spack [has environments](https://spack.readthedocs.io/en/latest/environments.html), which is similar to many other related implementations such as conda environments and python virtual environments. | |
| Spack [has environments](https://spack.readthedocs.io/en/latest/environments.html), which are similar to many other related implementations such as conda environments and python virtual environments. |
aekiss
reviewed
Sep 20, 2024
|
|
||
| In this example the `mom5` component will be modified but all other components and dependencies remain the same. | ||
|
|
||
| This example also uses the [`ACCESS-OM2` `spack.yaml` environment file](https://github.com/ACCESS-NRI/ACCESS-OM2/blob/main/spack.yaml) as an argument to the [`spack env create` command](https://spack.readthedocs.io/en/latest/command_index.html#spack-env-create). This makes the development environment the same as that for the released ACCESS-OM2 model that is referenced in the local copy of the repo. So it is necessary to clone [this repository](https://github.com/ACCESS-NRI/ACCESS-OM2/). |
There was a problem hiding this comment.
Suggested change
| This example also uses the [`ACCESS-OM2` `spack.yaml` environment file](https://github.com/ACCESS-NRI/ACCESS-OM2/blob/main/spack.yaml) as an argument to the [`spack env create` command](https://spack.readthedocs.io/en/latest/command_index.html#spack-env-create). This makes the development environment the same as that for the released ACCESS-OM2 model that is referenced in the local copy of the repo. So it is necessary to clone [this repository](https://github.com/ACCESS-NRI/ACCESS-OM2/). | |
| This example also uses the [`ACCESS-OM2` `spack.yaml` environment file](https://github.com/ACCESS-NRI/ACCESS-OM2/blob/main/spack.yaml) as an argument to the [`spack env create` command](https://spack.readthedocs.io/en/latest/command_index.html#spack-env-create). This makes the development environment the same as that for the released ACCESS-OM2 model that is referenced in the local copy of the repo. So it is necessary to clone [the ACCESS-NRI ACCESS-OM2 repository](https://github.com/ACCESS-NRI/ACCESS-OM2/). |
aekiss
reviewed
Sep 20, 2024
|
|
||
| As a result of the intentional error introduced above. | ||
|
|
||
| Reverting that change and `spack install` worked as expected |
There was a problem hiding this comment.
Suggested change
| Reverting that change and `spack install` worked as expected | |
| Reverting that change, `spack install` works as expected |
aekiss
reviewed
Sep 20, 2024
| ==> Updating view at /g/data/.../dev_instructions/envs/mom5-dev/.spack-env/view | ||
| ==> Warning: Skipping external package: [email protected]%[email protected]~atomics~cuda~cxx~cxx_exceptions~gpfs~internal-hwloc~java~legacylaunchers~lustre~memchecker~orterunprefix+romio+rsh~singularity+static+vt+wrapper-rpath build_system=autotools fabrics=none patches=073477a,60ce20b schedulers=none arch=linux-rocky8-x86_64/4jwtg3n | ||
| ``` | ||
|
|
There was a problem hiding this comment.
say something here about where the newly-compiled executables can be found
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added in the example of developing more than mode component at a time
Originally from #63
Should be rebased on
mainonce #67 is merged.