Skip to content

Set up M_regional_template branch #1493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dougiesquire wants to merge 14 commits into
base: M_regional_template
Choose a base branch
from
Open

Set up M_regional_template branch #1493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6009d59
Updates to run with latest exe
dougiesquire Jul 3, 2026
3b5ef2a
Tidy up MOM_input
dougiesquire Jul 3, 2026
90a6d62
increase output freq
ashjbarnes Aug 5, 2026
c0ab2ab
Specify inputs in regional-mom6 friendly way
ashjbarnes Aug 6, 2026
20a9cc1
turn off input manifest checking
ashjbarnes Aug 7, 2026
3dc2ca8
update domain extents to match 10th degree demo. Was 20th deg
ashjbarnes Aug 7, 2026
94a84e5
remove explicit new_file_freq so modifying run length is simpler
ashjbarnes Aug 7, 2026
758646b
the controversial era5 commit
ashjbarnes Aug 7, 2026
9c433db
remove unneeded jra surface files
ashjbarnes Aug 10, 2026
b53c9ff
rename demo expt
ashjbarnes Aug 11, 2026
8ac7137
update mom_override
ashjbarnes Aug 11, 2026
468dcd4
update-readme
ashjbarnes Aug 11, 2026
1fb7eec
MOM_override comment patch
ashjbarnes Aug 11, 2026
61ac1d9
adding the notebook used to create the input files and the .pbs scrip…
helenmacdonald Aug 12, 2026
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
69 changes: 45 additions & 24 deletions MOM_input
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
! This section contains non default debugging parameters which are set.
! ------------------------
i! === module MOM ===
VERBOSITY = 9 ! default = 2
! Integer controlling level of messaging
! 0 = Only FATAL messages
! 2 = Only FATAL, WARNING, NOTE [default]
! 9 = All)

! === module MOM_vert_friction ===
U_TRUNC_FILE = "U_velocity_truncations" ! default = ""
! The absolute path to a file into which the accelerations leading to zonal
Expand All @@ -18,7 +11,7 @@ V_TRUNC_FILE = "V_velocity_truncations" ! default = ""
! diagnostic is not needed.

! === module MOM_file_parser ===
FATAL_UNUSED_PARAMS = False ! [Boolean] default = False
FATAL_UNUSED_PARAMS = True ! [Boolean] default = False
! If true, kill the run if there are any unused parameters.

! This section contains non default layout parameters which are set.
Expand Down Expand Up @@ -136,7 +129,7 @@ NK = 75 ! [nondim]
! The number of model layers.

! === module MOM_EOS ===
EQN_OF_STATE = "WRIGHT_REDUCED" ! default = "WRIGHT"
EQN_OF_STATE = "WRIGHT_REDUCED" ! default = "WRIGHT_FULL"
! EQN_OF_STATE determines which ocean equation of state should be used.
! Currently, the valid choices are "LINEAR", "UNESCO", "JACKETT_MCD", "WRIGHT",
! "WRIGHT_REDUCED", "WRIGHT_FULL", "NEMO", "ROQUET_RHO", "ROQUET_SPV" and
Expand All @@ -146,11 +139,6 @@ DTFREEZE_DP = -7.75E-08 ! [degC Pa-1] default = 0.0
! temperature with pressure.

! === module MOM_tracer_flow_control ===
USE_generic_tracer = True ! [Boolean] default = False
! If true and _USE_GENERIC_TRACER is defined as a preprocessor macro, use the
! MOM_generic_tracer packages.

! === module register_MOM_generic_tracer ===

! === module MOM_boundary_update ===

Expand Down Expand Up @@ -189,9 +177,24 @@ ALE_COORDINATE_CONFIG = "FILE:vcoord.nc,interfaces=zi" ! default = "UNIFORM"
! FNC1:string - FNC1:dz_min,H_total,power,precision
! HYBRID:string - read from a file. The string specifies
! the filename and two variable names, separated
! by a comma or space, for sigma-2 and dz. e.g.
! HYBRID:vgrid.nc,sigma2,dz
!ALE_RESOLUTION = 11.092098076435915, 11.12589544733533, 11.165918086620376, 11.213306058249117, 11.269405557709561, 11.335805113860857, 11.414377717524317, 11.507329670725412, 11.617256981273385, 11.747210121002269, 11.900767900902267, 12.082121062640923, 12.296165903074183, 12.548607782597145, 12.846073650390167, 13.196231663509366, 13.607914479412557, 14.091240747579036, 14.657726598738321, 15.320375433883754, 16.093730012474765, 16.993865811613148, 18.03829916245229, 19.245778371728136, 20.63592195573483, 22.22866685820685, 24.043493287542788, 26.098404231537188, 28.408659426442966, 30.985297348839254, 33.83352429499399, 36.951102794253245, 40.32692362139596, 43.93998287341037, 47.75899167530645, 51.74280691482443, 55.84178142011456, 60.0, 64.15821857988544, 68.25719308517557, 72.24100832469344, 76.06001712658963, 79.67307637860404, 83.0488972057467, 86.16647570500595, 89.01470265116063, 91.59134057355709, 93.90159576846281, 95.95650671245721, 97.7713331417931, 99.36407804426517, 100.75422162827181, 101.96170083754782, 103.00613418838702, 103.90626998752532, 104.67962456611622, 105.34227340126154, 105.90875925242108, 106.39208552058744, 106.80376833649052, 107.15392634960972, 107.45139221740283, 107.70383409692568, 1
! by a comma or space, for sigma-2 and dz.
! e.g. HYBRID:vgrid.nc,sigma2,dz
! HYBRID_3D:string - read from a file. The string specifies
! the filename and two 3D variable names, separated
! by a comma or space, for sigma-2 and dz. The
! latter can be FNC1:string which is used everywhere.
! e.g. HYBRID_3D:vgrid.nc,sigma2,dz
! HYBRID_MAP:string - read from a file. The string specifies
! the filename and three variable names, separated
! by a comma or space, for map, sigma-2 and dz.
! Map is a spatial index array with, maxval(map)=N,
! and the others are 2D arrays containing N profiles.
! Map typically contains integer values, but it can
! contain real values, I+w, which imply using
! the weighted sum of profiles I and I+1.
! Dz can be FNC1:string which is used everywhere.
! e.g. HYBRID_MAP:vgrid.nc,map,sigma2,dz
!ALE_RESOLUTION = 4.821854240081545, 4.859984607250117, 4.905138354135806, 4.958601706742593, 5.021893449723606, 5.0968057694840425, 5.185451783873582, 5.290320654151742, 5.414341209641762, 5.560955008310259, 5.734199683069228, 5.938803250158976, 6.180289736801626, 6.465095959853201, 6.800698477363284, 7.195748543446456, 7.660211207542389, 8.205502381884045, 8.844614624217613, 9.592218438227832, 10.46472103971513, 11.48025886438404, 12.658593926869258, 14.02087816297535, 15.589245283393126, 17.38618825028462, 19.433684734663643, 21.752045799682975, 24.358487558038235, 27.265463675613546, 30.478847922557293, 33.996115973003725, 37.804734342087784, 41.881006318719415, 46.18963163367914, 50.68419241672501, 55.30867647397531, 60.0, 64.69132352602458, 69.31580758327505, 73.81036836632086, 78.11899368128059, 82.19526565791216, 86.00388402699627, 89.5211520774426, 92.73453632438645, 95.64151244196182, 98.24795420031705, 100.56631526533624, 102.6138117497153, 104.41075471660679, 105.97912183702465, 107.34140607313066, 108.51974113561573, 109.53527896028481, 110.40778156177203, 111.15538537578232, 111.79449761811611, 112.33978879245751, 112.80425145655363, 113.19930152263669, 113.53490404014701, 113.81971026319843, 114.0611967498
REMAPPING_SCHEME = "PPM_H4" ! default = "PLM"
! This sets the reconstruction scheme used for vertical remapping for all
! variables. It can be one of the following schemes:
Expand All @@ -216,7 +219,7 @@ INIT_LAYERS_FROM_Z_FILE = True ! [Boolean] default = False
! Z-space file on a latitude-longitude grid.

! === module MOM_initialize_layers_from_Z ===
TEMP_SALT_Z_INIT_FILE = "init_tracers_mod.nc" ! default = "temp_salt_z.nc"
TEMP_SALT_Z_INIT_FILE = "init_tracers.nc" ! default = "temp_salt_z.nc"
! The name of the z-space input file used to initialize temperatures (T) and
! salinities (S). If T and S are not in the same file, TEMP_Z_INIT_FILE and
! SALT_Z_INIT_FILE must be set.
Expand Down Expand Up @@ -267,8 +270,23 @@ DIAG_COORD_DEF_Z = "FILE:vcoord.nc,interfaces=zi" ! default = "WOA09"
! FNC1:string - FNC1:dz_min,H_total,power,precision
! HYBRID:string - read from a file. The string specifies
! the filename and two variable names, separated
! by a comma or space, for sigma-2 and dz. e.g.
! HYBRID:vgrid.nc,sigma2,dz
! by a comma or space, for sigma-2 and dz.
! e.g. HYBRID:vgrid.nc,sigma2,dz
! HYBRID_3D:string - read from a file. The string specifies
! the filename and two 3D variable names, separated
! by a comma or space, for sigma-2 and dz. The
! latter can be FNC1:string which is used everywhere.
! e.g. HYBRID_3D:vgrid.nc,sigma2,dz
! HYBRID_MAP:string - read from a file. The string specifies
! the filename and three variable names, separated
! by a comma or space, for map, sigma-2 and dz.
! Map is a spatial index array with, maxval(map)=N,
! and the others are 2D arrays containing N profiles.
! Map typically contains integer values, but it can
! contain real values, I+w, which imply using
! the weighted sum of profiles I and I+1.
! Dz can be FNC1:string which is used everywhere.
! e.g. HYBRID_MAP:vgrid.nc,map,sigma2,dz

! === module MOM_lateral_mixing_coeffs ===

Expand Down Expand Up @@ -321,6 +339,9 @@ CORIOLIS_SCHEME = "SADOURNY75_ENSTRO" ! default = "SADOURNY75_ENERGY"
! ARAKAWA_LAMB81 - Arakawa & Lamb, 1981; En. + Enst.
! ARAKAWA_LAMB_BLEND - A blend of Arakawa & Lamb with
! Arakawa & Hsu and Sadourny energy
! WENOVI5TH_PV_ENSTRO - 5th-order WENO PV enstrophy
! WENOVI3RD_PV_ENSTRO - 3rd-order WENO PV enstrophy
! WENOVI7TH_PV_ENSTRO - 7th-order WENO PV enstrophy
BOUND_CORIOLIS = True ! [Boolean] default = False
! If true, the Coriolis terms at u-points are bounded by the four estimates of
! (f+rv)v from the four neighboring v-points, and similarly at v-points. This
Expand All @@ -346,8 +367,6 @@ SMAG_BI_CONST = 0.06 ! [nondim] default = 0.0
HMIX_FIXED = 0.5 ! [m]
! The prescribed depth over which the near-surface viscosity and diffusivity are
! elevated when the bulk mixed layer is not used.
MAXVEL = 6.0 ! [m s-1] default = 3.0E+08
! The maximum velocity allowed before the velocity components are truncated.

! === module MOM_barotropic ===
BOUND_BT_CORRECTION = True ! [Boolean] default = False
Expand Down Expand Up @@ -455,10 +474,10 @@ EPBL_MSTAR_SCHEME = "REICHL_H18" ! default = "CONSTANT"
! REICHL_H18 - Use the scheme documented in Reichl & Hallberg, 2018.
MSTAR_CAP = 10.0 ! [nondim] default = -1.0
! If this value is positive, it sets the maximum value of mstar allowed in ePBL.
! (This is not used if EPBL_MSTAR_SCHEME = CONSTANT).
! (This is not used if EPBL_mstar_scheme = CONSTANT).
RH18_MSTAR_CN3 = -6.0 ! [nondim] default = -5.0
! MSTAR_N coefficient 3 (exponential decay coefficient). The value of -5.0 is
! given in RH18. Increasing this increases how quickly the value of MSTAR
! given in RH18. Increasing this increases how quickly the value of mstar
! decreases as Hf/ust increases.
NSTAR = 0.06 ! [nondim] default = 0.2
! The portion of the buoyant potential energy imparted by surface fluxes that is
Expand Down Expand Up @@ -514,6 +533,8 @@ CHECK_DIFFUSIVE_CFL = True ! [Boolean] default = False
! of 1 or MAX_TR_DIFFUSION_CFL iteration.

! === module MOM_sum_output ===
MAXVEL = 6.0 ! [m s-1] default = 3.0E+08
! The maximum velocity allowed before the velocity components are truncated.

! === module ocean_stochastics_init ===

Expand Down
65 changes: 34 additions & 31 deletions MOM_override
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
! === Added with RM6 ===
#override MINIMUM_DEPTH = 4.5 !None
#override OBC_NUMBER_OF_SEGMENTS = 4 !None
#override OBC_FREESLIP_VORTICITY = False !None
#override OBC_FREESLIP_STRAIN = False !None
#override OBC_COMPUTED_VORTICITY = True !None
#override OBC_COMPUTED_STRAIN = True !None
#override OBC_ZERO_BIHARMONIC = True !None
#override OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT = 3.0E+04 !None
#override OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN = 3000.0 !None
#override BRUSHCUTTER_MODE = True !None
#override OBC_SEGMENT_001 = "J=N,I=N:0,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN" !None
#override OBC_SEGMENT_001_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0 !None
#override OBC_SEGMENT_001_DATA = "U=file:obgc_obc.nc(u),V=file:obgc_obc.nc(v),SSH=file:obgc_obc.nc(eta),TEMP=file:obgc_obc.nc(temp),SALT=file:obgc_obc.nc(salt)"
#override OBC_SEGMENT_002 = "J=0,I=0:N,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN" !None
#override OBC_SEGMENT_002_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0 !None
#override OBC_SEGMENT_002_DATA = "U=file:obgc_obc.nc(u),V=file:obgc_obc.nc(v),SSH=file:obgc_obc.nc(eta),TEMP=file:obgc_obc.nc(temp),SALT=file:obgc_obc.nc(salt)"
#override OBC_SEGMENT_003 = "I=N,J=0:N,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN" !None
#override OBC_SEGMENT_003_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0 !None
#override OBC_SEGMENT_003_DATA = "U=file:obgc_obc.nc(u),V=file:obgc_obc.nc(v),SSH=file:obgc_obc.nc(eta),TEMP=file:obgc_obc.nc(temp),SALT=file:obgc_obc.nc(salt)"
#override OBC_SEGMENT_004 = "I=0,J=N:0,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN" !None
#override OBC_SEGMENT_004_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0 !None
#override OBC_SEGMENT_004_DATA = "U=file:obgc_obc.nc(u),V=file:obgc_obc.nc(v),SSH=file:obgc_obc.nc(eta),TEMP=file:obgc_obc.nc(temp),SALT=file:obgc_obc.nc(salt)"
#override TIDES = False !None
#override OBC_TIDE_ADD_EQ_PHASE = False !None
#override OBC_TIDE_N_CONSTITUENTS = 0 !None
#override OBC_TIDE_CONSTITUENTS = "0" !None
#override OBC_TIDE_REF_DATE = 2017, 1, 1 !None
! Use this file for overriding MOM_input variables.
! For regional experiments, it's good practice to keep all of of the variables
! defining your experiment here, rather than in MOM_input.
! Note that if a variable is overriden twice, MOM6 will throw a fatal error.
! === User added overrides below ===

&MOM_memory_nml
SYMMETRIC_MEMORY = True
/

! === Settings added with regional-mom6 below ===
#override MINIMUM_DEPTH = 10.0
#override NK = 75
#override NIGLOBAL = 70
#override NJGLOBAL = 125
#override AUTO_MASKTABLE = True
#override OBC_NUMBER_OF_SEGMENTS = 4
#override OBC_FREESLIP_VORTICITY = False
#override OBC_FREESLIP_STRAIN = False
#override OBC_COMPUTED_VORTICITY = True
#override OBC_COMPUTED_STRAIN = True
#override OBC_ZERO_BIHARMONIC = True
#override OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT = 3.0E+04
#override OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN = 3000.0
#override BRUSHCUTTER_MODE = True
#override OBC_SEGMENT_001 = "J=N,I=N:0,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN"
#override OBC_SEGMENT_001_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0
#override OBC_SEGMENT_001_DATA = "U=file:forcing_obc_segment_001.nc(u),V=file:forcing_obc_segment_001.nc(v),SSH=file:forcing_obc_segment_001.nc(eta),TEMP=file:forcing_obc_segment_001.nc(temp),SALT=file:forcing_obc_segment_001.nc(salt)"
#override OBC_SEGMENT_002 = "J=0,I=0:N,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN"
#override OBC_SEGMENT_002_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0
#override OBC_SEGMENT_002_DATA = "U=file:forcing_obc_segment_002.nc(u),V=file:forcing_obc_segment_002.nc(v),SSH=file:forcing_obc_segment_002.nc(eta),TEMP=file:forcing_obc_segment_002.nc(temp),SALT=file:forcing_obc_segment_002.nc(salt)"
#override OBC_SEGMENT_003 = "I=N,J=0:N,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN"
#override OBC_SEGMENT_003_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0
#override OBC_SEGMENT_003_DATA = "U=file:forcing_obc_segment_003.nc(u),V=file:forcing_obc_segment_003.nc(v),SSH=file:forcing_obc_segment_003.nc(eta),TEMP=file:forcing_obc_segment_003.nc(temp),SALT=file:forcing_obc_segment_003.nc(salt)"
#override OBC_SEGMENT_004 = "I=0,J=N:0,FLATHER,ORLANSKI,NUDGED,ORLANSKI_TAN,NUDGED_TAN"
#override OBC_SEGMENT_004_VELOCITY_NUDGING_TIMESCALES = 0.3, 360.0
#override OBC_SEGMENT_004_DATA = "U=file:forcing_obc_segment_004.nc(u),V=file:forcing_obc_segment_004.nc(v),SSH=file:forcing_obc_segment_004.nc(eta),TEMP=file:forcing_obc_segment_004.nc(temp),SALT=file:forcing_obc_segment_004.nc(salt)"
! === End settings added with regional-mom6. ===
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# MOM6-CICE6 1 deg JRA55-do IAF ACCESS-OM3 configuration
# Template configuration for regional OM3 forced with ERA5 and GLORYS

**WARNING: This configuration is still under development and should not be used for production.**
This configuration serves two purposes:

1. It is a template used by the regional-mom6/ACCESS-rOM3 workflow for generic, relocatable regional configurations of MOM6. The template matches the [Tasmania demo](https://github.com/COSIMA/regional-mom6/blob/main/demos/ACCESS-rOM3-demo.ipynb). See https://github.com/COSIMA/regional-mom6/ and associated documentation for details.
2. This configuration serves as a case for the global OM3 development team to test against.

**WARNING: Unlike other configurations, this is used to set up generic regional OM3 configurations using the regional-mom6 software package. Such domains aren't immediately producion ready, and the user needs to undertake validation and testing**

See [`main` branch
README](https://github.com/COSIMA/MOM6-CICE6/blob/main/README.md) for usage
information.

## Features

- data atmosphere (DATM) = JRA55-do v1-4, IAF 1958-2018
- data atmosphere (DATM) = ERA5 modified by the regional-mom6 package to fit chosen domain
- data runoff (DROF) = JRA55-do v1-4, IAF 1958-2018
- tripolar grid

## Requirements

Expand Down
Loading