NGWPC NWM Regionalization, Hindcast, and Coastal Tools 2026-06-09

[cmaynard-ngwpc]

Delivered major enhancements to ngen's state management, logging, BMI integration, NHF support, and runtime reliability. Implemented comprehensive state saving, loading, hot-start, and cold-start capabilities for Multi-BMI formulations using Boost serialization, including new APIs, configuration handling, file-based persistence, T-Route state support, and Fortran interoperability improvements. Integrated the nwm-ewts logging framework throughout NGen and its submodules, updated Docker and CI/CD workflows, and improved build and deployment processes. Expanded NHF support with sentinel feature handling, hydrofabric compatibility updates, T-Route integration, catchment/nexus result routing, and improved geometry processing. Added runtime mass-balance checking through a new BMI protocol framework, improved MPI stability and Python interpreter lifecycle management, enhanced forcing and NetCDF handling, and resolved numerous memory-management, serialization, testing, and operational reliability issues. The release also includes extensive submodule updates, documentation improvements, Docker modernization, and customer-delivery workflow enhancements.

Additions

• Integrated EWTS logging support across affected components, including module-specific logging updates, optional logging behavior, Docker/build integration, and unit-test coverage where applicable.
• Added hydrologic model coupling capabilities, including SAC-SMA and Soil Moisture Profiles integration where present in the commit set.
• Expanded automated testing coverage, expected-result data, unit-test support, tolerance-based comparisons, serialization checks, and CI-exercised validation paths.
• Added NHF, hydrofabric, geopackage, VPU, and crosswalk workflow capabilities, including utility scripts, oCONUS handling, and domain/gage data integration.
• Added and expanded forcing workflow support, including updated configuration templates, forecast product handling, lagged-ensemble inputs, regional forcing behavior, and package-delivered forcing resources.
• Added state saving, state restoration, reset-time, restart, and hindcast workflow capabilities, including related time-management updates and model restart handling.
• Implemented and expanded serialization support, including serialized size metadata, message constants, integer-based transfer structures, deserialization bounds handling, and state-transfer messaging.
• Expanded verification and evaluation capabilities with additional metric calculation behavior, observation retrieval support, plotting updates, gage-source integration, and forecast-to-observation alignment.
• Added additional release updates covering additions for documentation, changes to IIF to CASE for sqlite 3.26 support, fixes for(protocols): better default handling; add missing return, additions for variable name, and additions for GetValuePtrInt for Fortran Adapter.

Removals

• Removed unused, duplicate, obsolete, and deprecated code paths, including stale helper functions, duplicated definitions, older EWTS references, and no-longer-needed implementation artifacts.
• Removed additional release updates covering removal of unneeded calls to InterpreterUtil::getInstance() to ensure main is responsible for the interpreter's lifetime, removal of calls to LogAndThrow, and Drop unused Network construction.

Changes

• Updated hydrologic model outputs and model-specific runtime behavior, including formulation outputs, GIUH/channel-inflow values, ponded-depth variables, and model-specific state/runtime handling.
• Updated CI/CD, security scanning, downstream pipeline triggers, and customer-delivery workflow configuration.
• Improved validation, warning, exception, traceback, permission, and user-facing error-reporting behavior.
• Refined configuration, realization, template, sample-config, and package-resource handling across supported workflows and deployment environments.
• Refactored BMI model interfaces and input-forcing behavior, including model-class selection, getter/setter behavior, bounds handling, and BMI calculation fixes.
• Updated Docker, build, packaging, dependency, and installed-resource configuration.
• Corrected unit conversions and size/type reporting across model calculations, serialized buffers, time-step handling, and BMI-facing data exchanges.
• Reworked serialization behavior, message metadata, reported state types, size calculations, buffer validation, and transfer logic for state save and restore workflows.
• Updated cache, dataset, temporary-file, scratch-directory, and data-access behavior, including lazy loading, explicit dataset closure, retry handling, and local/S3 access refinements.
• Updated additional release updates covering updates to submod refs, updates to lgar-c (LASAM) submod ref in ngwpc-candidate, updates to submod ref to point to release-candidate, updates to UEB_BME submod ref, and Sync python interpreter shutdowns between MPI ranks.