Merge pull request #21 from GEMScienceTools/oq-vmtk-v1.0

OQ-VMTK v1.0 Release

Author: mouayed-nafeh

README.md

@@ -1,3 +1,4 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17524871.svg)](https://doi.org/10.5281/zenodo.17524871)
 [![Windows Tests](https://github.com/GEMScienceTools/oq-vmtk/actions/workflows/windows_test.yml/badge.svg)](https://github.com/GEMScienceTools/oq-vmtk/actions/workflows/windows_test.yaml)
 [![Linux Tests](https://github.com/GEMScienceTools/oq-vmtk/actions/workflows/linux_test.yml/badge.svg)](https://github.com/GEMScienceTools/oq-vmtk/actions/workflows/linux_test.yaml)
 
@@ -16,7 +17,7 @@
 <br />
 <div align="center">
   <a href="https://github.com/GEMScienceTools/vulnerability-toolkit">
-    <img src="imgs/gem-vulnerability-toolkit.png" alt="Logo" >
+    <img src="imgs/oq_vmtk_logo.png" alt="Logo" >
   </a>
 
   <h3 align="center">Vulnerability Modeller's ToolKit (OQ-VMTK)</h3>
@@ -38,7 +39,7 @@
 
 # ✨ Key Features
 
-The OQ-VMTK is a powerful toolkit developed by scientists at the Global Earthquake Model (GEM) Foundation. Designed for earthquake engineers and catastrophe modellers, it provides a comprehensive platform powered by OpenSees for running representative (idealised) models, developing fragility and vulnerability assessments, and offering extensive flexibility in defining seismic demand, structural capacity, damage criteria, and damage-to-loss conversion.
+The OQ-VMTK is a powerful toolkit developed by scientists at the Global Earthquake Model (GEM) Foundation. Designed for earthquake engineers and vulnerability modellers, it provides a comprehensive platform powered by OpenSees for running representative (idealised) models, developing fragility and vulnerability assessments, and offering extensive flexibility in defining seismic demand, structural capacity, damage criteria, and damage-to-loss conversion.
 
 ## 🏗️ Single- and Multi-Degree-of-Freedom Systems Calibration and Modeling
 - Define structures with key attributes like storey count, first-mode transformation factors, and force-deformation relationships.
@@ -49,15 +50,15 @@ The OQ-VMTK is a powerful toolkit developed by scientists at the Global Earthqua
 ### 📊 Linear & Nonlinear Analysis
 - **Modal Analysis:** Extract vibration periods and mode shapes with precision.
 - **Gravity Analysis:** Perform gravity analysis and ensure system stability before running advanced simulations.
-- **Nonlinear Static Analyses:** Perform static and cyclic pushover tests to assess the system's lateral load resisting capacity, dissipated energy and other metrics.
-- **Nonlinear Time-History Analyses:** Simulate dynamic response of structures using ground-motion records and extract peak response quantities such as peak storey drifts, peak displacements and peak floor accelerations.
+- **Nonlinear Static Analyses:** Perform static and cyclic pushover tests to assess the system's lateral load-resisting capacity, energy dissipation and other metrics.
+- **Nonlinear Time-History Analyses:** Simulate dynamic response of structures using ground motion records and extract peak response quantities such as peak storey drifts, peak floor displacements and accelerations.
 
 ### 🌍 Seismic Fragility & Vulnerability Assessment
-- **Fragility Analysis:** Conduct probabilistic seismic demand modeling to establish relationships between engineering demand parameters (EDPs) and intensity measures (IMs) using nonlinear time-history analyses (e.g., cloud analysis, multiple stripe analyses). Estimate damage exceedance probabilities while accounting for record-to-record variability and modeling uncertainty. Multiple approaches are supported, including conventional methods (e.g., lognormal cumulative distribution functions) and advanced techniques (e.g., generalized linear models and ordinal models).
+- **Fragility Analysis:** Conduct probabilistic seismic demand modeling to establish relationships between engineering demand parameters (EDPs) and intensity measures (IMs) using nonlinear time-history analyses (e.g., cloud analysis, multiple stripe analyses). Estimate damage exceedance probabilities while accounting for record-to-record variability and modeling uncertainty. Multiple state-of-practice approaches are supported, including lognormal CDFs, generalised linear models and ordinal models.
 - **Storey Loss Function Generation:** Develop storey-level loss functions based on a user-defined inventory of structural components, nonstructural components, and building contents.
 - **Vulnerability Analysis:** Derive vulnerability functions to evaluate both economic and human-centered decision variables. These functions integrate damage-to-loss ratios and/or storey loss functions, with explicit treatment of uncertainties associated with loss conditional on ground-shaking intensity.
 
-### 📈 Powerful Visualization & Plotting Tools
+### 📈 Visualization & Plotting Tools
 - Generate insightful plots for:
   - **Model Overview:** Nodes and elements in your OpenSees model.
   - **Cloud Analysis Results:** Visualize probabilistic seismic demand models (i.e., IM-EDP data and fitted relationships).
@@ -168,7 +169,7 @@ For detailed documentation and user guidance on using the toolkit for vulnerabil
 
 # 📑 References
 
-[WIP]
+[TBD]
 
 # 🤝 Contributions