oq-wrapper 2025.12.3__tar.gz

oq_wrapper-2025.12.3/CHANGELOG.md

@@ -0,0 +1,53 @@
+Empirical Engine - Empirical IM calculation
+
+(Based on https://wiki.canterbury.ac.nz/download/attachments/58458136/CodeVersioning_v18p2.pdf?version=1&modificationDate=1519269238437&api=v2 )
+
+## Unreleased
+### Fixed
+### Changed
+### Added
+
+## [23.7.11] - 2023-07-11
+### Changed
+  - Removed most of the code, except for the OpenQuake vectorised wrapper
+  - Old code is recoverable from the `backup_20230707` branch
+
+
+## [21.1.1] - 2021-01-21
+### Added
+  - Added OpenQuake compatibility layer
+  - Added OpenQuake models for ver component
+  - Added component selection to command line arguments
+
+## [19.9.3] - 2020-02-11 -
+### Added
+  - Added RotD100/50 (rotd100_50) and inelastic to elastic spectral displacement ratio (IESDR) empiricals
+### Changed
+  - Added 16 pSA periods to the default
+
+## [19.9.2] - 2019-12-10 -
+### Added
+  - Permutation aggregation script to generate all combinations of intensity measure models for a given event or fault from the available intensity measure files
+  - Abrahamson A18 model added and verification script created 
+### Changed
+  - Empirical calculation and aggregation scripts refactored to allow easier access to their functionality
+
+## [19.9.1] - 2019-09-11
+### Added
+Additional Empirical Models. (and unit tests)
+
+## [18.7.2] - 2018-08-16
+### Added
+Interpolation for Zhao beyond the period of 5.0s
+Config file to select which model is used for each tect_type / im
+Empirical IM_csv creation
+IM_aggregation (aggregating an individual IM_csv into a larger file containing more than one IM_type)
+### Changed
+Verification changes (Z1p0 units and rock_site estimation for CB)
+
+## [18.7.1] - 2018-07-13
+### Added
+Empirical calculations from site (rrup + vs30) and fault for Zhao_06, Bradley_13, Afshari_Stewart_16,
+    Campbell_Bozorgina_2010, Campbell_Bozorgina_2012
+Output IM into individual csv files
+Estimation of parameters unspecified

oq_wrapper-2025.12.3/MANIFEST.in

@@ -0,0 +1 @@
+prune tests

oq_wrapper-2025.12.3/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: oq-wrapper
+Version: 2025.12.3
+Summary: Wrapper for OpenQuake engine to run empirical GMMs
+Author: ucgmsim
+Requires-Python: <3.14,>=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: numpy<2
+Requires-Dist: openquake.engine
+Requires-Dist: pandas
+Requires-Dist: pytest-black
+Requires-Dist: pytest>=3.5.0
+Requires-Dist: pyyaml
+Requires-Dist: scipy>=1.7.2
+Requires-Dist: source-modelling
+Requires-Dist: pyarrow
+
+[![Build Status](https://quakecoresoft.canterbury.ac.nz/jenkins/job/Empirical_Engine/badge/icon?build=last:${params.ghprbActualCommit=master})](https://quakecoresoft.canterbury.ac.nz/jenkins/job/Empirical_Engine)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Empirical_Engine
+Contains codes to calculate Empirical IMs using the openquake engine
+
+## To calculate empirical IMs
+
+calculate_empirical.py is the main script to calculate empirical IMs. 
+It uses the openquake engine to calculate the IMs. The script takes the following parameters:
+
+```
+positional arguments:
+  output                output directory
+
+options:
+  -h, --help            show this help message and exit
+  --ll_ffp LL_FFP       Path to the .ll file
+  --vs30_ffp VS30_FFP   Path to the .vs30 file
+  --z_ffp Z_FFP         Path to the .z file that contains Z1.0 and Z2.5. If not available, estimate from vs30
+                        utilizing relations in z_model_calculations.py. (eg. chiou_young_08_calc_z1p0). The file
+                        should have columns: station, z1p0, z2p5, sigma
+  --srf_ffp SRF_FFP     Path to the SRF file
+  --nhm_ffp NHM_FFP     Path to the NHM file. If srf_ffp is not provided, this is used to get the fault data. Get
+                        one from https://github.com/ucgmsim/Empirical_Engine/files/15256612/NZ_FLTmodel_2010_v18p6.txt
+  --srfdata_ffp SRFDATA_FFP
+                        Path to the SRF .info or .csv file
+  -rm MAX_RUPTURE_DISTANCE, --max_rupture_distance MAX_RUPTURE_DISTANCE
+                        Only calculate empiricals for stations that are within X distance to rupture
+  --nz_gmdb_source_ffp NZ_GMDB_SOURCE_FFP
+                        NZ GMDB source CSV. Required for historical events when srfdata is missing. Use
+                        earthquake_source_table.csv contained in GMDB.zip from https://osf.io/q9yrg/?view_only=05337ba1ebc744fc96b9924de633ca0e 
+  --model_config_ffp MODEL_CONFIG_FFP
+                        Path to the model_config file. Found in Empirical util.
+  --meta_config_ffp META_CONFIG_FFP
+                        Path to the meta_config weight file. Found in Empirical util.
+  -e, --extended_period
+                        Indicate the use of extended(100) pSA periods
+  -p PERIODS [PERIODS ...], --periods PERIODS [PERIODS ...]
+                        pSA period(s) separated by a " " space. eg: 0.02 0.05 0.1.
+  -m IM [IM ...], --im IM [IM ...]
+                        Intensity measure(s) separated by a " " space(if more than one). eg: PGV PGA CAV.
+  -comp {090,000,ver,H1,H2,geom,rotd50,rotd100,rotd100_50,norm,EAS}, --component {090,000,ver,H1,H2,geom,rotd50,rotd100,rotd100_50,norm,EAS}
+                        The component you want to calculate.
+
+```
+This is designed to accommodate fairly flexible situations. In practice, we often find .srf, .info and some .csv files missing.
+- If srf_ffp is not supplied, and it is a known fault in NHM, it will extract the srf data directly from NHM.
+- srfdata_ffp can be either .csv or .info.
+- If neither .csv nor .info is supplied, and if it is a historical event (found in NZ_GMDB) , it will find the event info from NZ_GMDB and carry on.
+
+Data files can be downloaded from the following links:
+- earthquake_source_table.csv can be found in the [GMDB.zip](https://osf.io/q9yrg/?view_only=05337ba1ebc744fc96b9924de633ca0e)
+- NHM file : [NZ_FLTmodel_2010_v18p6.txt](https://github.com/ucgmsim/Empirical_Engine/files/15256612/NZ_FLTmodel_2010_v18p6.txt) (Credit: [GNS Science](https://www.gns.cri.nz/data-and-resources/2010-national-seismic-hazard-model/))
+
+Note that  
+- Z-values must be supplied. Z1.0 and Z2.5 can be estimated from vs30 using the relations in z_model_calculations.py.
+- If the model_config_ffp is not supplied, it will use the default model_config found in Empirical util.
+- If the meta_config_ffp is not supplied, it will use the default meta_config found in Empirical util.
+
+
+Internally, it calls the function oq_run in util.openquake_wrapper_vectorised.py with the following parameters:
+
+    model_type: GMM
+        OQ model
+    tect_type: TectType
+        One of the tectonic types from
+        ACTIVE_SHALLOW, SUBDUCTION_SLAB and SUBDUCTION_INTERFACE
+    rupture_df: Rupture DF
+        Columns for properties. E.g., vs30, z1pt0, rrup, rjb, mag, rake, dip....
+        Rows be the separate site-fault pairs
+    im: string
+        intensity measure
+    periods: Sequence[Union[int, float]]
+        for spectral acceleration, openquake tables automatically
+        interpolate values between specified values, fails if outside range
+    meta_config: Dict
+        A dictionary contains models and its weight
+    kwargs: pass extra (model specific) parameters to models
+    

oq_wrapper-2025.12.3/README.md

@@ -0,0 +1,80 @@
+[![Build Status](https://quakecoresoft.canterbury.ac.nz/jenkins/job/Empirical_Engine/badge/icon?build=last:${params.ghprbActualCommit=master})](https://quakecoresoft.canterbury.ac.nz/jenkins/job/Empirical_Engine)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Empirical_Engine
+Contains codes to calculate Empirical IMs using the openquake engine
+
+## To calculate empirical IMs
+
+calculate_empirical.py is the main script to calculate empirical IMs. 
+It uses the openquake engine to calculate the IMs. The script takes the following parameters:
+
+```
+positional arguments:
+  output                output directory
+
+options:
+  -h, --help            show this help message and exit
+  --ll_ffp LL_FFP       Path to the .ll file
+  --vs30_ffp VS30_FFP   Path to the .vs30 file
+  --z_ffp Z_FFP         Path to the .z file that contains Z1.0 and Z2.5. If not available, estimate from vs30
+                        utilizing relations in z_model_calculations.py. (eg. chiou_young_08_calc_z1p0). The file
+                        should have columns: station, z1p0, z2p5, sigma
+  --srf_ffp SRF_FFP     Path to the SRF file
+  --nhm_ffp NHM_FFP     Path to the NHM file. If srf_ffp is not provided, this is used to get the fault data. Get
+                        one from https://github.com/ucgmsim/Empirical_Engine/files/15256612/NZ_FLTmodel_2010_v18p6.txt
+  --srfdata_ffp SRFDATA_FFP
+                        Path to the SRF .info or .csv file
+  -rm MAX_RUPTURE_DISTANCE, --max_rupture_distance MAX_RUPTURE_DISTANCE
+                        Only calculate empiricals for stations that are within X distance to rupture
+  --nz_gmdb_source_ffp NZ_GMDB_SOURCE_FFP
+                        NZ GMDB source CSV. Required for historical events when srfdata is missing. Use
+                        earthquake_source_table.csv contained in GMDB.zip from https://osf.io/q9yrg/?view_only=05337ba1ebc744fc96b9924de633ca0e 
+  --model_config_ffp MODEL_CONFIG_FFP
+                        Path to the model_config file. Found in Empirical util.
+  --meta_config_ffp META_CONFIG_FFP
+                        Path to the meta_config weight file. Found in Empirical util.
+  -e, --extended_period
+                        Indicate the use of extended(100) pSA periods
+  -p PERIODS [PERIODS ...], --periods PERIODS [PERIODS ...]
+                        pSA period(s) separated by a " " space. eg: 0.02 0.05 0.1.
+  -m IM [IM ...], --im IM [IM ...]
+                        Intensity measure(s) separated by a " " space(if more than one). eg: PGV PGA CAV.
+  -comp {090,000,ver,H1,H2,geom,rotd50,rotd100,rotd100_50,norm,EAS}, --component {090,000,ver,H1,H2,geom,rotd50,rotd100,rotd100_50,norm,EAS}
+                        The component you want to calculate.
+
+```
+This is designed to accommodate fairly flexible situations. In practice, we often find .srf, .info and some .csv files missing.
+- If srf_ffp is not supplied, and it is a known fault in NHM, it will extract the srf data directly from NHM.
+- srfdata_ffp can be either .csv or .info.
+- If neither .csv nor .info is supplied, and if it is a historical event (found in NZ_GMDB) , it will find the event info from NZ_GMDB and carry on.
+
+Data files can be downloaded from the following links:
+- earthquake_source_table.csv can be found in the [GMDB.zip](https://osf.io/q9yrg/?view_only=05337ba1ebc744fc96b9924de633ca0e)
+- NHM file : [NZ_FLTmodel_2010_v18p6.txt](https://github.com/ucgmsim/Empirical_Engine/files/15256612/NZ_FLTmodel_2010_v18p6.txt) (Credit: [GNS Science](https://www.gns.cri.nz/data-and-resources/2010-national-seismic-hazard-model/))
+
+Note that  
+- Z-values must be supplied. Z1.0 and Z2.5 can be estimated from vs30 using the relations in z_model_calculations.py.
+- If the model_config_ffp is not supplied, it will use the default model_config found in Empirical util.
+- If the meta_config_ffp is not supplied, it will use the default meta_config found in Empirical util.
+
+
+Internally, it calls the function oq_run in util.openquake_wrapper_vectorised.py with the following parameters:
+
+    model_type: GMM
+        OQ model
+    tect_type: TectType
+        One of the tectonic types from
+        ACTIVE_SHALLOW, SUBDUCTION_SLAB and SUBDUCTION_INTERFACE
+    rupture_df: Rupture DF
+        Columns for properties. E.g., vs30, z1pt0, rrup, rjb, mag, rake, dip....
+        Rows be the separate site-fault pairs
+    im: string
+        intensity measure
+    periods: Sequence[Union[int, float]]
+        for spectral acceleration, openquake tables automatically
+        interpolate values between specified values, fails if outside range
+    meta_config: Dict
+        A dictionary contains models and its weight
+    kwargs: pass extra (model specific) parameters to models
+    

oq_wrapper-2025.12.3/oq_wrapper/__init__.py

@@ -0,0 +1,18 @@
+from . import constants, estimations
+from .wrapper import (
+    OQ_MODEL_MAPPING,
+    get_model_from_str,
+    load_gmm_logic_tree_config,
+    run_gmm,
+    run_gmm_logic_tree,
+)
+
+__all__ = [
+    "estimations",
+    "constants",
+    "run_gmm",
+    "run_gmm_logic_tree",
+    "load_gmm_logic_tree_config",
+    "OQ_MODEL_MAPPING",
+    "get_model_from_str",
+]

oq_wrapper-2025.12.3/oq_wrapper/constants.py

@@ -0,0 +1,163 @@
+"""Constants used in the OpenQuake wrapper package."""
+
+from enum import StrEnum, auto
+from pathlib import Path
+
+from openquake.hazardlib import const as oq_const
+
+# Different OQ GMM model standard deviation types of interest
+SPT_STD_DEVS = [
+    oq_const.StdDev.TOTAL,
+    oq_const.StdDev.INTER_EVENT,
+    oq_const.StdDev.INTRA_EVENT,
+]
+
+
+class TectType(StrEnum):
+    """Fault tectonic type."""
+
+    ACTIVE_SHALLOW = auto()
+    VOLCANIC = auto()
+    SUBDUCTION_INTERFACE = auto()
+    SUBDUCTION_SLAB = auto()
+
+
+OQ_TECT_TYPE_MAPPING = {
+    oq_const.TRT.ACTIVE_SHALLOW_CRUST: TectType.ACTIVE_SHALLOW,
+    oq_const.TRT.SUBDUCTION_INTERFACE: TectType.SUBDUCTION_INTERFACE,
+    oq_const.TRT.SUBDUCTION_INTRASLAB: TectType.SUBDUCTION_SLAB,
+    oq_const.TRT.VOLCANIC: TectType.VOLCANIC,
+}
+
+
+class GMM(StrEnum):
+    """Ground motion models."""
+
+    ZA_06 = "ZA_06"
+    AS_16 = "AS_16"
+    BSSA_14 = "BSSA_14"
+    ASK_14 = "ASK_14"
+    BCH_16 = "BCH_16"
+    CB_14 = "CB_14"
+    CY_14 = "CY_14"
+    CB_10 = "CB_10"
+    A_18 = "A_18"
+    P_20 = "P_20"
+    AG_20 = "AG_20"  # (global)
+    K_20 = "K_20"  # (global)
+    K_20_NZ = "K_20_NZ"  # (NZ)
+    AG_20_NZ = "AG_20_NZ"  # (NZ)
+    S_22 = "S_22"
+    A_22 = "A_22"
+    Br_13 = "Br_13"
+    P_21 = "P_21"
+    GA_11 = "GA_11"
+    BA_18 = "BA_18"
+
+
+class GMMLogicTree(StrEnum):
+    """Logic tree for GMMs."""
+
+    NHM2010_BB = "NHM2010_BB"
+    NSHM2022 = "NSHM2022"
+
+
+class EpistemicBranch(StrEnum):
+    """Epistemic uncertainty for GMMs"""
+
+    LOWER = "LOWER"
+    CENTRAL = "CENTRAL"
+    UPPER = "UPPER"
+
+
+GMM_EPISTEMIC_BRANCH_KWARGS_MAPPING = {
+    GMM.S_22: {
+        EpistemicBranch.LOWER: {"mu_branch": "Lower", "sigma_branch": "Lower"},
+        EpistemicBranch.UPPER: {"mu_branch": "Upper", "sigma_branch": "Upper"},
+    }
+}
+
+GMM_EPISTEMIC_BRANCH_SIGMA_FACTOR_MAPPING = {
+    GMM.Br_13: {
+        EpistemicBranch.LOWER: -1.2815,
+        EpistemicBranch.UPPER: 1.2815,
+    },
+    GMM.ASK_14: {
+        EpistemicBranch.LOWER: -1.2815,
+        EpistemicBranch.UPPER: 1.2815,
+    },
+    GMM.CY_14: {
+        EpistemicBranch.LOWER: -1.2815,
+        EpistemicBranch.UPPER: 1.2815,
+    },
+    GMM.CB_14: {
+        EpistemicBranch.LOWER: -1.2815,
+        EpistemicBranch.UPPER: 1.2815,
+    },
+    GMM.BSSA_14: {
+        EpistemicBranch.LOWER: -1.2815,
+        EpistemicBranch.UPPER: 1.2815,
+    },
+}
+
+
+GMM_LT_CONFIG_DIR = Path(__file__).parent / "gmm_logic_tree_configs"
+
+GMM_LT_CONFIG_MAPPING = {
+    GMMLogicTree.NHM2010_BB: GMM_LT_CONFIG_DIR / "nhm_2010_bb_config.yaml",
+    GMMLogicTree.NSHM2022: GMM_LT_CONFIG_DIR / "nshm_2022_config.yaml",
+}
+
+
+NZGMDB_SITE_COLUMNS = [
+    "Vs30",
+    "Z1.0",
+    "Z2.5",
+]
+OQ_SITE_COLUMNS = [
+    "vs30",
+    "z1pt0",
+    "z2pt5",
+]
+
+NZGMDB_SITE_TO_SOURCE_COLUMNS = [
+    "r_rup",
+    "r_jb",
+    "r_x",
+    "r_y",
+    "r_hyp",
+]
+OQ_SITE_TO_SOURCE_COLUMNS = [
+    "rrup",
+    "rjb",
+    "rx",
+    "ry",
+    "rhypo",
+]
+
+NZ_GMDB_SOURCE_COLUMNS = [
+    "mag",
+    "tect_class",
+    "z_tor",
+    "z_bor",
+    "rake",
+    "dip",
+    "ev_depth",
+]
+OQ_SOURCE_COLUMNS = [
+    "mag",
+    "tect_class",
+    "ztor",
+    "zbot",
+    "rake",
+    "dip",
+    "hypo_depth",
+]
+
+
+NZGMDB_COLUMNS = (
+    NZGMDB_SITE_COLUMNS + NZGMDB_SITE_TO_SOURCE_COLUMNS + NZ_GMDB_SOURCE_COLUMNS
+)
+OQ_RUPTURE_COLUMNS = OQ_SITE_COLUMNS + OQ_SITE_TO_SOURCE_COLUMNS + OQ_SOURCE_COLUMNS
+
+NZGMDB_OQ_COL_MAPPING = dict(zip(NZGMDB_COLUMNS, OQ_RUPTURE_COLUMNS))