Skip to content
Nicholas Hannah edited this page Apr 17, 2015 · 9 revisions

MOM6-examples wiki

The NOAA-GFDL-MOM6-examples repository provides all the configuration data for MOM6 and SIS2 experiments.

The MOM6 and SIS2 source codes are hosted at CommerceGov/NOAA-GFDL-MOM6 and CommerceGov/NOAA-GFDL-SIS2 respectively.

MOM6 repository relationships

The versions of source code that correspond to the versions of experiment configurations and regression tests is recorded via the git-hash of the MOM6 and SIS2 submodules. When you clone NOAA-GFDL-MOM6-examples, the appropriate version of MOM6 and SIS2 is known by git.

Why separate repositories

When the repository only had MOM6-related code and configurations everything worked hunky-dory. But since the configurations and regression tests for SIS2 have appeared we had a version consistency problem between SIS2 source and the regressions. Further, we know there will be more break up of components coming down the line so we've opted for a solution that will allow us to add more components in the future.

Advantages:

  • Versioning of configurations, answers and model source.
  • Commits and branches affecting just source code are limited to the source code repositories.
  • Commits affecting just configurations are limited to the MOM6-examples repository.
  • Deployment of a specific set of configurations is ensured to have a specific version of source codes.
  • Leads to smaller individual repositories so you do not have to download everything at once.

Disadvantages:

  • If you need a branch that changes both source code and configuration/regressions then you now need to create a branch in each repository.
  • It is more complicated than a single mega-repository ... until you get used to it.

To get started, see Installing MOM6 and SIS2.

Policies

The MOM6 repository policies (repository access, branches, procedures, ...) apply to MOM6-examples, MOM6 and SIS2 repositories.