CHEERSafe Documentation#
Welcome to the documentation for CHEERSafe, an object-oriented Python package (Python 3.9+) for hurricane damage and loss assessment. This guide is for developers, testers, and users.
Quick Links#
- CHEERSafe Module Flowchart
- Quickstart Guide
- Input Manual
- Configuration and Execution Modes Notebook
- Fragility Curve Calculation Notebook
- Exposure Workflow Notebook
Project Overview#
CHEERSafe: Hurricane loss analysis package for building properties, hazard data, and loss models.
This package provides comprehensive tools for hurricane damage and loss assessment, including building inventory management, load calculations, damage probability analysis, damage ratio calculations, and loss estimation.
Modules:
| Name | Description |
|---|---|
config |
Configuration management for the CHEERSafe package |
inventory |
Building inventory data and management |
loads |
Loading calculations and failure checks |
damage_ratio_calculation |
Damage ratio calculations for structural components |
damage_probability_analysis |
Damage probability analysis and fragility/vulnerability calculations |
damage_probability_calculation |
Damage probability calculations |
exposure |
Building-inventory archetype assignment, hazard mapping, zone assignment, and STARR export |
loss_estimation |
Loss lookup tables, building loss ratios, expected annual loss, and regional aggregation |
tools |
Utilities for data processing, visualization, and statistics |
User Manual#
- Inputs
- Configuration
- Inventory
- Loading and Failure Check
- Damage Ratio Calculation
- Damage Probability Calculation
- Damage Probability Analysis
- Exposure
- Loss Estimation
- Tools
Examples#
- Configuration and Execution Modes
- Inventory Building Geometry
- Loading and Failure Check Workflow
- Fragility Curve Calculation
- Fragility Curve Calculation with Detailed Damage Ratio Analysis
- Exposure Workflow
- Loss Estimation Workflow
- Eastern North Carolina Loss Figures
- Tools Sampling and Covariance