how to run ACCESS-ISSM configuration documentation#932
how to run ACCESS-ISSM configuration documentation#932justinh2002 wants to merge 27 commits intodevelopmentfrom
Conversation
|
If you need help setting up the new page please let me know, as there are very few things you will need to change in the website configuration |
|
atteggiani
force-pushed
the
justin/929-access-issm-alpha-documentation
branch
from
dbfe95c to
d54abb2
Compare
justinh2002
force-pushed
the
justin/929-access-issm-alpha-documentation
branch
from
de3efb9 to
5f98ccb
Compare
|
Just a quick ping @justinh2002 to let you know that, after discussions with some of our other models, we've decided that alpha releases can have documentation that gets merged into a Hive Docs page that is not linked from anywhere on the Hive Docs. This way, you can send the link to users when it's in alpha and it won't change once it gets moved to beta and full release. So let us know if you'd like to do that! Also happy for you to keep working in this draft PR - whatever you prefer. 😊 |
|
Hi @paigem, yeah! Happy to go with that and have ie be merged into the Hive Docs page. How should we proceed? |
Okay, but that's after review, correct? |
atteggiani
left a comment
atteggiani
left a comment
There was a problem hiding this comment.
Thank you @justinh2002 and anyone else who contributed for putting together this PR!
It's great to have a brand new ACCESS model added to the list of ACCESS-NRI supported models!
A couple o points on this PR and the overall ACCESS-ISSM release plan:
- I left comments on some parts. Many of them are related to the attempt to be more consistent with the other "Run a model" pages on the Hive Docs. Please refer to the specific comments for details.
- As I understood from the latest model-dev meeting, this documentation is for a Beta release of ACCESS-ISSM, that you are planning for the beginning of September.
As I understand ACCESS-ISSM is a bit different from the rest of supported ACCESS models. However, from the instructions written in this page, I notice some missing pieces from the ones that compose a Beta release (according to the draft Release stages table).
Specifically, I am referring to:- the lack of a ACCESS-ISSM-config repo
- the lack of a pre-built executable (related to the above) and consequent need to build the model manually using Spack
- the run workflow (preprocessing and actual run) made of separate scripts to be run manually (for example as PBS jobs) instead of being managed by a "workflow" manager, such as Payu, Cylc, or even a single bash script (if the totality of scripts to run are only 2 like in this case)
Even if the the points above don't necessarily preclude a release to be considered a "Beta" release, the lack of some infrastructural pieces make documentation more onerous to write (because each additional portion needs to be explained, e.g., the spack build one) and the user more prone to problems.
I want to stress that this point is not a critique of the excellent work that has been done for ACCESS-ISSM, but rather a suggestion to consider whether this release should be defined as Beta.
Pinging @aidanheerdegen here for a double-check and further considerations on this.
| @@ -0,0 +1,57 @@ | |||
| # ACCESS‑ISSM (ALPHA RELEASE) | |||
|
|
|||
| {: .img-contain .white-background .round-edges .with-padding .intro-img loading="lazy"} | |||
There was a problem hiding this comment.
The file /assets/model-config-logos/configurations-without-titles/access-issm.png needs to be added.
|
|
||
| {: .img-contain .white-background .round-edges .with-padding .intro-img loading="lazy"} | ||
|
|
||
| The ACCESS Ice Sheet–Shelf System Model (ACCESS‑ISSM) is a global ice‑sheet and ice‑shelf model based on the [ISSM](/models/model_components/ice-sheet) framework. It supports standalone ice dynamics and optional coupling to ocean and atmospheric forcings. This suite is in **alpha**: we welcome feedback and contributions via our GitHub repository. |
There was a problem hiding this comment.
The /models/model_components/ice-sheet page doesn't exist.
Not sure if it's what was intended here, but I would also add which components it includes (with links).
|
|
||
| ## Get help | ||
|
|
||
| Ask questions in the [ACCESS‑ISSM category](https://forum.access-hive.org.au/c/cryosphere/access-issm/) on ACCESS‑Hive, or email **support@access‑nri.org.au** with your suite ID and a log excerpt. |
There was a problem hiding this comment.
| Ask questions in the [ACCESS‑ISSM category](https://forum.access-hive.org.au/c/cryosphere/access-issm/) on ACCESS‑Hive, or email **support@access‑nri.org.au** with your suite ID and a log excerpt. | |
| For further {{ model }} assistance, have a look at [general guidance](/about/user_support/#still-need-help) on how to request help from ACCESS-NRI. Specifically, consider creating a topic in the [{{ model }} category of the ACCESS-Hive Forum](https://forum.access-hive.org.au/c/access-issm/). In the case of a configuration bug, please [raise a GitHub issue](https://github.com/ACCESS-NRI/access-issm/issues/new). |
Just note the forum category is not correct. ACCESS-ISSM category on the forum does not exist. Please change it (with the correct link) to the appropriate category.
| ### {{ model }} configuration | ||
|
|
||
| Key configurable groups (edit the configuration files as needed): | ||
|
|
||
| | Suite | Section | Purpose | | ||
| |-------|--------------------|----------------------------------------------------------------------| | ||
| | **PPS** | Domain setup | Projection, bounds, resolution, MUA/SSA blend law, etc. | | ||
| | | Datasets | Surface mass balance, basal friction, geothermal heat, geometry DEMs | | ||
| | **RUN** | Time-stepping | `INITIAL_CYCLE_POINT`, `FINAL_CYCLE_POINT`, dt, adaptive settings | | ||
| | | Physics options | Flow law, calving, melting parameterisations | | ||
| | | Resources | MPI tasks, OpenMP threads, walltime | | ||
|
|
||
| After editing configurations, simply re-run the corresponding suite’s script. |
There was a problem hiding this comment.
Something like this should be included within the "Edit ACCESS-ISSM configuration" paragraph.
Also not that, unless there are specific instructions to edit some parts, only information about configurations should not be placed in this page, but rather in the model overview page.
| ## 6 Editing job scripts | ||
|
|
||
| Both helper scripts are standard PBS batch files. Typical tweaks: | ||
|
|
||
| | Directive | Default | Change when… | | ||
| | ------------------ | ---------- | ------------------------------------------------------------------ | | ||
| | `#PBS -P` | `au88` | Running under a different project code | | ||
| | `#PBS -l ncpus` | `32` | Mesh resolution < 1 km → reduce to 8–16 ; very high‑res → increase | | ||
| | `#PBS -l walltime` | `48:00:00` | Convergence problems: extend | | ||
|
|
||
| For quick interactive debugging you can run the driver directly inside an *ARE* Desktop or `qsub -I` session: | ||
|
|
||
| ```bash | ||
| $ python mismip_driver.py # uses default steps list | ||
| ``` |
There was a problem hiding this comment.
Please follow the structure used in ACCESS-OM3 edit configuration: write a sub-paragraph for each specific modification that we expect users would want to do, for example:
# Edit {{ model }} configuration
## Change running project
....
## Change mesh resolution
...
## Change walltime
...
Also, changing the walltime is usually not something directly needed, but it's needed in case other changes are in place (or some problems occur). In this case I would still add a paragraph here, and then link it if there are mentions of cases in which a walltime change is needed.
For example I would list the "convergence problem" in troubleshooting and link the "change walltime" paragraph for instructions.
|
Hi @justinh2002, |
|
!redeploy |
We don't have the |
atteggiani
force-pushed
the
justin/929-access-issm-alpha-documentation
branch
from
0bf924a to
837b437
Compare
|
Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>
Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>
Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>
Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>
Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>
- Updated ISSM description - Updated required python version - Added more information about required projects -
atteggiani
force-pushed
the
justin/929-access-issm-alpha-documentation
branch
from
837b437 to
a352d14
Compare
|
@atteggiani There was a problem in the |
That's great! |
atteggiani
force-pushed
the
development
branch
from
254ca6a to
963790e
Compare
7 participants
ACCESS-Hive Docs
This addresses #929, I am creating a preview PR for the alpha release of ACCESS-ISSM. This is not currently ready for review.