pyrocko · miili · Apr 15, 2025 · Apr 15, 2025 · Apr 15, 2025 · Apr 20, 2025
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,13 +10,13 @@ repos:
       - id: mixed-line-ending
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.8.1
+    rev: v0.11.9
     hooks:
       - id: ruff
       - id: ruff-format
       - args: [--fix]
         id: ruff
-  # - repo: https://github.com/pre-commit/mirrors-clang-format
-  #   rev: v19.1.7
-  #   hooks:
-  #   - id: clang-format
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v19.1.4
+    hooks:
+      - id: clang-format
diff --git a/docs/api/models.md b/docs/api/models.md
@@ -0,0 +1,5 @@
+# Models
+
+::: qseek.models.location.Location
+
+::: qseek.models.detection.EventDetection
diff --git a/docs/api/octree.md b/docs/api/octree.md
@@ -0,0 +1,3 @@
+# Octree
+
+::: qseek.octree.Octree
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -0,0 +1,3 @@
+# API Overview
+
+The following pages give an overview of the Python API.
diff --git a/docs/api/ray_tracer.md b/docs/api/ray_tracer.md
@@ -0,0 +1,3 @@
+# Ray Tracers
+
+::: qseek.tracers.base.RayTracer
diff --git a/docs/api/stations.md b/docs/api/stations.md
@@ -0,0 +1,5 @@
+# Station Inventory
+
+::: qseek.models.station.Station
+
+::: qseek.models.station.Stations
diff --git a/docs/api/utils.md b/docs/api/utils.md
@@ -0,0 +1,4 @@
+# Utils
+
+::: qseek.utils.Range
+::: qseek.utils._Range
diff --git a/docs/components/image_function.md b/docs/components/image_function.md
@@ -1,6 +1,6 @@
-# Image Function
+# Phase Arrival Image Function
 
-For image functions this version of Qseek relies heavily on machine learning pickers delivered by [SeisBench](https://github.com/seisbench/seisbench).
+For image functions this version of Qseek relies heavily on machine learning phase-arrival pickers delivered by [SeisBench](https://github.com/seisbench/seisbench).
 
 ## SeisBench Image Function
 

diff --git a/docs/components/magnitudes.md b/docs/components/magnitudes.md
@@ -0,0 +1,25 @@
+# Earthquake Magnitude Calculation
+
+Qseek supports earthquake magnitude calculation as Local Magnitudes in different attenuation models and Moment Magnitudes derived from forward-modelled attenuation curves.
+
+## Local Magnitude
+
+Local magnitude calculation relies on a tuned attenuation model.
+
+```python exec='on'
+from qseek.utils import generate_docs
+from qseek.magnitudes.local_magnitude import LocalMagnitudeExtractor
+
+print(generate_docs(LocalMagnitudeExtractor()))
+```
+
+## Moment Magnitude
+
+Based on forward-modelled attenuation curves using [Pyrocko-GF](https://pyrocko.org/docs/current/topics/pyrocko-gf.html). For more information on the method see [Dahm et al., 2024](https://doi.org/10.26443/seismica.v3i2.1205).
+
+```python exec='on'
+from qseek.utils import generate_docs
+from qseek.magnitudes.moment_magnitude import MomentMagnitudeExtractor
+
+print(generate_docs(MomentMagnitudeExtractor()))
+```
diff --git a/docs/components/octree.md b/docs/components/octree.md
@@ -1,16 +1,15 @@
-# Octree
+# Octree Search Volume
 
 A 3D space is searched for sources of seismic energy. Qseek created an octree structure which is iteratively refined when energy is detected, to focus on the source' location. This speeds up the search and improves the resolution of the localisations.
 
 ![Octree Concept](../images/octree-concept.webp)
-
-*Surface projection of the refined octree focusing on the seismic source region. In this example four levels of refinement are can be seen, refining the 3D octree from the initial 4000 nodes to 8823 nodes.*
+/// caption
+Surface projection of the refined octree focusing on the seismic source region. In this example four levels of refinement are can be seen, refining the 3D octree from the initial 4000 nodes to 8823 nodes.
+///
 
 ```python exec='on'
 from qseek.utils import generate_docs
 from qseek.octree import Octree
 
 print(generate_docs(Octree()))
 ```
-
-::: qseek.octree.Octree
diff --git a/docs/components/ray_tracer.md b/docs/components/ray_tracer.md
@@ -19,12 +19,27 @@ from qseek.tracers.constant_velocity import ConstantVelocityTracer
 print(generate_docs(ConstantVelocityTracer()))
 ```
 
-## 1D Layered Model
+## 1D Layered Model (Eikonal)
+
+Travel times in 1D layered media are calculated by a 2D fast-marching Eikonal solution.
+
+*Pyrocko Cake 1D ray tracer for travel time calculation in 1D layered media*
+
+```python exec='on'
+from qseek.utils import generate_docs
+from qseek.tracers.fast_marching import FastMarchingTracer
+
+print(generate_docs(FastMarchingTracer()))
+```
+
+## 1D Layered Model (Pyrocko Cake Raytracer)
 
 Calculation of travel times in 1D layered media is based on the [Pyrocko Cake](https://pyrocko.org/docs/current/apps/cake/manual.html#command-line-examples) ray tracer.
 
 ![Pyrocko Cake Ray Tracer](https://pyrocko.org/docs/current/_images/cake_plot_example_2.png)
-*Pyrocko Cake 1D ray tracer for travel time calculation in 1D layered media*
+/// caption
+Pyrocko Cake 1D ray tracer for travel time calculation in 1D layered media
+///
 
 ```python exec='on'
 from qseek.utils import generate_docs
@@ -33,7 +48,7 @@ from qseek.tracers.cake import CakeTracer
 print(generate_docs(CakeTracer(), exclude={'earthmodel': {'raw_file_data'}}))
 ```
 
-## 3D Fast Marching
+## 3D Fast Marching 🚀
 
 We implement the fast marching method for calculating first arrivals of waves in 3D volumes. Currently three different 3D velocity models are supported:
 
@@ -42,13 +57,15 @@ We implement the fast marching method for calculating first arrivals of waves in
 * [x] Constant velocity, mainly for testing purposes 🥼
 
 ![Fast Marhing Concept](../images/fmm-concept.webp)
-*Conceptual 2D visualisation for seismic traveltimes calculation in heterogenous media using the fast-marching method for the Eikonal solution is presented. Traveltimes from the receiving station at the surface (indicated by a yellow triangle) towards the subsurface grid are calculated, resulting in station-specifig traveltimes for all potential source locations simultaneously.*
+/// caption
+Conceptual 2D visualisation for seismic traveltimes calculation in heterogenous media using the fast-marching method for the Eikonal solution is presented. Traveltimes from the receiving station at the surface (indicated by a yellow triangle) towards the subsurface grid are calculated, resulting in station-specifig traveltimes for all potential source locations simultaneously.
+///
 
 ```python exec='on'
 from qseek.utils import generate_docs
-from qseek.insights.tracers.fast_marching import FastMarchingTracer
+from qseek.insights.tracers.fast_marching_3d import FastMarching3DTracer
 
-print(generate_docs(FastMarchingTracer()))
+print(generate_docs(FastMarching3DTracer()))
 ```
 
 ### Visualizing 3D Models

diff --git a/docs/components/station_corrections.md b/docs/components/station_corrections.md
@@ -4,8 +4,10 @@ Station corrections can be extract from previous runs to refine the localisation
 
 ## Station Specific Corrections
 
-![Source specific delay statistic](../images/station-delay-times.webp)
+![Source specific delay statistic](../images/station-delay-times.webp){ width=600 }
+/// caption
 *Statistics of station delay times.*
+///
 
 ```python exec='on'
 from qseek.utils import generate_docs
@@ -17,7 +19,9 @@ print(generate_docs(StationCorrections()))
 ## Source Specific Corrections
 
 ![Source specific corrections volume](../images/delay-volume.webp)
-*Delay volume for a selected stations.*
+/// caption
+Delay volume for a selected stations.
+///
 
 ```python exec='on'
 from qseek.utils import generate_docs

diff --git a/docs/components/station_metadata.md b/docs/components/station_metadata.md
@@ -1,13 +1,13 @@
-## Station Metadata
+# Station Metadata
 
-Meta data is required primarily for **station locations and codes**.
+Station metadata is required primarily for **station locations and codes**.
 
 Supported data formats are:
 
 * [x] [StationXML](https://www.fdsn.org/xml/station/)
 * [x] [Pyrocko Station YAML](https://pyrocko.org/docs/current/formats/yaml.html)
 
-Metadata does not need to include response information for pure detection and localisation. If local magnitudes M~L~ are extracted, response information is required.
+If local magnitudes M~L~ are extracted, response information as StationXML is required.
 
 ```python exec='on'
 from qseek.utils import generate_docs

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -8,6 +8,10 @@ The installation is straight-forward using pip or pipx.
 pip install git+https://github.com/pyrocko/qseek
 ```
 
+```sh title="From GitHub the Development Branch"
+pip install git+https://github.com/pyrocko/qseek@dev
+```
+
 or
 
 ```sh title="Using pipx"

diff --git a/docs/images/logo-subtitle.png b/docs/images/logo-subtitle.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# API Overview

		The following pages give an overview of the Python API.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Ray Tracers

		::: qseek.tracers.base.RayTracer