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

ACCESS-RAM3: Quick start guide (issue #841) #857

Draft
wants to merge 54 commits into
base: davide/access-ram-documentation
Choose a base branch
from

Conversation

heidinett
Copy link
Contributor

Quick start guide for running ACCESS-RAM3 for alpha release testing

Fixes #841

flicj191 and others added 21 commits August 21, 2024 16:51
Merge to main to include getting started updates
Make how to run ESM1.5 page live
[Urgent] - Deployment of the workshop changes on `main`
Update main website with latest content
Merge commit issued by the automatic_merge workflow.
[Urgent] Merging training materials section
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Merge commit issued by the automatic_merge workflow.
Copy link

github-actions bot commented Dec 10, 2024

PR Preview
🚀 Deployed preview to https://access-hive.org.au/pr-preview/pr-857
2025-01-06 15:10 AEDT

@heidinett heidinett marked this pull request as draft December 10, 2024 05:32
@heidinett heidinett changed the base branch from development to davide/access-ram-documentation December 11, 2024 00:42

[:fontawesome-brands-github:{: class="twemoji icon-before-text"} {{ model }} configurations]({{github_configs}}){: class="text-card"}
[:fontawesome-brands-github:{: class="twemoji icon-before-text"} {{ model }} configuration]({{github_configs}}){: class="text-card"}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Run {{ model }}

docs/models/run-a-model/run-access-ram.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-ram.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-ram.md Outdated Show resolved Hide resolved
Comment on lines 10 to 12
{{ model }} is a place-holder name until the final release name is chosen.

[:fontawesome-brands-github:{: class="twemoji icon-before-text"} {{ model }} configurations]({{github_configs}}){: class="text-card"}
[:fontawesome-brands-github:{: class="twemoji icon-before-text"} {{ model }} configuration]({{github_configs}}){: class="text-card"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this config card above the info note above so that the info note appears just above the page title.
And the note about the code blocks that you mentioned in todays meeting automatically comes up on the page because there are terminal animations on the page, probably best to leave it there.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @flicj191! I moved the config card as you suggested.
Re: note about code block, it would be great if I could place it in the Detailed guide (at the moment it's in the Quick Start where there are no terminal animations).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like its automatically set to appear under the page heading, that's why I've added a page heading and changed others to subheadings in the suggestions above. I guess a hack right now would be to make detailed guide the page heading, then all the headings before that wouldn't appear in the page navigation

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can commit the ones you want from above from the files tab in a batch. moving the config card without the added page title wouldn't put the name note above the page title

Copy link
Contributor

@flicj191 flicj191 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions to fix the hierarchy of the headings so that the navigation on he right can show the sub-headings

@engelca
Copy link

engelca commented Dec 11, 2024

The major comment relates to how persistent sessions work with the RAS/RNS.
In the RAS/RNS you currently have to ssh -Y directly into the persistent session to run the suite.
The suite can be edited thought via a non-persistent session.
To run from within a persistent session, I do the following:

  1. ls ~/.persistent-session/ to get the "persistent-session" name
  2. ssh -Y "persistent-session"
  3. module use /g/data/hr22/modulefiles
  4. module load cylc7
  5. cd roses
  6. cd "suite-directory"
  7. rose suite-run

In the Quickstart for both the RAS and RNS after taking the chekout/copy of the suite, the users needs to manually change into the suite directory prior to any further commands.

In the "Specify target persistent session" section. This doesn't work for me. I did do it but the rose suite-run command will crash. It only works from within the persistent-session. We need to either remove this section or edit the rose/cylc suite so the cylc-session file works.

In RAS/"Run the suite". again I can't run from a non-persistent session so I do the steps above first.

In RAS/"Monitor the suite runs". The text says two main ways but only the GUI way is listed. The second way is through the file system. The users have not been told of this option or where to look for the output files. The file locations are non-trivial, i.e. "output directory"/"user"/cylc-run/"suite-id"/log/job/"cycle-date"/"job-name"/"run-number; usually 01 unless repeated".

In RAS/"Edit the RAS configuration". There is a type "congiguration".

In RAS/"Change the region centre and name". The video is not showing (I did record one and upload it though ...)

In RNS/"RNS output files". The subdirectories (ics, lbcs, and um) are not being shown in a list. And another typo "scienc_choice".

In RNS/"Edit the RNS configuration". The "Rose GUI" link goes to the RAS specific example not to the "rose edit &" command above it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need to update 'Land Surface Component' page test with RNS release
6 participants