Skip to content

Releases: coastal-hazards-system/StormSim-Library

Release list

v1.2.3

Choose a tag to compare

@fgarcia0128 fgarcia0128 released this 22 May 00:44

StormSim-Library | Release Notes | Version 1.2.3
Release Date: 2026-05-21

OVERVIEW

This release delivers a major overhaul of hot-start/cold-start state
management, expands rubble mound damage computations to cover submerged crest
conditions, and fully automates the CHS_Dependencies setup and loading
workflow. Several breaking changes to the configuration API are included.

BUG FIXES

  • Overhaul of hot-start/cold-start state management across all processes.
  • Fixed for-loop end index in stormsim_csr_peaks.m.
  • Fixed format mismatch for config.storm_duration across multiple routines.

FEATURES

Major Features

  1. Rubble Mound (PSE Type 3) — Dn50/S Response Update [Issues: #118]

    • Updated Dn50/S response equation restrictions for both seaside and
      leeside, per published literature.
    • Added new response equation (CEM Table VI-5-24) for submerged crest
      conditions (Rc < 0). All instances where Rc < 0 now default to this
      equation for both seaside and leeside (S remains a
      placeholder pending further development).
    • Added "cutoff" method to leeside damage computations.
  2. Full Automation of CHS_Dependencies Setup and Loading

    • CHS_Dependencies folder can now be downloaded directly from the CHS
      library (https://chs.erdc.dren.mil/Home/Library).
    • Hm0 uncertainty application is now automated for supported CHS studies.
    • TC dependencies workflow is now fully automated. Users no longer need
      to specify prob_mass_source or grid_source manually.
    • CHS data parsing routine fully overhauled to use MATLAB datetime
      objects, replacing prior numeric date handling.

Minor Features

  1. Berms Removed (All PSE Types)

    • Support for berms in front of a PSE has been removed pending revision
      of the underlying conceptual models.
  2. Vertical Wall (PSE Type 2) — P1 Response Update [Issue: #117]

    • Depth limitation is now applied to P1 computations after the design
      Hm0 is estimated (1.8 * Hm0).
  3. StormSim Time Series Resolution [Issue: #45 — Closed]

    • CSTORM time series outputs are now interpolated to a 1-hour dt when
      constructing the "storm" object.
    • Optimized timeseries data matching process.
  4. StormSim Config File Updates

    • Uncertainty parameters removed from configuration templates. CHS
      modeling epistemic uncertainty is now read from CHS_Dependencies files.
      Response equation epistemic uncertainty has been moved to
      primary_responses_epistemic_uncertainties.txt.
    • Berm fields removed from config templates.
    • CHS inputs table updated to reflect the latest implementation.
    • Added out_files field to config, listing all .mat files created during
      a simulation.
    • Added in_files field to config, listing all CHS_Dependencies files
      loaded for the simulation.

SYSTEM / INFRASTRUCTURE

  • Added GitHub Actions workflow for continuous integration.
  • Added semantic-release configuration for automated versioning.
  • Adopted config.out_files and config.in_files across the codebase.
  • Added config file appendix to local repository and wiki.

================================================================================

v1.0.0

Choose a tag to compare

@fgarcia0128 fgarcia0128 released this 04 May 13:43
fb3d839
Release versioning