Skip to content

Update Architecture.md with source code lookup tip#1128

Open
aekiss wants to merge 2 commits intomainfrom
aekiss-src-lookup-doc
Open

Update Architecture.md with source code lookup tip#1128
aekiss wants to merge 2 commits intomainfrom
aekiss-src-lookup-doc

Conversation

@aekiss
Copy link
Contributor

@aekiss aekiss commented Feb 12, 2026

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?

  • Yes
  • N/A

A PR has been created for updating the documentation?

  • Yes: this is it!
  • N/A

8. Formatting

N/A

Changes to MOM_input have been copied from model output in docs/MOM_parameter_docs.short?

  • Yes
  • N/A

9. Merge Strategy

  • Merge commit
  • Rebase and merge
  • Squash
  • Whatever takes your fancy

Added a tip for using the ACCESS-NRI Model Release Database to determine the source code used in model components.
@github-actions
Copy link

github-actions bot commented Feb 12, 2026

PR Preview
🚀 Preview of PR head commit 2bf5950 deployed to https://access-om3-configs.access-hive.org.au/pr-previews/1128
2026-02-13 15:41 AEDT
Preview generated through the Deploy to GitHub Pages workflow run 21974934594.

@aekiss
Copy link
Contributor Author

aekiss commented Feb 12, 2026

ping @jbisits FYI

@aekiss
Copy link
Contributor Author

aekiss commented Feb 12, 2026

@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

@chrisb13
Copy link
Collaborator

Thanks @aekiss.

Note this is related to:
ACCESS-Community-Hub/decoding-om3#9

Maybe worth adding a link?

(Still need to fix a few small things on that PR so that's it's merged.)

Copy link
Collaborator

@atteggiani atteggiani left a comment

Choose a reason for hiding this comment

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

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)

Copy link
Collaborator

Choose a reason for hiding this comment

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

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)

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.

3 participants