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 a document on how to use Spack develop #743

Open
harshula opened this issue Aug 28, 2024 · 2 comments · May be fixed by #777
Open

Add a document on how to use Spack develop #743

harshula opened this issue Aug 28, 2024 · 2 comments · May be fixed by #777
Assignees
Labels
✏️ documentation Improvements or additions to documentation

Comments

@harshula
Copy link
Contributor

harshula commented Aug 28, 2024

Description

We currently have a document on how to use Spack develop for ACCESS-OM2 in the ACCESS-OM2 git repository:
https://github.com/ACCESS-NRI/ACCESS-OM2/blob/main/DEVELOPERS.md

We would like to make it available on Hive-Docs and generalise it to make it applicable to other models. e.g. ACCESS-ESM1.5.

Why

We want users to be able to use Spack to modify a model's source code, built it and run it.

Close Criteria

Spack develop document is available on Hive Docs.

@atteggiani
Copy link
Contributor

atteggiani commented Aug 28, 2024

Thanks for opening this issue @harshula!

I think the best approach for the addition of this content is the following:

  1. Create a stand-alone page (something like "Build a model"), with the content you referred to above (initially I would take exactly the ACCESS-OM2 example as a reference).
    For example, another section called "Build a model" could be added to the "Run ACCESS-CM", "Run ACCESS-OM" and "Run ACCESS-ESM" sections. Something like this:

test

  1. Differentiate the page for different models using tabs (see this example for different ACCESS-OM2 versions)
  2. Link the respective model build page at the end of the "run <MODEL>" pages, in a paragraph that could be called "Custom <MODEL> build".

What do you think?

@atteggiani atteggiani added the ✏️ documentation Improvements or additions to documentation label Aug 28, 2024
@atteggiani
Copy link
Contributor

Decreased priority to Medium (will be done after the workshop) after release stand-up. @harshula

@atteggiani atteggiani linked a pull request Sep 10, 2024 that will close this issue
@atteggiani atteggiani linked a pull request Sep 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✏️ documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants