OQ-VMTK v1.1.0

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+max-line-length = 100
+exclude =
+    .git,
+    __pycache__,
+    *.egg-info,
+    build,
+    dist,

.github/workflows/linux_test.yml

@@ -5,7 +5,7 @@ on:
     inputs:
       git-ref:
         description: Git Ref
-        default: master
+        default: main
         required: true
       debug_enabled:
         type: boolean
@@ -24,16 +24,25 @@ jobs:
         os: [ubuntu-24.04]
         python-version: ["3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Clone Repository (Main)
+        uses: actions/checkout@v6
+        if: github.event.inputs.git-ref == ''
+      - name: Clone Repository (Custom Ref)
+        uses: actions/checkout@v6
+        if: github.event.inputs.git-ref != ''
+        with:
+          ref: ${{ github.event.inputs.git-ref }}
       - name: Set up Python  ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Setup debugging session
         uses: mxschmitt/action-tmate@v3
         timeout-minutes: 60
         if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
       - name: Install Dependencies of OpenQuake engine
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           curl -L -O https://github.com/gem/oq-engine/raw/master/install.py
           python install.py user --version=master
@@ -56,9 +65,9 @@ jobs:
     needs: vulnerability_test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: "3.11"
     - name: Install sphinx and themes

.github/workflows/macos_arm_test.yml

@@ -5,7 +5,7 @@ on:
     inputs:
       git-ref:
         description: Git Ref
-        default: master
+        default: main
         required: true
   schedule:
     - cron: "0 3 * * 0"
@@ -19,12 +19,21 @@ jobs:
         os: [macos-latest]
         python-version: ["3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Clone Repository (Main)
+        uses: actions/checkout@v6
+        if: github.event.inputs.git-ref == ''
+      - name: Clone Repository (Custom Ref)
+        uses: actions/checkout@v6
+        if: github.event.inputs.git-ref != ''
+        with:
+          ref: ${{ github.event.inputs.git-ref }}
       - name: Set up Python  ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies of OpenQuake engine
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           curl -L -O https://github.com/gem/oq-engine/raw/master/install.py
           python install.py user --version=master

.github/workflows/windows_test.yml

@@ -5,7 +5,7 @@ on:
     inputs:
       git-ref:
         description: Git Ref
-        default: master
+        default: main
         required: true
   schedule:
     - cron: "0 2 * * 0"
@@ -19,12 +19,23 @@ jobs:
         os: [windows-2025]
         python-version: ["3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Clone Repository (Main)
+        uses: actions/checkout@v6
+        if: github.event.inputs.git-ref == ''
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Clone Repository (Custom Ref)
+        uses: actions/checkout@v6
+        if: github.event.inputs.git-ref != ''
+        with:
+          ref: ${{ github.event.inputs.git-ref }}
       - name: Set up Python  ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies of OpenQuake engine
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           curl.exe -LO https://github.com/gem/oq-engine/raw/master/install.py
           python install.py user --version=master

.gitignore

@@ -20,6 +20,5 @@ local_settings.py
 venv
 *.whl
 .vscode/
-.ipynb_checkpoints/
-demos/notebooks/.ipynb_checkpoints/example_1-checkpoint.ipynb
+**/.ipynb_checkpoints/
 .virtual_documents/

CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## v1.1.0 — 2026-05-12
+
+### Added
+- **Incremental Dynamic Analysis (IDA)**: New `do_ida_analysis()` method in `modeller.py` runs nonlinear response history analyses at progressively scaled ground-motion intensities using a hunt-and-fill procedure (truncated and non-truncated). Results are post-processed by `process_ida_results()` in `postprocessor.py`, producing fragility functions and vulnerability curves via logistic regression and lognormal fitting. IDA plots (stripe curves, fragility, vulnerability) added to `plotter.py`.
+- **IDA demo**: New `IncrementalDynamicAnalysis` notebook with the FEMA P695 far-field ground-motion record set (44 records).
+- **MCMC for Modified Cloud Analysis**: Markov Chain Monte Carlo method added to `postprocessor.py` for MCA fragility derivation, alongside classical and bootstrap MCA plotter functions in `plotter.py`.
+- **IM Efficiency and Sufficiency module** (`imselection.py`): New module implementing efficiency (dispersion-based IM ranking), practicality (regression slope), proficiency (κ metric), and the Relative Sufficiency Metric (RSM) for both MCA and IDA. Includes `compare_ims()` for tabulated multi-IM comparison.
+- **RotDxx spectral calculations**: `get_rotdxx()` added to `imcalculator.py` to compute RotD50/RotD100 and arbitrary rotation-percentile response spectra from two horizontal components.
+- **Structural analysis animations**: Animated deformed-shape outputs for SPO, CPO, and NRHA analyses via `modeller.py`. Animated mode shape visualisation via `plot_modes()` in `plotter.py`. All demo notebooks updated with animated GIF outputs.
+- **COV calculations and DS threshold variability**: Added coefficient-of-variation methods and DS threshold variability as an input argument for NLTHA post-processing methods in `postprocessor.py`.
+- **macOS ARM64 CI workflow** (`macos_arm_test.yml`) and platform-specific requirements files for Linux, Windows, and macOS ARM64.
+- **Python 3.13 support** in `pyproject.toml` and CI workflows.
+- `CITATION.cff` added.
+- `README.md` files added for IDA, MSA, MCA, ModalAnalysis, and ModelCompilation demos.
+
+### Changed
+- **Calibration methodology**: `calibration.py` updated to a displacement-based design methodology.
+- **Variable renames**: `pflag` → `pFlag` and `floor_heights` → `storey_heights` across `modeller.py`, `calibration.py`, and all dependents.
+- **Class rename**: `IMCalculator` renamed to `imcalculator`; module `slf_generator.py` renamed to `slfgenerator.py`.
+- **AAL and AADP refactor**: `calculate_average_annual_loss()` and `calculate_average_annual_damage_probability()` restructured in `postprocessor.py`.
+- All core modules (`modeller.py`, `calibration.py`, `postprocessor.py`, `plotter.py`, `imcalculator.py`, `slfgenerator.py`, `units.py`, `utilities.py`) refactored to PEP8 standards.
+- All demo notebooks and unit tests updated for PEP8 compliance.
+- Input ground-motion records for demos relocated into `in/records/` subdirectories.
+- Default response spectrum resolution increased to 500 points.
+- CI upgraded to Node.js 20 actions; `GITHUB_TOKEN` added to workflows to prevent API rate-limiting.
+- `scipy` pinned to `>=1.15.3`; `statsmodels` wheel added for macOS ARM64.
+
+### Fixed
+- `postprocessor.py`: Fixed `NoneType` export for non-lognormal fragility methods.
+- `postprocessor.py`: Stabilised logistic regression when bootstrap produces too few collapses.
+- `postprocessor.py`: Fixed out-of-bound beta values.
+- `slfgenerator.py`: Fixed sampling bug.
+- `plotter.py`: Fixed `RecursionError` in `_show()` (changed `self._show()` to `plt.show()`).
+- `imcalculator.py`: Fixed multiple bugs in IM calculation routines.
+- `modeller.py`: Fixed node displacement and acceleration storage allocation in `do_nrha_analysis()`.
+- `modeller.py`: Fixed `openseespy` import to be OS-conditional.
+- Replaced `.values[0]` scalar extraction with `.item()` to resolve NumPy `DeprecationWarning`.
+- Replaced chained `fillna` assignment with direct assignment to resolve Pandas `DeprecationWarning`.
+- Suppressed `FigureCanvasAgg UserWarning` from `plt.show()` in headless CI environments.
+- Fixed Flake8 unterminated string literal issues across source files and unit tests.
+
+### Removed
+- Deprecated `im_calculator.py` and `slf_generator.py` modules (replaced by `imcalculator.py` and `slfgenerator.py`).
+
+---
+
 ## v1.0.0
 
 ### Added or Changed

CITATION.cff

@@ -0,0 +1,31 @@
+cff-version: 1.2.0
+message: >-
+  If you use this software, please cite both the archived release
+  (Zenodo DOI below) and the project as a whole.
+title: "OpenQuake Vulnerability Modeller's Toolkit (oq-vmtk)"
+abstract: >-
+  An open-source library for modelling single- and multi-degree-of-freedom
+  systems and assessing them via nonlinear time-history analyses for regional
+  vulnerability and risk calculations. Developed by the Global Earthquake Model
+  (GEM) Foundation.
+type: software
+authors:
+  - name: "GEM Foundation"
+    email: risk@globalquakemodel.org
+    website: "https://www.globalquakemodel.org"
+license: AGPL-3.0-only
+repository-code: "https://github.com/GEMScienceTools/oq-vmtk"
+url: "https://gemsciencetools.github.io/oq-vmtk/"
+version: "1.1.0"
+date-released: "2026-05-12"
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.17524871
+    description: Zenodo archive of the v1.0.0 release
+keywords:
+  - earthquake-engineering
+  - seismic-risk
+  - fragility
+  - vulnerability
+  - openquake
+  - opensees

README.md

@@ -99,17 +99,17 @@ It is highly recommended to use a **virtual environment** to install this tool.
 
 
 ### 3. Install Dependencies
-   Install the required packages listed in `requirements.txt`.
+   Install the appropriate requirements file based on your operating system and Python version.
 
-   **For Windows Users:** Install the appropriate requirements file based on your Python version:
+   **For Windows Users:**
    ```bash
    pip install -r requirements-py311-win64.txt  # Python 3.11
    pip install -r requirements-py312-win64.txt  # Python 3.12
    ```
-   **For Linux Users:** Install the appropriate requirements file based on your Python version:
+   **For Linux Users:**
    ```bash
-   pip install -r requirements-py311-linux64.txt  # Python 3.11
-   pip install -r requirements-py312-linux64.txt  # Python 3.12
+   pip install -r requirements-py311-linux.txt  # Python 3.11
+   pip install -r requirements-py312-linux.txt  # Python 3.12
    ```
    **For macOS Users:** OpenSeesPy does not currently support macOS versions running on arm64 processors, such as M1 and M2 chips. As a result, newer OpenSeesPy versions are not available for macOS. To use OpenSeesPy on a Mac, it is advised to run a virtual machine with Linux or Windows.
 
@@ -122,13 +122,25 @@ It is highly recommended to use a **virtual environment** to install this tool.
 
 
 ### 4. Install the Package
-   Install the `oq-vmtk` package in editable mode:
+
+   **Standard install (recommended for users):**
+   ```bash
+   pip install .
+   ```
+
+   **Editable / developer install** — use only if you plan to modify the source:
    ```bash
    pip install -e .
    ```
 
 <img src="imgs/packaging.gif" alt="Logo" >
 
+### 5. Verify the Installation
+   ```bash
+   python -c "import openquake.vmtk; print(openquake.vmtk.__version__)"
+   ```
+   This should print the installed version (e.g., `1.0.0`).
+
 
 ## 📼 Demos
 
@@ -167,6 +179,28 @@ This work is licensed under an AGPL v3 license (https://www.gnu.org/licenses/agp
 
 For detailed documentation and user guidance on using the toolkit for vulnerability modeling, including installation instructions, key functionalities, and example workflows, please visit: [https://gemsciencetools.github.io/oq-vmtk](https://gemsciencetools.github.io/oq-vmtk/)
 
+# 📑 Citation
+
+If you use `oq-vmtk` in academic work, please cite the archived release. The v1.0.0 release is permanently archived on Zenodo:
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17524871.svg)](https://doi.org/10.5281/zenodo.17524871)
+
+BibTeX:
+
+```bibtex
+@software{oq_vmtk_2025,
+  author       = {{GEM Foundation}},
+  title        = {{OpenQuake Vulnerability Modeller's Toolkit (oq-vmtk)}},
+  version      = {1.0.0},
+  date         = {2025-11-04},
+  doi          = {10.5281/zenodo.17524871},
+  url          = {https://github.com/GEMScienceTools/oq-vmtk}
+}
+```
+
+A `CITATION.cff` file is also provided at the repository root so that GitHub
+displays a "Cite this repository" widget.
+
 # 📑 References
 
 [TBD]