Repository navigation
Getting Started
The Coastal Hazards, Engineering and Structures System (CHESS) runs in MATLAB, either as a script (the library) or through the CHESS app (the GUI). Both use the same functions and write the same output folders.
- MATLAB with the Statistics and Machine Learning Toolbox (copulas, distributions).
-
The CHESS library on the MATLAB path:
addpath(genpath('CHESS_Library')). - Storm data for your site: CHS savepoint files from the Coastal Hazards System (Peaks and/or Timeseries, water level and wave files), or a prepared storm database (Model Inputs).
- CHS_Dependencies for the CHS region, needed for tropical storms (TC/CC), bias and uncertainty, and the savepoint's offshore elevation. Without it CHESS runs extratropical storms only.
- Optional: a NOAA tide prediction file, for random tides (Model Inputs).
On the CHS site: choose a regional study, apply the Base Modeling filter, and pick the savepoint for your project. Download the Peaks and/or Timeseries files of both models of the savepoint (ADCIRC for water level, plus the wave model: STWAVE, WAM or SWAN), for the storm types you need (XC, TC or both). The CHS quick guide walks through the site.
- Copy the template for your structure type from
PSE_Templates/(or aCHESS_*_inputs.xlsx) and fill it in (config_reference). - Point
chs_zipat the CHS.zip,.h5or.matfile, andchs_dependenciesat the CHS_Dependencies folder. - Run the six steps of
CHESS_Usage_Example.m:
[config, structure] = call_input_parser(chess_input_file); % 1. setup
[storm, ~, prob_mass, config] = call_chs_data_formater(config); % 2. storm database
[project_forcing, config] = call_project_forcing_formater(config, storm, prob_mass); % 3. forcing
[project_forcing, config] = call_uncertainty_engine(config, project_forcing); % 4. uncertainty
[project_forcing, config] = call_project_forcing_adjuster(config, project_forcing, structure); % 5. adjustments
Resp = call_project_response(config, project_forcing, structure, config.create_plots); % 6. responsesResults go to <outfolder>/<project_name>/PSE/<struc_id>/<case_name>/<workflow>/ (Model Outputs). Run the same case again and CHESS reuses what has not changed (Hotstart Levels).
Step-by-step with screenshots: GUI Quick Start.
Open CHESS_Library/GUI/CHESS_UI_canvas.mlapp in MATLAB and run it.
-
Project: create a project (or import one from a project
.mator an exported.zip). -
Storm database: import CHS
.zip/.h5, aCHS_Data.mator a storm + prob_mass.mat. The same file checks, bias and uncertainty lookup and offshore elevation as the library are applied. - Tides (optional): download NOAA tide predictions for a station.
- PSEs: create PSEs from the library templates and edit their values in the PSE Viewer.
- Run: pick the PSE, alternative, workflow and storm database, then press Run. A case that already has results offers Hotstart, Coldstart or Load existing.
- Results: hazard curves, life-cycle dashboards or per-storm plots, with pop-out figures and tables.
| You want to know | Workflow |
|---|---|
| The response at a given annual exceedance probability (design) |
CHESS PROS (workflow = 1; 4 for PROS-FB) |
| How the structure performs and degrades over its service life |
CHESS LCS (workflow = 3) |
| What each storm does to the structure |
CHESS DET (workflow = 2) |
Open an issue with:
- The error message from the command window (red text).
- The input file (config).
- The CHS savepoint: latitude, longitude, ADCIRC and wave savepoint IDs.
Run-up & Overtopping
- Wave Run-up (R2%)
- Overtopping Discharge (q)
- Overtopping Volume (Q_vol)
- Overtopping Damage Classification
- Run-up Exceedance (z1%)
- Crest Velocity Exceedance (u1%)
Transmission
Wall Loads
Armor Stability
Damage Progression (LCS)
Hazard Metrics