shakemap-modules 1.2.0__tar.gz → 1.2.1__tar.gz

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/CHANGELOG.md

@@ -1,5 +1,10 @@
 # main
 
+## 1.2.1 / 2026-08-14
+    - Add blas_threads and openmp_threads config parameters to model.conf.
+    - Add thread control to model.
+    - Add tests for threading.
+
 ## 1.2.0 / 2026-08-10
     - Optimize mapping performance:
         o Render the static basemap/faults/roads layers once instead of once per IMT map

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shakemap-modules
-Version: 1.2.0
+Version: 1.2.1
 Summary: USGS Earthquake Impact ShakeMap Modules
 Author-email: Bruce Worden <cbworden@contractor.usgs.gov>, Eric Thompson <emthompsone@usgs.gov>, Mike Hearne <mhearne@usgs.gov>
 License-Expression: CC0-1.0
@@ -29,12 +29,11 @@ Requires-Dist: openpyxl; extra == "dyfi"
 Requires-Dist: pandas>=2.0.2; extra == "dyfi"
 Provides-Extra: exception
 Provides-Extra: gridxml
-Requires-Dist: esi-core>=1.2.8; extra == "gridxml"
 Requires-Dist: mapio>=0.8.8; extra == "gridxml"
 Provides-Extra: history
 Provides-Extra: info
 Provides-Extra: kml
-Requires-Dist: esi-core>=1.2.8; extra == "kml"
+Requires-Dist: esi-core>=1.2.9; extra == "kml"
 Requires-Dist: esi-utils-colors>=1.0.5; extra == "kml"
 Requires-Dist: mapio>=0.8.8; extra == "kml"
 Requires-Dist: fiona>=1.9.4.post1; extra == "kml"
@@ -54,11 +53,12 @@ Requires-Dist: matplotlib>=3.7.1; extra == "mapping"
 Requires-Dist: rasterio; extra == "mapping"
 Requires-Dist: scipy; extra == "mapping"
 Provides-Extra: model
-Requires-Dist: esi-core>=1.2.8; extra == "model"
+Requires-Dist: esi-core>=1.2.9; extra == "model"
 Requires-Dist: mapio>=0.8.8; extra == "model"
 Requires-Dist: cartopy>=0.22.0; extra == "model"
 Requires-Dist: fiona>=1.9.4.post1; extra == "model"
 Requires-Dist: shapely; extra == "model"
+Requires-Dist: threadpoolctl; extra == "model"
 Provides-Extra: plotregr
 Requires-Dist: matplotlib>=3.7.1; extra == "plotregr"
 Provides-Extra: raster
@@ -66,7 +66,7 @@ Requires-Dist: mapio>=0.8.8; extra == "raster"
 Provides-Extra: rupture
 Provides-Extra: save
 Provides-Extra: shape
-Requires-Dist: esi-core>=1.2.8; extra == "shape"
+Requires-Dist: esi-core>=1.2.9; extra == "shape"
 Requires-Dist: esi-utils-colors>=1.0.5; extra == "shape"
 Requires-Dist: fiona>=1.9.4.post1; extra == "shape"
 Requires-Dist: scikit-image; extra == "shape"

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/code.json

@@ -1,4 +1,40 @@
 [
+    {
+        "name": "shakemap-modules",
+        "description": "ShakeMap processing modules.",
+        "version": "v1.2.1",
+        "status": "Development",
+        "organization": "U.S. Geological Survey",
+        "vcs": "git",
+        "repositoryURL": "https://code.usgs.gov/ghsc/esi/shakemap-modules.git",
+        "homepageURL": "https://code.usgs.gov/ghsc/esi/shakemap-modules",
+        "downloadURL": "https://code.usgs.gov/ghsc/esi/shakemap-modules/-/archive/v1.2.1/shakemap-modules-v1.2.1.zip",
+        "disclaimerURL": "https://code.usgs.gov/ghsc/esi/shakemap-modules/-/raw/v1.2.1/DISCLAIMER.md",
+        "permissions": {
+            "usageType": "openSource",
+            "licenses": [
+                {
+                    "name": "Public Domain, CC0-1.0",
+                    "URL": "https://code.usgs.gov/ghsc/esi/shakemap-modules/-/raw/v1.2.1/LICENSE.md"
+                }
+            ]
+        },
+        "laborHours": 1,
+        "languages": [
+            "python"
+        ],
+        "tags": [
+            "earthquake",
+            "utilities"
+        ],
+        "contact": {
+            "name": "Bruce Worden",
+            "email": "cbworden@contractor.usgs.gov"
+        },
+        "date": {
+            "metadataLastUpdated": "2026-08-14"
+        }
+    },
     {
         "name": "shakemap-modules",
         "description": "ShakeMap processing modules.",

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/pyproject.toml

@@ -56,13 +56,12 @@ dyfi = [
 ]
 exception = []
 gridxml = [
-    "esi-core>=1.2.8",
     "mapio>=0.8.8",
 ]
 history = []
 info = []
 kml = [
-    "esi-core>=1.2.8",
+    "esi-core>=1.2.9",
     "esi-utils-colors>=1.0.5",
     "mapio>=0.8.8",
     "fiona>=1.9.4.post1",
@@ -84,11 +83,12 @@ mapping = [
     "scipy",
 ]
 model = [
-    "esi-core>=1.2.8",
+    "esi-core>=1.2.9",
     "mapio>=0.8.8",
     "cartopy>=0.22.0",
     "fiona>=1.9.4.post1",
     "shapely",
+    "threadpoolctl",
 ]
 plotregr = [
     "matplotlib>=3.7.1",
@@ -99,7 +99,7 @@ raster = [
 rupture = []
 save = []
 shape = [
-    "esi-core>=1.2.8",
+    "esi-core>=1.2.9",
     "esi-utils-colors>=1.0.5",
     "fiona>=1.9.4.post1",
     "scikit-image",

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules/coremods/model.py

@@ -15,8 +15,16 @@ import inspect
 import json
 import os
 import os.path
+from contextlib import contextmanager, nullcontext
 
 from openquake.hazardlib import imt
+from threadpoolctl import threadpool_limits
+
+from esi_core.shakemap.covariance_matrix import (
+    get_openmp_threads,
+    has_openmp,
+    set_openmp_threads,
+)
 
 from shakemap_modules.base.base import Contents, CoreModule
 from shakemap_modules.utils.utils import get_object_from_config
@@ -111,14 +119,16 @@ class ModelModule(CoreModule):
         self.logger.debug("Starting model...")
 
         self._open_input_and_build_context(indir)
-        do_mmi = self._setup_gmpe_ipe_gmice()
-        self._setup_rupture_and_origin()
-        self._setup_output_geometry()
-        self._setup_station_data()
-        full_oqimt_dict = self._build_full_oqimt_dict(do_mmi)
-        self._run_bias_and_mvn(full_oqimt_dict)
-        masking.apply_custom_mask(self.ctx)
-        self._write_output(outdir)
+
+        with self._threading_context():
+            do_mmi = self._setup_gmpe_ipe_gmice()
+            self._setup_rupture_and_origin()
+            self._setup_output_geometry()
+            self._setup_station_data()
+            full_oqimt_dict = self._build_full_oqimt_dict(do_mmi)
+            self._run_bias_and_mvn(full_oqimt_dict)
+            masking.apply_custom_mask(self.ctx)
+            self._write_output(outdir)
 
         if self.process == "shakemap":
             self.contents.addFile(
@@ -163,6 +173,65 @@ class ModelModule(CoreModule):
 
         model_config.populate_config_options(self.ctx)
 
+    @contextmanager
+    def _threading_context(self):
+        """
+        Apply model.conf native-thread limits for the duration of modeling.
+
+        A configured value of 0 means ShakeMap does not alter that runtime's
+        current/native setting. Positive BLAS limits are applied through
+        threadpoolctl. Positive OpenMP limits are applied through esi-core's
+        OpenMP runtime API. The prior OpenMP setting is restored on exit so
+        ModelModule does not leak thread-state changes into later work in the
+        same Python process.
+        """
+        blas_threads = self.ctx.blas_threads
+        openmp_threads = self.ctx.openmp_threads
+
+        if blas_threads > 0:
+            blas_context = threadpool_limits(
+                limits=blas_threads,
+                user_api="blas",
+            )
+            self.logger.info("BLAS thread limit: %d", blas_threads)
+        else:
+            blas_context = nullcontext()
+            self.logger.info(
+                "BLAS thread limit: native/unrestricted "
+                "(not set by ShakeMap)"
+            )
+
+        original_openmp_threads = None
+        restore_openmp = False
+
+        with blas_context:
+            if openmp_threads > 0:
+                if has_openmp():
+                    original_openmp_threads = get_openmp_threads()
+                    set_openmp_threads(openmp_threads)
+                    restore_openmp = original_openmp_threads is not None
+                    self.logger.info(
+                        "OpenMP thread limit: %d", openmp_threads
+                    )
+                else:
+                    self.logger.warning(
+                        "openmp_threads is set to %d, but esi-core was "
+                        "built without OpenMP support; the setting will "
+                        "be ignored.",
+                        openmp_threads,
+                    )
+            else:
+                self.logger.info(
+                    "OpenMP thread limit: native/unrestricted "
+                    "(not set by ShakeMap)"
+                )
+
+            try:
+                yield
+            finally:
+                if restore_openmp:
+                    set_openmp_threads(original_openmp_threads)
+
     def _setup_gmpe_ipe_gmice(self):
         """
         Build the output GMPE set, ensure a VirtualIPE (if configured)

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules/data/model.conf

@@ -37,18 +37,37 @@
     #---------------------------------------------------------------------------
     # row_block: The number of output grid rows to combine in each pass of the
     # MVN algorithm. Larger numbers are often faster but consume more memory.
-    # Benchmarking is advised when changing this value. The default (8) provides
-    # good results on an M3 Mac with 64GB memory, but 16 produced slightly
-    # better runtimes (about 1%). YMMV. Individual results will depend on BLAS
-    # implementation, thread count, cache hierarchy, memory bandwidth, number
-    # of stations, and grid width, as well as total available memory.
-    # The minimum is 1, the default is 8.
+    # The minimum is 1 and the default is 8.
+    #
+    # sm_tune does not determine this value. Users wishing to change row_block
+    # should benchmark representative ShakeMap events on the target machine.
+    # Performance depends on factors including BLAS implementation and thread
+    # count, cache hierarchy, memory bandwidth, number of stations, grid width,
+    # and available memory.
+    #
+    # The default value of 8 has provided a good balance of runtime and memory
+    # use in testing; larger values may be slightly faster on some systems.
+    #---------------------------------------------------------------------------
+    row_block = 8
+
+    #---------------------------------------------------------------------------
+    # blas_threads:
+    # Maximum number of threads used by BLAS/LAPACK operations. A value of 0
+    # leaves the native BLAS runtime unrestricted. This is a machine-specific
+    # performance setting and may be determined with sm_tune.
+    #
+    # openmp_threads:
+    # Maximum number of OpenMP threads used by esi-core numerical routines.
+    # A value of 0 leaves the OpenMP runtime unrestricted. This is a
+    # machine-specific performance setting and may be determined with sm_tune.
     #---------------------------------------------------------------------------
+    blas_threads = 0
+    openmp_threads = 0
 
 #---------------------------------------------------------------------------
 # [gmpe_sets]: GMPE sets may be specified in this file. See the documentation
 # within gmpe_sets.conf for the details. This facility is provided mainly
-# to support the automatic generation of event-specific model_zc.conf
+# to support the automatic generation of event-specific model_select.conf
 # files with custom GMPE sets.
 #---------------------------------------------------------------------------
 

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules/data/modelspec.conf

@@ -27,6 +27,8 @@
     max_workers = integer(default=0)  # Now defunct. Preserved for backward
                                       # compatibility.
     row_block = integer(min=1, default=8)
+    blas_threads = integer(min=0, default=0)
+    openmp_threads = integer(min=0, default=0)
 
 [data]
     vs30file = file_type(default='')

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules/modeling/config.py

@@ -142,8 +142,8 @@ def populate_config_options(ctx):
     Unpack processing/bias/outlier/grid/vs30 options from ctx.config
     onto ctx. Requires ctx.config to already be set.
 
-    Mutates: ctx.row_block, ctx.apply_gafs,
-        ctx.do_bias, ctx.bias_max_range, ctx.bias_max_mag,
+    Mutates: ctx.row_block, ctx.blas_threads, ctx.openmp_threads,
+        ctx.apply_gafs, ctx.do_bias, ctx.bias_max_range, ctx.bias_max_mag,
         ctx.bias_max_dsigma, ctx.do_outliers,
         ctx.outlier_deviation_level, ctx.outlier_max_mag,
         ctx.outlier_valid_stations, ctx.imt_out_set, ctx.smdx,
@@ -159,6 +159,12 @@ def populate_config_options(ctx):
     # Must be >= 1 (validated at the config-schema level, not here).
     ctx.row_block = config["system"]["row_block"]
 
+    # Machine-specific native threading limits. A value of 0 means that
+    # ShakeMap should leave the corresponding runtime unrestricted.
+    # These values are validated by modelspec.conf.
+    ctx.blas_threads = config["system"]["blas_threads"]
+    ctx.openmp_threads = config["system"]["openmp_threads"]
+
     ctx.apply_gafs = config["modeling"]["apply_generic_amp_factors"]
 
     bias = config["modeling"]["bias"]

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules/modeling/context.py

@@ -148,6 +148,13 @@ class ModelingContext:
     # deployment without a code change. Must be >= 1; no upper bound.
     row_block: int = None
 
+    # Machine-specific thread limits for numerical runtimes. A value of 0
+    # means "unrestricted": the model should not modify that runtime's native
+    # thread setting. Positive values are explicit limits, normally determined
+    # by sm_tune.
+    blas_threads: int = 0
+    openmp_threads: int = 0
+
     do_bias: bool = True
     bias_max_range: float = None
     bias_max_mag: float = None

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shakemap-modules
-Version: 1.2.0
+Version: 1.2.1
 Summary: USGS Earthquake Impact ShakeMap Modules
 Author-email: Bruce Worden <cbworden@contractor.usgs.gov>, Eric Thompson <emthompsone@usgs.gov>, Mike Hearne <mhearne@usgs.gov>
 License-Expression: CC0-1.0
@@ -29,12 +29,11 @@ Requires-Dist: openpyxl; extra == "dyfi"
 Requires-Dist: pandas>=2.0.2; extra == "dyfi"
 Provides-Extra: exception
 Provides-Extra: gridxml
-Requires-Dist: esi-core>=1.2.8; extra == "gridxml"
 Requires-Dist: mapio>=0.8.8; extra == "gridxml"
 Provides-Extra: history
 Provides-Extra: info
 Provides-Extra: kml
-Requires-Dist: esi-core>=1.2.8; extra == "kml"
+Requires-Dist: esi-core>=1.2.9; extra == "kml"
 Requires-Dist: esi-utils-colors>=1.0.5; extra == "kml"
 Requires-Dist: mapio>=0.8.8; extra == "kml"
 Requires-Dist: fiona>=1.9.4.post1; extra == "kml"
@@ -54,11 +53,12 @@ Requires-Dist: matplotlib>=3.7.1; extra == "mapping"
 Requires-Dist: rasterio; extra == "mapping"
 Requires-Dist: scipy; extra == "mapping"
 Provides-Extra: model
-Requires-Dist: esi-core>=1.2.8; extra == "model"
+Requires-Dist: esi-core>=1.2.9; extra == "model"
 Requires-Dist: mapio>=0.8.8; extra == "model"
 Requires-Dist: cartopy>=0.22.0; extra == "model"
 Requires-Dist: fiona>=1.9.4.post1; extra == "model"
 Requires-Dist: shapely; extra == "model"
+Requires-Dist: threadpoolctl; extra == "model"
 Provides-Extra: plotregr
 Requires-Dist: matplotlib>=3.7.1; extra == "plotregr"
 Provides-Extra: raster
@@ -66,7 +66,7 @@ Requires-Dist: mapio>=0.8.8; extra == "raster"
 Provides-Extra: rupture
 Provides-Extra: save
 Provides-Extra: shape
-Requires-Dist: esi-core>=1.2.8; extra == "shape"
+Requires-Dist: esi-core>=1.2.9; extra == "shape"
 Requires-Dist: esi-utils-colors>=1.0.5; extra == "shape"
 Requires-Dist: fiona>=1.9.4.post1; extra == "shape"
 Requires-Dist: scikit-image; extra == "shape"

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules.egg-info/requires.txt

@@ -45,7 +45,6 @@ pandas>=2.0.2
 [exception]
 
 [gridxml]
-esi-core>=1.2.8
 mapio>=0.8.8
 
 [history]
@@ -53,7 +52,7 @@ mapio>=0.8.8
 [info]
 
 [kml]
-esi-core>=1.2.8
+esi-core>=1.2.9
 esi-utils-colors>=1.0.5
 mapio>=0.8.8
 fiona>=1.9.4.post1
@@ -75,11 +74,12 @@ rasterio
 scipy
 
 [model]
-esi-core>=1.2.8
+esi-core>=1.2.9
 mapio>=0.8.8
 cartopy>=0.22.0
 fiona>=1.9.4.post1
 shapely
+threadpoolctl
 
 [plotregr]
 matplotlib>=3.7.1
@@ -92,7 +92,7 @@ mapio>=0.8.8
 [save]
 
 [shape]
-esi-core>=1.2.8
+esi-core>=1.2.9
 esi-utils-colors>=1.0.5
 fiona>=1.9.4.post1
 scikit-image

{shakemap_modules-1.2.0 → shakemap_modules-1.2.1}/src/shakemap_modules.egg-info/scm_file_list.json

@@ -406,6 +406,8 @@
     "tests/station_data_test.py",
     "tests/station_json_test.py",
     "tests/storage_test.py",
+    "tests/test_model_threading.py",
+    "tests/test_modeling_config_threads.py",
     "tests/transfer_test.py",
     "tests/util_amps_test.py",
     "tests/util_config_test.py",

shakemap_modules-1.2.1/src/shakemap_modules.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.2.1",
+  "distance": 0,
+  "node": "ga1a2ba10097fb99ade9e463c5593c91690f3f1df",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-08-14"
+}

shakemap_modules-1.2.0/src/shakemap_modules.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "1.2.0",
-  "distance": 0,
-  "node": "g21c6f8e311fea23387545ac910ca98ba4cc47950",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-08-10"
-}