Update Architecture.md with source code lookup tip#1128
Open
Conversation
Added a tip for using the ACCESS-NRI Model Release Database to determine the source code used in model components.
|
Contributor
Author
|
ping @jbisits FYI |
aekiss
commented
Feb 12, 2026
Contributor
Author
|
@atteggiani I'm not sure how to format it so all my added text is inside a tip box, and the enumerated list displays correctly |
Collaborator
|
Thanks @aekiss. Note this is related to: Maybe worth adding a link? (Still need to fix a few small things on that PR so that's it's merged.) |
atteggiani
requested changes
Feb 13, 2026
Collaborator
atteggiani
left a comment
There was a problem hiding this comment.
Thank you @aekiss,
I added a suggestion for rendering the numbered list within the tip admonition as you intended.
Comment on lines
+22
to
+28
| !!! tip | ||
| To determine the exact source code used in the model components in a configuration, | ||
| 1. find the access-om3 module version in `config.yaml` ([e.g. here](https://github.com/ACCESS-NRI/access-om3-configs/blob/release-MC_25km_jra_iaf-1.0-beta/config.yaml#L22)) | ||
| 2. click the corresponding link in the [ACCESS-NRI Model Release Database](https://reporting.access-nri-store.cloud.edu.au/release-provenance/releases) | ||
| 3. click the grey GitHub logo for the component of interest | ||
| 4. click the tag icon to view the source code (note, however, that GitHub searches are restricted to the latest commit on the main branch) | ||
|
|
Collaborator
There was a problem hiding this comment.
The text inside an admonition (e.g. !!! tip) needs to be indented with 4 spaces (or a tab).
And (in the majority of cases) the numbered points need to be separated with a blank line for mkdocs to recognise them.
This should work:
Suggested change
| !!! tip | |
| To determine the exact source code used in the model components in a configuration, | |
| 1. find the access-om3 module version in `config.yaml` ([e.g. here](https://github.com/ACCESS-NRI/access-om3-configs/blob/release-MC_25km_jra_iaf-1.0-beta/config.yaml#L22)) | |
| 2. click the corresponding link in the [ACCESS-NRI Model Release Database](https://reporting.access-nri-store.cloud.edu.au/release-provenance/releases) | |
| 3. click the grey GitHub logo for the component of interest | |
| 4. click the tag icon to view the source code (note, however, that GitHub searches are restricted to the latest commit on the main branch) | |
| !!! tip | |
| To determine the exact source code used in the model components in a configuration: | |
| 1. find the access-om3 module version in `config.yaml` ([e.g. here](https://github.com/ACCESS-NRI/access-om3-configs/blob/release-MC_25km_jra_iaf-1.0-beta/config.yaml#L22)) | |
| 2. click the corresponding link in the [ACCESS-NRI Model Release Database](https://reporting.access-nri-store.cloud.edu.au/release-provenance/releases) | |
| 3. click the grey GitHub logo for the component of interest | |
| 4. click the tag icon to view the source code (note, however, that GitHub searches are restricted to the latest commit on the main branch) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
1. Summary:
Added a tip for using the ACCESS-NRI Model Release Database to determine the source code used in model components.
2. Issues Addressed:
N/A
3. Dependencies (e.g. on payu, model or om3-scripts)
N/A
4. Ad-hoc Testing
N/A
5. CI Testing
N/A
6. Reproducibility
N/A
7. Documentation
Yes, docs only
The docs folder has been updated with output from running the model?
A PR has been created for updating the documentation?
8. Formatting
N/A
Changes to MOM_input have been copied from model output in docs/MOM_parameter_docs.short?
9. Merge Strategy