source-modelling 2026.7.2__tar.gz → 2026.7.3__tar.gz

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: source-modelling
-Version: 2026.7.2
+Version: 2026.7.3
 Summary: Source modelling library
 Author: ucgmsim
 Requires-Python: >=3.12

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/source_modelling/fsp.py

@@ -65,8 +65,6 @@ def _normalise_value(value: float) -> float | None:
 class FSPParseError(Exception):
     """Exception raised for errors in parsing FSP files."""
 
-    pass
-
 
 @dataclasses.dataclass
 class Segment:
@@ -278,11 +276,7 @@ class FSPFile:
             for line in fsp_file_handle:
                 if line.startswith("% Data"):
                     break
-                if (
-                    line.startswith("% -")
-                    or line.strip() == "%"
-                    or line.startswith("% Event :")
-                ):
+                if line.startswith(("% -", "% Event :")) or line.strip() == "%":
                     continue
                 # Strip the leading "% ", and deduplicate the spaces in the line.
                 # This is required to normalise the string so that the parse

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/source_modelling/parse_utils.py

@@ -6,7 +6,6 @@ from typing import TextIO
 class ParseError(Exception):
     """Error for parsing files in source modelling."""
 
-    pass
 
 
 def _is_seperator(char: str) -> bool:

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/source_modelling/rupture_propagation.py

@@ -59,7 +59,7 @@ def spanning_tree_with_probabilities(
     trees = []
     probabilities = []
 
-    for tree in mst.SpanningTreeIterator(graph):  # type: ignore
+    for tree in mst.SpanningTreeIterator(graph):  # ty: ignore[invalid-argument-type]
         p_tree = 1.0
         for u, v in graph.edges:
             if tree.has_edge(u, v):
@@ -223,7 +223,7 @@ def select_top_spanning_trees(
     cumulative_tree_weight = 0.0
     spanning_trees = []
 
-    for spanning_tree in mst.SpanningTreeIterator(weighted_graph, minimum=False):  # type: ignore
+    for spanning_tree in mst.SpanningTreeIterator(weighted_graph, minimum=False):  # ty: ignore[invalid-argument-type]
         spanning_trees.append(spanning_tree)
         tree_log_probability = sum(
             spanning_tree[node_u][node_v]["weight"]

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/source_modelling/sources.py

@@ -1042,7 +1042,7 @@ class Fault:
 
         # This relation can now be used to identify if the list of planes given is a line.
         points_into_graph: nx.DiGraph = nx.from_dict_of_lists(
-            points_into_relation,  # type: ignore
+            points_into_relation,  # ty: ignore[invalid-argument-type]
             create_using=nx.DiGraph,
         )
         try:
@@ -1221,12 +1221,12 @@ class Fault:
         return self.fault_coordinates_to_wgs_depth_coordinates(np.array([1 / 2, 1 / 2]))
 
     @property
-    def geometry(self) -> shapely.Polygon | shapely.LineString:  # numpydoc ignore=RT01
+    def geometry(self) -> shapely.Geometry:  # numpydoc ignore=RT01
         """shapely.Polygon or LineString: A shapely geometry for the fault (projected onto the surface).
 
         Geometry will be LineString if `dip = 90`.
         """
-        return shapely.normalize(  # type: ignore
+        return shapely.normalize(
             shapely.union_all([plane.geometry for plane in self.planes])
         )
 
@@ -1376,8 +1376,8 @@ class Fault:
         float
             The Rjb distance (in metres) to the point.
         """
-        return self.geometry.distance(
-            shapely.Point(coordinates.wgs_depth_to_nztm(point))
+        return shapely.distance(
+            self.geometry, shapely.Point(coordinates.wgs_depth_to_nztm(point))
         )
 
     def rx_ry_distance(self, point: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
@@ -1512,15 +1512,14 @@ class CoordinateBounds(NamedTuple):
     """float: Maximum normalised dip coordinate, in the range of [0, 1]."""
 
 
+DEFAULT_BOUNDS = CoordinateBounds(min_strike=0, min_dip=0, max_strike=1, max_dip=1)
+
+
 def closest_point_between_sources(
     source_a: IsSource,
     source_b: IsSource,
-    source_a_coordinate_bounds: CoordinateBounds = CoordinateBounds(
-        min_strike=0, min_dip=0, max_strike=1, max_dip=1
-    ),
-    source_b_coordinate_bounds: CoordinateBounds = CoordinateBounds(
-        min_strike=0, min_dip=0, max_strike=1, max_dip=1
-    ),
+    source_a_coordinate_bounds: CoordinateBounds = DEFAULT_BOUNDS,
+    source_b_coordinate_bounds: CoordinateBounds = DEFAULT_BOUNDS,
 ) -> tuple[np.ndarray, np.ndarray]:
     """Find the closest point between two sources that have local coordinates.
 

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/source_modelling/stoch.py

@@ -12,8 +12,9 @@ References
 .. [0] https://wiki.canterbury.ac.nz/display/QuakeCore/File+Formats+Used+In+Ground+Motion+Simulation#FileFormatsUsedInGroundMotionSimulation-Stochformat
 """
 
+import dataclasses
 from pathlib import Path
-from typing import NamedTuple, TextIO, TypeAlias, cast
+from typing import IO, NamedTuple, Self, TextIO, cast
 
 import numpy as np
 from numpy.typing import NDArray
@@ -23,9 +24,9 @@ from source_modelling import parse_utils
 from source_modelling.sources import Plane
 
 # Type aliases for NumPy arrays with specific shapes and dtypes
-FloatArray2D: TypeAlias = NDArray[np.float32]  # 2D array of float32
-LatLonArray: TypeAlias = NDArray[np.float64]  # Array for latitude/longitude
-CoordinateArray: TypeAlias = NDArray[np.float64]  # Array for coordinates
+type FloatArray2D = NDArray[np.float32]  # 2D array of float32
+type LatLonArray = NDArray[np.float64]  # Array for latitude/longitude
+type CoordinateArray = NDArray[np.float64]  # Array for coordinates
 
 
 class StochHeader(NamedTuple):
@@ -149,6 +150,7 @@ def _read_stoch_plane(handle: TextIO) -> StochPlane:
     return StochPlane(header, slip, rise, trup)
 
 
+@dataclasses.dataclass
 class StochFile:
     """
     Class for reading and accessing stochastic slip model files.
@@ -156,30 +158,10 @@ class StochFile:
     This class handles the parsing of stochastic slip model files and provides
     access to the contained planes and their properties.
 
-    Parameters
-    ----------
-    filename : Path
-        Path to the stochastic slip model file.
-
-    Attributes
-    ----------
-    data : list[StochPlane]
-        Structured raw data read from the stoch file.
-
-    Raises
-    ------
-    ValueError
-        If the number of planes specified in the file is not a positive integer.
-
-    Notes
-    -----
-    Stochastic slip model files contain information about fault planes and their
-    properties such as slip, rise time, and rupture time.
-
     Examples
     --------
     >>> # Assuming 'stoch_model.stoch' exists with valid stochastic slip model data
-    >>> stoch_file = StochFile('stoch_model.stoch')
+    >>> stoch_file = StochFile.from_file('stoch_model.stoch')
     >>> planes = stoch_file.planes
     >>> slips = stoch_file.slip
     >>> rise_times = stoch_file.rise
@@ -190,15 +172,23 @@ class StochFile:
     ...     print(f"Slip array shape for the first plane: {slips[0].shape}")
     """
 
-    def __init__(self, filename: Path):
+    data: list[StochPlane]
+
+    @classmethod
+    def from_file(cls, filename: Path) -> Self:
         """
-        Initialize a StochFile instance by reading data from the specified file.
+        Initialise a StochFile instance by reading data from the specified file.
 
         Parameters
         ----------
         filename : Path
             Path to the stochastic slip model file.
 
+        Returns
+        -------
+        StochFile
+            The stoch file parsed from the filename.
+
         Raises
         ------
         ValueError
@@ -209,10 +199,36 @@ class StochFile:
             n_planes = parse_utils.read_int(handle, "n_planes")
             if n_planes <= 0:
                 raise parse_utils.ParseError(
-                    f"Expected non-negative integer number of planes, received: {n_planes}."
+                    f"Expected positive integer number of planes, received: {n_planes}."
                 )
             planes = [_read_stoch_plane(handle) for _ in range(n_planes)]
-            self.data: list[StochPlane] = planes
+            return cls(planes)
+
+    def dump(self, handle: IO[str]) -> None:
+        """Write a stoch file to a file-like object.
+
+        Parameters
+        ----------
+        handle : File-like object
+          The object to write the stoch file output to.
+        """
+        if not self.data:
+            raise ValueError("Cannot dump empty stoch file")
+        handle.write(f"{len(self.data)}\n")
+        for plane in self.data:
+            header = plane.header
+            handle.write(
+                f"{header.longitude:10.4f} {header.latitude:10.4f} {header.nx:5d} {header.ny:5d} {header.dx:8.2f} {header.dy:8.2f}\n"
+            )
+            handle.write(
+                f"{header.strike:4.0f} {header.dip:4.0f} {header.average_rake:4.0f} {header.dtop:8.2f} {header.shypo:8.2f} {header.dhypo:8.2f}\n"
+            )
+            np.savetxt(
+                handle,
+                np.vstack((plane.slip, plane.rise, plane.trup)),
+                fmt="%13.5e",
+                delimiter="",
+            )
 
     @property
     def planes(self) -> list[Plane]:
@@ -226,7 +242,7 @@ class StochFile:
 
         Examples
         --------
-        >>> stoch_file = StochFile('stoch_model.stoch')
+        >>> stoch_file = StochFile.from_file('stoch_model.stoch')
         >>> planes = stoch_file.planes
         >>> print(f"Number of planes: {len(planes)}")
         """

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/source_modelling.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: source-modelling
-Version: 2026.7.2
+Version: 2026.7.3
 Summary: Source modelling library
 Author: ucgmsim
 Requires-Python: >=3.12

source_modelling-2026.7.3/source_modelling.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2026.7.3",
+  "distance": 0,
+  "node": "gaa2e1ec59c0742728fc6a281bb004bc7a572be30",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-24"
+}

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/src/srf_parser.rs

@@ -53,6 +53,7 @@ fn read_srf_header(
         let ndip = scanner.next()?;
         let len = scanner.next()?;
         let wid = scanner.next()?;
+        scanner.expect_end_of_line()?;
         let stk = scanner.next()?;
         let dip = scanner.next()?;
         let dtop = scanner.next()?;
@@ -81,6 +82,7 @@ fn read_srf_header(
 const APPROX_BYTES_PER_SLIP_VALUE: usize = 12;
 
 // Tiny PointHeader used to construct actual points later.
+#[derive(Debug)]
 struct PointHeader {
     lon: f32,
     lat: f32,
@@ -206,11 +208,6 @@ fn read_srf_points_v2(
     let mut slipt1 = CsrMatrix::new(point_count, slipt1_capacity);
 
     for (i, plane) in planes.iter().enumerate() {
-        // In version 2.0 (and version 2.0 only), it is possible to construct SRFs
-        // with multiple POINT instantiations. Technically V1.0 SRFs could be
-        // constructed with multiple POINTS instantiations but we are deliberately
-        // parsing a stricter subset of the format.
-
         scanner.skip_token(b"POINTS")?;
         let plane_point_count = scanner.next()?;
         if plane.points() != plane_point_count {
@@ -293,7 +290,8 @@ mod tests {
 
     const SRF_V1: &[u8] = b"1.0\n\
 PLANE 1\n\
-0.0 0.0 2 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
+0.0 0.0 2 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
 POINTS 2\n\
 0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1\n\
 30.0 1.5 3 0.0 0 0.0 0\n\
@@ -304,7 +302,8 @@ POINTS 2\n\
 
     const SRF_V2: &[u8] = b"2.0\n\
 PLANE 1\n\
-0.0 0.0 2 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
+0.0 0.0 2 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
 POINTS 2\n\
 0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1 3.5 2.7\n\
 30.0 1.5 3 0.0 0 0.0 0\n\
@@ -347,8 +346,10 @@ POINTS 2\n\
     // Two 1x1 planes, each with its own POINTS block.
     const SRF_V2_TWO_PLANES: &[u8] = b"2.0\n\
 PLANE 2\n\
-0.0 0.0 1 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
-0.5 0.5 1 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
+0.0 0.0 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
+0.5 0.5 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
 POINTS 1\n\
 0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1 3.5 2.7\n\
 30.0 1.5 2 0.0 0 0.0 0\n\
@@ -381,6 +382,34 @@ POINTS 1\n\
         assert_eq!(srf.slipt1.data, vec![0.1, 0.2, 0.4]);
     }
 
+    const SRF_V1_TWO_PLANES: &[u8] = b"1.0\n\
+PLANE 2\n\
+0.0 0.0 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
+0.5 0.5 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
+POINTS 2\n\
+0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1\n\
+30.0 1.5 2 0.0 0 0.0 0\n\
+0.1 0.2\n\
+0.2 -43.1 5.5 90.0 45.0 1.0e10 0.6 0.1\n\
+45.0 2.0 1 0.0 0 0.0 0\n\
+0.4\n";
+
+    #[test]
+    fn parses_v1_with_multiple_planes() {
+        let mut scanner = scanner::Scanner::new(SRF_V1_TWO_PLANES);
+        let srf = read_srf_struct(&mut scanner).unwrap();
+        assert_eq!(srf.planes.len(), 2);
+        let metadata = match &srf.metadata {
+            SrfMetadataVersioned::V1(metadata) => metadata,
+            SrfMetadataVersioned::V2(_) => panic!("expected V1 metadata"),
+        };
+        assert_eq!(metadata.lon, vec![0.1, 0.2]);
+        assert_eq!(srf.slipt1.row_ptr, vec![0, 2, 3]);
+        assert_eq!(srf.slipt1.data, vec![0.1, 0.2, 0.4]);
+    }
+
     #[test]
     fn rejects_v1_point_count_mismatch() {
         // Plane declares 2x1 points but POINTS declares 3.
@@ -460,25 +489,16 @@ POINTS 1\n\
         assert!(read_srf_struct(&mut scanner).is_ok());
     }
 
+    const SRF_BAD_PLANE_HEADER: &[u8] = b"0.0 0.0 2 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0";
+
     #[test]
-    fn mismatch_messages_read_correctly() {
-        let err = SrfParseError::PointCountMismatch {
-            declared: 3,
-            expected: 2,
-        };
-        assert_eq!(
-            err.to_string(),
-            "PLANE headers expect 2 total points but POINTS declares 3"
-        );
-        let err = SrfParseError::PlanePointCountMismatch {
-            plane: 1,
-            declared: 2,
-            expected: 1,
-        };
-        assert_eq!(
-            err.to_string(),
-            "plane 1 expects 1 points but its POINTS block declares 2"
-        );
+    fn plane_header_rejects_no_newline() {
+        let mut scanner = scanner::Scanner::new(SRF_BAD_PLANE_HEADER);
+        let err = read_srf_header(&mut scanner, 1).unwrap_err();
+        assert!(matches!(
+            err,
+            SrfParseError::Scanner(scanner::ScannerError::NoNewlineFound { .. })
+        ));
     }
 
     fn replace_once(data: &[u8], from: &[u8], to: &[u8]) -> Vec<u8> {

{source_modelling-2026.7.2 → source_modelling-2026.7.3}/src/srf_writer.rs

@@ -113,18 +113,13 @@ fn write_plane_header<W: Write>(writer: &mut W, planes: &[SrfPlane]) -> Result<(
     for plane in planes {
         writeln!(
             writer,
-            "{} {} {} {} {} {} {} {} {} {} {}",
-            plane.elon,
-            plane.elat,
-            plane.nstk,
-            plane.ndip,
-            plane.len,
-            plane.wid,
-            plane.stk,
-            plane.dip,
-            plane.dtop,
-            plane.shyp,
-            plane.dhyp
+            "{} {} {} {} {} {}",
+            plane.elon, plane.elat, plane.nstk, plane.ndip, plane.len, plane.wid,
+        )?;
+        writeln!(
+            writer,
+            "{} {} {} {} {}",
+            plane.stk, plane.dip, plane.dtop, plane.shyp, plane.dhyp
         )?;
     }
     Ok(())
@@ -165,7 +160,8 @@ mod tests {
 
     const SRF_V1: &[u8] = b"1.0\n\
 PLANE 1\n\
-0.0 0.0 2 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
+0.0 0.0 2 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
 POINTS 2\n\
 0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1\n\
 30.0 1.5 3 0.0 0 0.0 0\n\
@@ -176,8 +172,10 @@ POINTS 2\n\
 
     const SRF_V2_TWO_PLANES: &[u8] = b"2.0\n\
 PLANE 2\n\
-0.0 0.0 1 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
-0.5 0.5 1 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
+0.0 0.0 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
+0.5 0.5 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
 POINTS 1\n\
 0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1 3.5 2.7\n\
 30.0 1.5 2 0.0 0 0.0 0\n\
@@ -275,7 +273,8 @@ POINTS 1\n\
     fn empty_slip_row_roundtrips() {
         let data = b"1.0\n\
 PLANE 1\n\
-0.0 0.0 1 1 4.0 2.0 90.0 45.0 0.0 0.0 1.0\n\
+0.0 0.0 1 1 4.0 2.0\n\
+90.0 45.0 0.0 0.0 1.0\n\
 POINTS 1\n\
 0.1 -43.0 5.0 90.0 45.0 1.0e10 0.5 0.1\n\
 30.0 1.5 0 0.0 0 0.0 0\n";