Skip to content

CHEERSafe Package Flowchart#

Below is a high-level flowchart of the main modules in the CHEERSafe package, showing their inputs, main functions, outputs, and how data flows between them.

flowchart TD
    subgraph Support[Configuration and Tools]
        Z[<big><b>Configuration</b></big><br><small><a href="users_manual/config/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/config.html">API</a></small>]
        H[<big><b>Utilities and Stats</b></big><br><small><a href="users_manual/tools/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/tools.html">API</a></small>]
    end

    A[<big><b>Inventory</b></big><br><small><a href="users_manual/inventory/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/inventory.html">API</a></small>] -->|Building data| B[<big><b>Loading and Failure Check</b></big><br><small><a href="users_manual/loads/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/loads.html">API</a></small>]
    B -->|Failure states and loads| C[<big><b>Damage Ratio Calculation</b></big><br><small><a href="users_manual/damage_ratio_calculation/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/damage_ratio_calculation.html">API</a></small>]
    C -->|Damage ratios| D[<big><b>Damage Probability Calculation</b></big><br><small><a href="users_manual/damage_probability_calculation/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/damage_probability_calculation.html">API</a></small>]
    D -->|Damage probabilities| E[<big><b>Damage Probability Analysis</b></big><br><small><a href="users_manual/damage_probability_analysis/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/damage_probability_analysis.html">API</a></small>]
    E -->|Fragility and vulnerability| F[<big><b>Loss Estimation</b></big><br><small><a href="users_manual/loss_estimation/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/loss_estimation.html">API</a></small>]
    I[(Building inventory,<br>hazard control points,<br>zone layers)] -->|Mapped attributes| X[<big><b>Exposure</b></big><br><small><a href="users_manual/exposure/index.html">Manual</a> &nbsp;&nbsp;&nbsp; <a href="API/exposure.html">API</a></small>]
    X -->|M, C, Wind_Tr, Flood_Tr, zone ids| F
    D -.->|Damage library| F

    Support -.-> A
    Support -.-> B
    Support -.-> C
    Support -.-> D
    Support -.-> E
    Support -.-> X
    Support -.-> F

Legend:

  • Main boxes show package modules and data flow.
  • The gray support block contains configuration plus utilities used throughout.
  • Each box links to its API reference and user manual.
  • The cylinder node holds the user-supplied geospatial inputs consumed by Exposure; the dotted edge from Damage Probability Calculation is the damage library that Loss Estimation turns into lookup tables.