ACCESS-OM2: Release Information

ACCESS-OM2

ACCESS-OM2 is a global coupled Ocean-Sea Ice Model developed by COSIMA.

ACCESS-NRI Support

ACCESS-NRI has assumed responsibility for supporting ACCESS-OM2 for the Australian Research Community. As part of this support ACCESS-NRI has developed a new build and deployment system for ACCESS-OM2 to align with plans for supporting a range of Earth System Models.

Release

ACCESS-NRI is releasing its first supported version of the ACCESS-OM2 model.

This version uses the spack package management system to build and deploy the model. This is a very different system from that used by COSIMA, however it is bit-reproducible with the equivalent COSIMA ACCESS-OM2 build.

This release is enabled by a modern DevOps build, test and deployment pipeline developed at ACCESS-NRI. This core software infrastructure will be used to build, test and deploy all ACCESS-NRI models in future, improving efficiency, reliability and reproducibility. All DevOps pipelines are configured and run from GitHub, so they are open and discoverable, including software deployments at NCI.

The key components of the DevOps pipeline:

  1. Continuous Integration (CI) testing
    Modular, centrally maintained and makes it trivial to add to any model code repository, allowing ACCESS-NRI to scale to support many models simultaneously.

  2. Continuous Deployment (CD) of software
    Modular automated continuous deployment pipeline on NCI. Efficiency makes supporting many models possible. Provides reliable and timely model releases to the community.

  3. Spack, a build-from-source package manager for software building and deployment
    All ACCESS-OM2 components now support being built and managed by the spack package manager. Spack is an essential element in the CI build and deployment pipeline: it facilitates building the complex software ecosystem necessary to build modern climate models reproducibly, reliably and across many platforms.

Who is this for?

This initial release can be used by anyone, though only a subset of model configurations are currently supported (see below). This initial release is a proof of concept of our automated deployment pipeline. We welcome any feedback.

There are plans for more extensive support, including upgrades to tools and easy access to model metadata and provenance information. Using the ACCESS-NRI released model now provides improved provenance immediately and more comprehensive testing and quality assurance in the future.

How to use the model

It is necessary to be a member of vk83 project to use ACCESS-NRI deployments of ACCESS-OM2. See NCI Documentation for more information about how to join a project.

Model Configurations

The supported method to use ACCESS-NRI released ACCESS-OM2 model versions is via supported model configurations, which utilise them.

ACCESS-NRI supported configurations are available in this repository:

ACCESS-NRI will be supporting the standard ACCESS-OM2 model configurations, namely 1°, 0.25° and 0.1° global simulations with Interannual (IAF) and Repeat Year Forcing (RYF) based on JRA55-do reanalysis.

The 1° global configrations are the first to be supported with this first release of the ACCESS-NRI supported versions of the models. More supported model configurations will be added as time and resources permit, and will be announced using this topic.

Environment modules

ACCESS-OM2 is also available through the NCI environment module system. The model is deployed using spack, so models are released within a specific spack version.

To access these modules:

module use /g/data/vk83/apps/spack/0.20/release/modules/linux-rocky8-x86_64

To see available access-om2 modules:

module avail access-om2

which produces

----- /g/data/vk83/apps/spack/0.20/release/modules/linux-rocky8-x86_64 -----
access-om2/2023.11.23  

and to load a particular version

module load access-om2/2023.11.22

which produces

Loading access-om2/2023.11.23
  Loading requirement: oasis3-mct/2023.11.09 libaccessom2/2023.10.26 cice5/2023.10.19 mom5/2023.11.09

The access-om2 module loads modules for specific model component versions.

Using module load will add the locations of the model component executables to your $PATH environment variable, as well as set other variables.

You can get some more information from a module with module show, e.g.

$ module show mom5/2023.11.09
-------------------------------------------------------------------
/g/data/vk83/apps/spack/0.20/release/modules/linux-rocky8-x86_64/mom5/2023.11.09:

module-whatis   {MOM is a numerical ocean model based on the hydrostatic primitive equations.}
module          load libaccessom2/2023.10.26
module          load oasis3-mct/2023.11.09
conflict        mom5
prepend-path    --delim : PATH /g/data/vk83/apps/spack/0.20/release/linux-rocky8-x86_64/intel-19.0.5.281/mom5-git.2023.11.09=2023.11.09-ewcdbrfukblyjxpkhd3mfkj4yxfolal4/bin
prepend-path    --delim : CMAKE_PREFIX_PATH /g/data/vk83/apps/spack/0.20/release/linux-rocky8-x86_64/intel-19.0.5.281/mom5-git.2023.11.09=2023.11.09-ewcdbrfukblyjxpkhd3mfkj4yxfolal4/.
setenv          SPACK_MOM5_ROOT /g/data/vk83/apps/spack/0.20/release/linux-rocky8-x86_64/intel-19.0.5.281/mom5-git.2023.11.09=2023.11.09-ewcdbrfukblyjxpkhd3mfkj4yxfolal4
-------------------------------------------------------------------

Currently modules are provided as an information source to help expose what models are deployed and supported at NCI. Using the models via modules will be supported in the future, but this is not a currently supported mode of use.

What should I do to be notified of any updates?

You can watch this topic, and be notified by email of every update to released versions.

All released ACCESS-OM2 models are deployed directly from the GitHub repository and the releases page contains information of all releases, including detailed information of the build provenance and deployment location:

Where do I ask questions?

Replies to this topic are disabled.

If you have specific questions about this release follow the guidelines for requesting help from ACCESS-NRI.

If you have questions about access-om2 create a topic in COSIMA and tag it with access-om2. If you require assistance follow the guidelines for requesting help from ACCESS-NRI.

6 Likes

12/04/2024

ACCESS-OM2 Release Update

New configurations

ACCESS-NRI has released global 1°, 0.25° and 0.1° physics only and biogeochemical (ocean-bgc) configurations of ACCESS-OM2 with both repeat-year and interannual JRA55-do forcing.

There are twelve configurations in total. Experiments configurations are stored as separate specially named branches beginning with release- in the access-om2-configs repository. where you can also find instructions on how to access the configurations.

The ACCESS-Hive instructions for using the ACCESS-OM2 model have also been updated to use ACCESS-NRI infrastructure.

Details of the releases are here:

All the configurations that are being released today use the ACCESS-OM2 model version 2024.03.0 that has restart reproducibility enabled and so are not bitwise reproducible with the equivalent COSIMA configurations on which they are based.

For more information on restart reproducibility and ACCESS-OM2:

Configuration versioning

Model configurations use a MAJOR.MINOR versioning scheme (a modified semantic versioning (semver) scheme).

In this scheme the two components of the version have the following semantic meaning:

  • MAJOR : indicates changes in bitwise reproducibility
  • MINOR : any other change that does not change bitwise reproducibility

What does this mean?

Any configuration that has the same MAJOR version as another version of the same configuration is bitwise comparable, i.e. those experiments are directly comparable within scientific limitations.

Configurations are bitwise reproducible within MAJOR versions. For example, if a configuration is versioned as 2.3, it is bitwise reproducible with any other 2.X configuration.

What version are these released configurations?

All the configurations that are part of this release are versioned as 2.0 as they are not bitwise reproducible with the equivalent COSIMA configurations on which they are based.

Automated Testing

Automated continuous integration (CI) testing has been added to the access-om2-configs repository.

What does this mean?

Every time there is an update to a release-* configuration branch Quality Assurance (QA) checks ensure the model configuration doesn’t have any easily detectable errors. This helps ensure released configurations are of high quality and helps configuration developers avoid common errors.

If QA checks pass then reproducibility checks are done: the configuration is run on gadi for a very short time (typically a day) and a comparison made between the model state and the same model state from the previous version of the configuration. Short runs are also done to test for restart reproducibility.

What if it is bitwise reproducible?

If the model reproduces previous results it is bitwise reproducible. If the proposed changes are merged into the release- configuration the configuration MINOR version is incremented, e.g. if the current version is 2.5 the new version would be 2.6.

What if it isn’t bitwise reproducible?

If the model doesn’t reproduce previous results it is not bitwise reproducible. If the proposed changes are merged into the release- configuration the configuration MAJOR version is incremented and the MINOR version set to zero, e.g. if the current version is 2.5 the new version would be 3.0. In this case the reproducibility checksums that represent the model state would also be updated to the values for the new MAJOR version.

Release

When a change to release- branch is merged the version is always updated. This also triggers the merge commit to be automatically tagged. The tag contains the branch name with the version appended, and this also automatically creates a release that is visible in the release page

The releases page contains details of the changes for each release, and is a useful source of information about configurations.

Why is this testing important?

Automatic reproducibility testing means configurations will not be altered and change bitwise reproducibility without that being obvious (change in MAJOR version). It makes it clear what experiments are comparable and provides certainty.

The testing is also part of the automated release process, so you can be certain that the configuration used for your experiments has been tested and tagged appropriately.

Where do I ask questions?

Replies to this topic are disabled.

If you have specific questions about this release follow the guidelines for requesting help from ACCESS-NRI .

If you have questions about access-om2 create a topic in COSIMA and tag it with access-om2. If you require assistance follow the guidelines for requesting help from ACCESS-NRI .

19/04/2024

Updated to include released 0.25° configurations

22/04/2024

Updated to include link to ACCESS-OM2 model version release.

4 Likes