Skip to content

Add mizuRoute compsets, PE layouts and tests and updates to Tech Note/User's Guide - #920

Merged
ekluzek merged 100 commits into
ESCOMP:b4b-devfrom
ekluzek:add_mizuRoute
Mar 10, 2026
Merged

Add mizuRoute compsets, PE layouts and tests and updates to Tech Note/User's Guide#920
ekluzek merged 100 commits into
ESCOMP:b4b-devfrom
ekluzek:add_mizuRoute

Conversation

@ekluzek

@ekluzek ekluzek commented Feb 7, 2020

Copy link
Copy Markdown
Contributor

Description of changes

Start bringing in mizuRoute as a submodule and two compsets that will exercise it, including PE layouts for the grids. As well as a few tests for it in the aux_clm and ctsm_sci test suites.

Default grids will use the half degree mizuRoute grid that is the same as the MOSART grid.

Also in order to get mizuRoute working, change the capitalization of the directory to mizuRoute which is expected in cime, and required for it to work correctly.

Main grids to use with mizuRoute:

  • 5x5_amazon_r05 - is the small Amazon region for testing
  • 5x5_amazon_rHDMA - is the small Amazon region using the HDMA for mizuRoute
  • nldas2_nldas2_rUSGS_mnldas2 - is the Continental US grid with USGS Geospatial Fabric
  • f09_f09_rHDMA_mg17 - is the 2 degree grid with the medium resolution HDMA grid
  • f09_f09_rHDMAlk_mg17 - is the 2 degree grid with the medium resolution HDMA grid that includes lakes
  • hcru_hcru_rMERIT_mt13 - is the half degree grid with the high resolution MERIT grid

Standard case to run with mizuRoute:

grid=f09_f09_rHDMAlk_mg17 compset=I2000Clm60SpMizGs

Specific notes

Contributors other than yourself, if any: @serbinsh @nmizukami

CTSM Issues Fixed (include github issue #):

Are answers expected to change (and if so in what way)? No (unless running with mizuRoute)

Any User Interface Changes (namelist or namelist defaults changes)? New compsets
I2000Clm60SpMizGs
I2000Clm60SpMizGsNldas

Testing performed, if any: regular
Individual tests with mizuRoute at several different resolutions have been tested
mizu testlist was run, and the derecho_intel tests pass, #3808 documents remaining issues
ctsm_sci testlist was also run

@ekluzek ekluzek added enhancement new capability or improved behavior of existing capability PR status: work in progress labels Feb 7, 2020
@ekluzek ekluzek self-assigned this Feb 7, 2020
@ekluzek

ekluzek commented Mar 21, 2020

Copy link
Copy Markdown
Contributor Author

There's at least one change needed in CMEPS. ESCOMP/CMEPS#57

@ekluzek

ekluzek commented Mar 21, 2020

Copy link
Copy Markdown
Contributor Author

At this point the test case will build and link, and fails midway in initialization.

SMS_D_Vnuopc.f09_g17.I2000Clm50SpMizGs.cheyenne_intel.mizuroute-default

@ekluzek

ekluzek commented Apr 18, 2020

Copy link
Copy Markdown
Contributor Author

We have more progress with running with a MOSART mesh with no ocean. It initializes and runs a single time step. There are changes in: cime, CMEPS, ctsm, and mizuRoute to make that happen.

@ekluzek
ekluzek marked this pull request as draft June 4, 2020 22:42
 Conflicts:
	Externals.cfg
	Externals_cime.cfg
…e we are pointing to the cime branch needed to work with mizuRoute
Misc bfb enhancements and fixes

(1) If CISM is running over Antarctica, use virtual glacier columns over
    Antarctica

(2) Remove "mec" from some glacier/ice variable names (it is misleading
    to have "mec" in variable names when the ice landunit can actually
    have multiple columns *or* a single column) (ESCOMP#1294)

(3) Add history file metadata on each variable's l2g_scale_type (adds a
    landunit_mask attribute) (ESCOMP#1343)

(4) Use python3 in more shebang lines - needed to run python unit tests
    on cheyenne

(5) New compset naming for IG compsets (ESCOMP#1289)

(6) Remove calculation of fun_cost_fix that is overwritten
    (ESCOMP#1115)

(7) Bypass grid-level water mass check when fates hydro is active
    (ESCOMP#1334)

(8) Remove some dead code (ESCOMP#1333)

 Conflicts:
	Externals.cfg
	Externals_cime.cfg
Move the NEON_NIWO test to NEON/NIWO to match the names in usermods. Output particular fields for the NEON
cases, and use a reduced size dataset for lightning for NEON sites. Update NEON surface datasets with
new scripts included here. Fix stop option for NUOPC. NEON NIWO test in testlist explicity uses the user-mod
as well as the defaults testmod.

This script is for modifying the surface dataset at neon sites using data available from the neon server.

Also add the ability to output history fields for a particular time of day (in seconds) with the LXXXXX
history averaging option from Ronny Meier.

Externals are updated extensively to the version with cpl7 cime directories split out for CESM.

 Conflicts:
	Externals.cfg
Consolidate duplicated crop phenology code

 Conflicts:
	Externals.cfg
…or mizuRoute that run on more processors for mizuRoute
Implement dynamic (transient) urban capability

This implements the capability to run transient simulations with changes
in urban density types. However, see Caveats for users section below.
If transient urban is activated (do_transient_urban=.true.) and an
appropriate landuse dataset is provided, the model will read in
yearly PCT_URBAN for three density types from the landuse dataset and
adjust other landunits accordingly.
Water and energy are conserved for these transitions. Urban landunits
do not account for carbon and nitrogen, however, see the dynamic urban
design document (doc/design/dynamic_urban.rst) for a discussion of this.

 Conflicts:
	cime_config/config_pes.xml
@ekluzek
ekluzek marked this pull request as ready for review March 8, 2026 23:41
@ekluzek
ekluzek changed the base branch from master to b4b-dev March 8, 2026 23:42
Comment thread doc/source/tech_note/mizuRoute/Tech_Note_mizuRoute.rst Outdated
Comment thread doc/source/tech_note/mizuRoute/Tech_Note_mizuRoute.rst
Comment thread cime_config/config_compsets.xml
Comment thread cime_config/testdefs/ExpectedTestFails.xml Outdated
@ekluzek ekluzek changed the title Add mizuRoute Add mizuRoute compsets, PE layouts and tests and updates to Tech Note/User's Guide Mar 9, 2026
Comment thread .gitmodules

@slevis-lmwg slevis-lmwg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Erik and I went over this, and I'm approving since Erik answered my questions.

@ekluzek
ekluzek removed the request for review from samsrabin March 10, 2026 15:25
@ekluzek
ekluzek requested a review from nmizukami March 10, 2026 15:39

@nmizukami nmizukami left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Still one comment on tech-note's text, but I can approve it

Comment thread doc/source/tech_note/mizuRoute/Tech_Note_mizuRoute.rst Outdated
Comment thread doc/source/tech_note/mizuRoute/Tech_Note_mizuRoute.rst
@ekluzek
ekluzek merged commit 5b2d691 into ESCOMP:b4b-dev Mar 10, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from Slow roast (incremental or external progress) to Ready to eat (Done!) in CTSM-CLM6 development highlights Mar 10, 2026
@ekluzek
ekluzek deleted the add_mizuRoute branch March 10, 2026 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement new capability or improved behavior of existing capability science Enhancement to or bug impacting science

Projects

Status: Ready to eat (Done!)
Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants