Releases: ESCOMP/mizuRoute
v3.0.1
Summary
No answer changes from the previous tag
However, there was additional bugs in MPI domain decomposition (newly found ones). This change make domain decomposition robust for uncommon river network (i.e., network including river segment without associated hrus)
Another bug fixes are related to cesm-coupled mode.
Documentation updates (but no complete)
What's Changed
-
bugfix related restarting by @nmizukami in #559
-
small cleanup on mpi operation for IRF routing restart data by @nmizukami in #563
-
fix error in simulation start time adjustment by @nmizukami in #565
-
Add write_restart_at_endofrun functionality to rtm same as in clm by @nmizukami in #562
-
handling the size of unallocated array and kwt communication fix by @nmizukami in #572
-
write gauge id as character array in gauge only history file by @nmizukami in #564
-
Update testlist for derecho and fix a few problems by @ekluzek in #523
-
Modify config_archive.xml in mizuroute to archive DART output files by @kdraeder in #535
Documentation updates
- fix custom css by @nmizukami in #555
- Descriptions of routing method in tech note by @nmizukami in #556
- Add comprehensive lake model documentation in RST by @ShervanGharari in #570
- Testing of new table structure by @ShervanGharari in #571
- Restructuring the documentation by @ShervanGharari in #579
- Relocate parts of the Control_file to Input_files/Output_files by @ShervanGharari in #580
- Document updates - history, acknowledgement and small model build update by @nmizukami in #577
- Document update - riv sections by @nmizukami in #581
- Documentation update by @nmizukami in #582
- document update by @nmizukami in #583
- README updates by @nmizukami in #558
- README.md update by @nmizukami in #576
New Contributors
Full Changelog: v3.0.0...v3.0.1
Contributors
Assets 2
v3.0.0
Summary
This release update the license and tagged from main branch converted from cesm-coupling. cesm-coupling branch is now freeze, and main branch is now default. Because of this branch change, tag name is also simplified.
What's Changed
Full Changelog: cesm-coupling.n04_v2.3.0...v3.0.0
Contributors
Assets 2
cesm-coupling.n04_v2.3.0
Summary
No answer changes from the previous tag
However, there was a bug in MPI domain decomposition, and fixing this (#552) changed the order of reach in history and restart output. Therefore to compare this version with the previous versions, reordering reachID in the history file is required.
A few enhancements were included
- New science capability: tracer and direct insertion (data assimilation). Tracer is based on advection only, still need enhancement of usability.
- Hanasaki (H06) reservoir scheme update
- Several configuration updates: Lake input options and runoff input specification supporting both wildcard netcdf names or text file (this was used previously, and got this back).
- Documentation updates (but no complete)
What's Changed
Tracer capability (new science)
- Complete one constituent transport by @nmizukami in #504
Direct insertion DA (new science)
- Staging for direct insertion implementation by @nmizukami in #506
- complete direct-insertion implementation by @nmizukami in #509
Lake model related change
- Added a new parameter, HYPE_Qsim_mode by @ShervanGharari in #511
- Ensuring Lake Simulation compatibility with Routing Options Beyond IRF (Cleaning QFUTURE_IRF and UH Allocation) by @ShervanGharari in #522
- Including the global flag
LakeInputOptionto control whether water balance fluxes (precipitation, evaporation, and/or runoff) are considered for lakes and reservoirs. by @ShervanGharari in #533
code re-factoring
- solver for advection diffusion equation by @nmizukami in #499
cesm-coupling related change
- use mid-point of time step for time stamp of history file for cesm-coupling run by @nmizukami in #498
- improve st_archive handling of timestamped rpointer files by @jedwards4b in #530
bugfix
- fix bugs related to fails in restart run with IRF and KWT by @nmizukami in #521
- domain's node assignment fix by @nmizukami in #552
- Diffusive wave equation bug fix by @nmizukami in #497
- Add capability to change lake type and bug fix by @nmizukami in #496
- initialize global water balance array by @nmizukami in #527
minor model configuration updates
- Enhancing
<fname_qsim>Support: Accepting a single NetCDF file (file_name.nc), multiple files via wildcards (file_name*.nc), or a text file listing filename(s) (file_name(s).txt) by @ShervanGharari in #524 - allow to change channel variable names (
sideSlopeandfloodplainSlope) to match the ones in river network netCDF by @nmizukami in #508
PIO update
- updated PIO version to 2.6.6 by @nmizukami in #551
Clean up
- Remove ensemble dimension by @nmizukami in #539
- Clean ixDesire by @nmizukami in #537
Documentation updates
- Removal of code of conduct for now; will update it later by @briandobbins in #505
- doc update - take 1 by @nmizukami in #543
- user guide update - take 2 by @nmizukami in #544
- docs update - take 3 by @nmizukami in #546
- Take 4: Documentation update by @nmizukami in #547
- Take 5: Documentation update by @nmizukami in #549
- Doc editing by @nmizukami in #550
New Contributors
- @briandobbins made their first contribution in #505
Full Changelog: cesm-coupling.n03_v2.2.0...cesm-coupling.n04_v2.3.0
Contributors
Assets 2
cesm-coupling.n03_v2.2.0
Summary
Answer changes from the previous tag
Floodplain option
new control variable is <floodplain> = T or F
Floodplain is represented with very gentle slope (default 1:1000), extending from the top of side wall of the channel. The channel uses a bankfull depth. Currently bankfull depth is computed based on upstream area for each reach. This default method may change in the future. A user is encouraged to come up with the way to estimate the bankfull depth (and width) outside mizuRoute.
Regardless of whether floodplain is on or off, the method to compute celerity, diffusivity use the section 3.3 in Beg M et al., 2022. This is primary cause of the answer change from the previous version, which use the assumption of "wide" rectangular channel width, that simplifies the flow area computation. Also, from the current version, the channel geometry type can be rectangular (default) or trapezoidal (by providing side wall slope as input parameter).
What's Changed
allow a generic name when using only one routing method
- implement generic output name for routing method specific variables by @nmizukami in #482
Update external handling
- Adding git-fleximod by @nmizukami in #485
- remove manage_externals by @jedwards4b in #468
For CESM coupling
- Adding datetime in rpointer file with backward compatibility by @nmizukami in #486
routing with floodplain
- Including floodplain by @nmizukami in #470
- Fixing overflow error coming from default large bankfull depth by @nmizukami in #493
Cleanup
- remove many mpi_barrier by @nmizukami in #494
- sync mpi task before processing tmp file by @nmizukami in #487
- updated file open routing by @nmizukami in #491
New Contributors
- @jedwards4b made their first contribution in #468
Full Changelog: cesm-coupling.n02_v2.1.4-standalone...cesm-coupling.n03_v2.2.0
Contributors
Assets 2
cesm-coupling.n02_v2.1.4-standalone
Summary
This is answer changes from the previous tag
MC routing change due to change in how discharge is restricted when volume is very low (mc_route.f90 line 331 in commit 85caeeb)
A few enhancements were included
- User can specify minimum reach length for routing. For reach below this threshold, inflow is passed as outflow and lateral flow is added to that as normal.
- User can input lateral flow at the top of reach ONLY for headwater catchments as a option, so that reach routing happens.
- User can control History file time stamp can be control by specify where in the time step is used (0: start of time step, 86400: end of time step if time step is daily)
- User can specify time step convention in runoff (for now, start or end)
- runoff input specification in control file uses just file name with wild card (if multiple the netCDFs exist).
- Hanasaki (H06) reservoir scheme is enable
What's Changed
enhancement
- Enabling reach routing at headwater HRUs by @nmizukami in #467
- Pass through option and river length check by @nmizukami in #472
- history file time stamp flexibility by @nmizukami in #475
- Change in stand-alone runoff (and water management) input specification in control file by @nmizukami in #479
Enabling Hanasaki reservoir
- write lake parameters only for a lake id specified in control file in a log file by @nmizukami in #477
- H06 default parameters renamed by @nmizukami in #478
cleaning
- no need to use read function to get string by @nmizukami in #474
- typo by @nmizukami in #480
Full Changelog: cesm-coupling.n02_v2.1.3...cesm-coupling.n02_v2.1.4-standalone
Contributors
Assets 2
cesm-coupling.n02_v2.1.3
Summary
No answer changes from the previous tag
A few enhancements were included
- hru id in vector runoff input can be long integer.
- inflow for each reach can be output in history file
- For cesm-coupling, the other routing methods can be used, in addition to IRF routing.
What's Changed
makefile cleanup
- Clean up and Makefile update by @nmizukami in #459
- makefile cleanups by @nmizukami in #461
- Making intel-oneAPI compiler work by @nmizukami in #464
cleanup
- PIO sync for potentially better robustness for gnu/cray-mpich and a few cleanups by @nmizukami in #453
New functions
- Adding parameterized floodplain by @nmizukami in #449 - floodplain effect is not implemented yet
- Allow long integer HRU id for vector runoff input by @nmizukami in #457
- Allow more flexible time stamp in forcing input (start, end or middle of time step) by @nmizukami in #460 - require it to be specified in control file
- Add upstream inflow in history output by @nmizukami in #462 - require it to be specified in control file
CESM-coupling
- enabling to use the other routing methods than IRF by @nmizukami in #448
- mizuRoute_control.py change required by @nmizukami in #451
Full Changelog: cesm-coupling.n02_v2.1.2...cesm-coupling.n02_v2.1.3
Contributors
Assets 2
cesm-coupling.n02_v2.1.2
What's Changed
Model physics
- capacity to scale or offset the inputs (runoff, evaporation, and precipitation) by @ShervanGharari in #412
- connect lake module to the other routing methods by @nmizukami in #421
- connect lake module to kwt routing routine by @nmizukami in #427
- Adding a few channel properties and water take option for other routing by @nmizukami in #428
- Enable to run at user specified routing time step rather than using coupling_frequency by @nmizukami in #429
- IRF water take by @nmizukami in #430
Bugfixes
- Fix a restart issue for a single core by @nmizukami in #415
- set runoff depth unit correctly in meta by @nmizukami in #422
- Fix error in writing history_file variable for gauge-only history file in restart file by @nmizukami in #423
- Fixed upstream reach detection for cesm-coupling branch by @nmizukami in #441
Miscellaneous improvement
- Refactoring related to PIO decomposition initialization by @nmizukami in #431
Documentation
- Fixing readthedoc setup by @nmizukami in #435
- new readthedoc requirement by @nmizukami in #433
- conf.py path fixed in .readthedoc.yaml by @nmizukami in #434
- cheyenne build readme update by @nmizukami in #442
- Remove testmod fixes for ccs_config by @ekluzek in #416
Library updates
- Externals update by @nmizukami in #432
- update manage_externals version by @nmizukami in #440
Full Changelog: cesm-coupling.n01_v2.1.0...cesm-coupling.n02_v2.1.2
Contributors
Assets 2
cesm-coupling.n01_v2.1.0
What's Changed
CTSM coupling
- Temporary implementation of the array to export from rof to lnd by @nmizukami in #274
- Enabling water abstraction with Irrigation demand by @nmizukami in #288
- exporting volume (volr) to land model and handling negative qgwl by @nmizukami in #297
- Direct_to_outlet option for negative flow handling by @nmizukami in #313, #315
- Add a custom grid option for cesm-coupling by @ekluzek in #345
- Add HDMA lake ntopo file settings by @ekluzek in #329
- Add more lake options to the cesm-coupling control file by @ekluzek in #335
- Updates on sample control file for cesm-coupling by @nmizukami in #312
CESM system testing
- CTSM-mizuRoute test config update by @nmizukami in #258
- Fix rpointer file IO by @nmizukami in #269
- Add some lake tests to the test list update lake dataset and fix some coupled issues by @ekluzek in #371
- Some fixes so can run on izumi (including nag compilier) by @ekluzek in #391
Time management change
- independent simulation time-step and forcing time-step by @nmizukami in #336
- Including t_bound variable in a history file and resulting changes by @nmizukami in #394
- modified datetime class and keep track of time in second (not day) for both forcing and simulation time by @nmizukami in #398, #402
Model physics
- Doll lake formulation improvement by @ShervanGharari in #331.
- implementation of water balance computation for reach and drainage area by @nmizukami in #318, #319, #326
- reach/lake water balance error check and minor fix/cleanup in lake and irf routing by @nmizukami in #361
- water can be abstracted from residual reach volume and outflow by @nmizukami in #362
- enabling water-take and water-injection for other routing methods by @nmizukami in #311
- default minimum discharge by @nmizukami in #321
User specified history output frequency
- User specified history write frequency by @nmizukami in #353
- Reading aggregated history variables from restart netcdf by @nmizukami in #364
Gauge location output capability
- Incorporating gage meta (ascii) into output by @nmizukami in #279
- history file name convention for gauge only output by @nmizukami in #393
Continue run capability
- initial implementation for continuous_run by @nmizukami in #260
- history and restart file name control by @nmizukami in #261
- Enabling opening of the last history file for continue run by @nmizukami in #271
Run with multiple routing methods
- Running with multiple routing schemes by @nmizukami in #264
- Added accumRunoff as a part of routing scheme options with routOpt=0 by @nmizukami in #265
- Enabled reach volume IO for KW, MC and DW routings from/to restart file by @nmizukami in #317
Code style, cleanup
- Clean-up temporal arrays for mpi scattering by @nmizukami in #268
- Cleaning by @nmizukami in #278
- fixed wrong variable names - cmessage and message by @nmizukami in #322
- rename variable name by @nmizukami in #320
- use select type to compact the generic routine by @nmizukami in #373
- use abstract route class by @nmizukami in #405
- miscellaneous changes by @nmizukami in #272
- pio resource cleanup by @nmizukami in #287
- Minor naming changes by @nmizukami in #316
- default value for continue_run parameter by @nmizukami in #284
- subset history file writing and improving history writing efficiency by @nmizukami in #286
- history file name change by @nmizukami in #401
Miscellaneous improvement
- Add number of MPI tasks to restart file to ensure they are the same when reading by @ekluzek in #251
- Abort if a variable in control file include TAB by @nmizukami in #314
- Write git information in history file global attributes by @nmizukami in #363, #370
Bugfixes
- Fixed the restart error when single core is used. by @nmizukami in #282
- bugfixes in init and run routines for ctsm-coupling by @nmizukami in #360
- cesm-coupling bugfix by @nmizukami in #374
- Fix single core run error in cesm-coupling mode. by @nmizukami in #379
- Fix cesm restarting: by @nmizukami in #381
- Fix lake volume initialization(use maximum storage) by @nmizukami in #408
- move fileVar (variable I/O control) changes in a separate subroutine by @nmizukami in #333
Documentation
- Readthedoc updates by @nmizukami in #365, #366
- change testCase data link by @nmizukami in #367
Full Changelog: cesm-coupling.n00_v2.0.1...cesm-coupling.n01_v2.1.0
Contributors
Assets 2
version 1.2.3
What's Changed
Bugfix (science changes):
- Fixed Diffusive wave downstream boundary condition by @nmizukami in #303
- Fixed default value for newFileFrequency by @nmizukami in #325
- Upstream reach detection using goodBas (upstream reach connected with valid hru area) by @nmizukami in #346
- detect maximum unit-hydrograph size for restart writing by @nmizukami in #341
- Flow adjustment to ensure river volume is always positive or zero by @nmizukami in #348
New features:
- csv reading capability with new csv object by @nmizukami in #295
- reading water take and observed flow by @nmizukami in #298, #305
- capability of water abstraction/injection during routing by @nmizukami in #300
- Add reach volume in restart state file and history file (for all the routing methods) by @nmizukami in #299, @nmizukami in #347
- Separate runoff input time step and simulation time step by @nmizukami in #340
- Direct insertion of observed discharge at gauge points for user specified period by @nmizukami in #328, #302, @nmizukami in #348, #354, @nmizukami in #357,
- Added reach volume for history and restart files by @nmizukami in #347
Minor updates (cleanup, doc updates, non-science etc.):
- README for building instruction by @nmizukami in #350
- minor update: readthedoc link update by @nmizukami in #294
- Code style, variable name cleanup by @nmizukami in #304 #342
- including git information (version, branch, hash) in history file global attributes @nmizukami in #351
Full Changelog: v1.2.2...v1.2.3
Contributors
Assets 2
v1.2.2
What's Changed
Bugfix (science changes):
- restart error for KWT without overland routing case by @nmizukami in #197
- revise Gamma distribution for overland routing by @h294liu in #190
New features:
- Cold start specification ("coldstart" or "none") by @nmizukami in #194
- Implementing KW, DW and MC routing by @nmizukami in #232
- musking-cunge routing implementation by @nmizukami in #233
- Completed kinematic wave routing implementation by @nmizukami in #236
- Diffusive wave routing implementation by @nmizukami in #241
- minor fixes MC and KW routines by @nmizukami in #237
- Output with multiple active routing options by @nmizukami in #263
- Added accumRunoff as a part of routing scheme options with routOpt=0 by @nmizukami in #290
- history file output option improvement by @nmizukami in #257
- Restart file content change - time information by @nmizukami in #195, #199
Minor updates (cleanup, doc updates, non-science etc.):
- restart and history frequency specification by @nmizukami in #291
- Cleanups by @nmizukami in #198, #249,
- Updated documented by @nmizukami in #292
- Updated .gitignore by @nmizukami in #242
- runoff fillvalue issue by @nmizukami in #165
New Contributors
Full Changelog: v1.2.1...v1.2.2
