Skip to content
This repository was archived by the owner on Aug 11, 2025. It is now read-only.

Update README.md #301

Merged
aekiss merged 2 commits into from
Jun 6, 2025
Merged

Update README.md #301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e86b16
Update README.md
aekiss Mar 14, 2025
145c6d2
Update README.md
aekiss May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@

# ACCESS-OM3

ACCESS-OM3 is a global coupled ocean - sea ice - wave model being developed by [COSIMA](http://www.cosima.org.au) and [ACCESS-NRI](https://www.access-nri.org.au/).

<i><b>WARNING:</b> this is a very early pre-release development version and doesn't yet work!</i>
ACCESS-OM3 is a global coupled ocean - sea ice - wave model being developed by [COSIMA](http://www.cosima.org.au) and [ACCESS-NRI](https://www.access-nri.org.au/). It consists of MOM6, CICE6 and (optionally) WaveWatch3, coupled with NUOPC and driven by prescribed surface forcing - see [here](https://access-om3-configs.access-hive.org.au/pages/Architecture/).
Copy link
Copy Markdown
Contributor

@chrisb13 chrisb13 May 13, 2025

Choose a reason for hiding this comment

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

To avoid user confusion, I think it's worth highlighting that the new build system doesn't use this repo. I'm just thinking it would be worth being clear about why a user might be interested in looking at this repo (i.e for older alpha builds but not the current or released ones)

Copy link
Copy Markdown
Contributor Author

@aekiss aekiss May 13, 2025

Choose a reason for hiding this comment

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

OK, maybe we should just state up front that this is deprecated?

Copy link
Copy Markdown
Contributor

@chrisb13 chrisb13 Jun 6, 2025

Choose a reason for hiding this comment

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

okay, yeah I think that's a good idea. There's very few people that are going to be wanting to download/browse this I suspect, now added deprecated everywhere, see 99bbc20


# Downloading

NCI-based users of ACCESS-OM3 typically won't need to download this repository, as there are pre-built executables available on NCI (see the [quick start](https://github.com/COSIMA/access-om3/wiki/Quick-start)).
This repository only stores the model source code. Model configurations are available from branches in [github.com/ACCESS-NRI/access-om3-configs](https://github.com/ACCESS-NRI/access-om3-configs), which use pre-built executables available on [NCI](https://nci.org.au/), so NCI-based users of ACCESS-OM3 typically won't need to download this repository unless they need to make model component code changes.
Copy link
Copy Markdown
Contributor

@chrisb13 chrisb13 May 13, 2025

Choose a reason for hiding this comment

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

Worth also including a link to the build repo here do we think? As in https://github.com/aCCESS-NRI/acceSS-OM3 ?

It'll be mentioned here eventually in any case (Yes, that needs to be updated)

Copy link
Copy Markdown
Contributor Author

@aekiss aekiss May 13, 2025

Choose a reason for hiding this comment

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

yes, could you do that pls, as you're more up to date?

Copy link
Copy Markdown
Contributor

@chrisb13 chrisb13 Jun 6, 2025

Choose a reason for hiding this comment

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

okay, so I've done quite a few changes, see 99bbc20


This respository contains submodules, so you will need to clone it with the `--recursive` flag:
```
Expand All @@ -20,13 +18,10 @@ git clone --recursive https://github.com/COSIMA/access-om3.git
To update a previous clone of this repository to the latest version, you will need to do
```
git pull
```
followed by
```
git submodule update --init --recursive
```
to update all the submodules.

# Further information (including building and running the model)
# Documentation (including building and running the model)

See the [ACCESS-OM3 wiki](https://github.com/COSIMA/access-om3/wiki), particularly the [quick start](https://github.com/COSIMA/access-om3/wiki/Quick-start).
See [access-om3-configs.access-hive.org.au](https://access-om3-configs.access-hive.org.au/), particularly the [quick start](https://access-om3-configs.access-hive.org.au/pages/Quick-start/).