ACCESS-OM2 Model Run: Added top level "About" section

[aidanheerdegen]

Description

Added top level About section.

Fixes #680

[github-actions[bot]]

PR Preview :---: 🛬 Link removed because the pull request was closed. 2024-05-10 15:30 AEST

[atteggiani]

Thank you for this @aidanheerdegen. I think it's a great idea.

I changed the base to development instead of main. I am going to review it next week (mainly change link to markdown and re-style the button).

[atteggiani]

@aidanheerdegen

I saw that you created your branch from main. Before my review, can you please rebase from development?

[aidanheerdegen]

Before my review, can you please rebase from development?

Done.

[aidanheerdegen]

@paigem this is the PR to update the OM2 model run docs

[paigem]

This looks great @aidanheerdegen and @atteggiani! I'm going to add a couple small comments here, since I don't want to slow this process down as I remember how to contribute to an open PR (sorry - I guess I need to review some GitHub training! 😅).

• I like the GitHub button at the top, but is it possible to change the text in side to say which GitHub repo it points to (looks like the ACCESS-OM2 configurations repo)? Within a docs environment, I often assume the GitHub button would take me to the docs repo where I could suggest updates, so clarifying that link would be nice.
• EDIT: forgot I could just make a suggested edit in this PR, so have done that for this comment. I know this information is elsewhere, but I'd probably add one sentence at the top for new/international folks along the lines of the following: "The instructions below outline how to run the model using ACCESS-NRI's software deployment pipeline, specifically designed to run on the National Computating Infrastructure's (NCI's) Gadi supercomputer." The two points I think are worth mentioning:
  • This documentation refers to the ACCESS-NRI release of OM2 (not the legacy one).
  • This is specifically for running on Gadi.
• Kelsey also suggested adding a link to the model code. I actually couldn't find the model code - it looks like it's all neatly packaged in this repo, where cloning this repo and running a few commands will run the model on Gadi. Is the model code available somewhere, and is that something worth linking to?

[aidanheerdegen]

Those are all good suggestions @paigem.

On this specific question:

Kelsey also suggested adding a link to the model code. I actually couldn't find the model code - it looks like it's all neatly packaged in this repo, where cloning this repo and running a few commands will run the model on Gadi. Is the model code available somewhere, and is that something worth linking to?

The model code resides in a number of different repositories. They're linked in the README:

ACCESS-OM2 consists of the MOM 5 ocean model, CICE 5 sea ice model, and a file-based atmosphere called YATM coupled together using OASIS3-MCT v2.0.

But it could be more explicit. e.g. as a table, with a column being a link to the code repo.

Note we also don't specify a version in this page because there is no single canonical version: there are 12 configurations which could all have slightly different versions, with slightly different versions of the actual model.

Did I mention it was complex?

[paigem]

Thanks @aidanheerdegen!

But it could be more explicit. e.g. as a table, with a column being a link to the code repo.

Thanks - you're right that it makes sense now that we just link out to each component's code. 🤦‍♀️ What might make it slightly clearer is to, instead of having the links on the name of the models (I thought those links would go to information about the model, rather than model code), to have in parentheses after each model is listed "(link to MOM5 code)", for example, to make it clear where the links direct to. But, I think this is minor and not worth worrying about now - the information is there and quite readable as is.

[aidanheerdegen]

What might make it slightly clearer is to, instead of having the links on the name of the models (I thought those links would go to information about the model, rather than model code), to have in parentheses after each model is listed "(link to MOM5 code)", for example, to make it clear where the links direct to

I agree. It's what I was getting at with the table, but I explained badly. Feel free to make an issue to improve the README in that repo. It won't get fixed otherwise.

[atteggiani]

Thank you @paigem for the suggestions.

I committed your suggestions

The instructions below outline how to run the model using ACCESS-NRI's software deployment pipeline, specifically designed to run on the National Computating Infrastructure's (NCI's) Gadi supercomputer.

with minor modifications:

The instructions below outline how to run the ACCESS-OM2 using ACCESS-NRI's software deployment pipeline, specifically designed to run on the National Computating Infrastructure (NCI) supercomputer Gadi.

I also changed the Github button text to "ACCESS-OM2 configurations".

If no more modifications are required, I will merge this PR around 3:30pm today.

Thank you! @aidanheerdegen

[paigem]

This all looks great @atteggiani! All my comments have been addressed - thanks! 😊

[atteggiani]

Also rebased with development