-
Notifications
You must be signed in to change notification settings - Fork 12
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
base: davide/access-ram-documentation
Are you sure you want to change the base?
ACCESS-RAM3: Quick start guide (issue #841) #857
Conversation
Merge to main to include getting started updates
Make how to run ESM1.5 page live
[Urgent] - Deployment of the workshop changes on `main`
Urgent merge
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.
…heidi/ram-doc-issue841
|
|
||
[: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"} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Run {{ model }} |
{{ 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"} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this 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
Co-authored-by: Felicity Chun <[email protected]>
Co-authored-by: Felicity Chun <[email protected]>
Co-authored-by: Felicity Chun <[email protected]>
Jasmeen/access ram fixes 841
The major comment relates to how persistent sessions work with the RAS/RNS.
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. |
Quick start guide for running ACCESS-RAM3 for alpha release testing
Fixes #841