improvements docs/examples

docs/source/config/dataset/index.rst

@@ -34,7 +34,8 @@ Usually raw, unrestituted waveforms are loaded into Grond, together with Station
         List of directories with raw waveform data.
 
     ``stations_stationxml_paths``
-        List of files with station coordinates in StationXML format.
+        List of files with station coordinates in `StationXML <https://www.fdsn.org/xml/station/>`_ format.
+        Inventory datasets have to be converted to StationXML. Use ObsPy's ``Inventory`` for conversion: ``inventory.write('out-stationxml.xml', format='stationxml')``.
 
     ``stations_path``
         List of files with station coordinates in Pyrocko format.
@@ -49,7 +50,7 @@ Usually raw, unrestituted waveforms are loaded into Grond, together with Station
         List of StationXML response files for restitution of the raw waveform data.
 
     ``responses_sacpz_path``
-        List of SACPZ response files for restitution of the raw waveform data.
+        Path to SACPZ response files for restitution of the raw waveform data.
 
     ``station_corrections_path``
         File containing station correction informations. See :download:`example station corrections <station_corrections.yaml>`.
@@ -70,7 +71,7 @@ Usually raw, unrestituted waveforms are loaded into Grond, together with Station
         List of text files with blacklisted stations in NSLC pattern.
 
     ``whitelist``
-        List of stations/components to be **included** according to their STA, NET.STA, NET.STA.LOC, or NET.STA.LOC.CHA codes
+        List of stations/components to be **included** according to their ``STA``, ``NET.STA``, ``NET.STA.LOC``, or ``NET.STA.LOC.CHA`` codes
 
         Note: when whitelisting on channel level, both, the raw and the processed channel codes have to be listed.
 

src/data/examples/example_regional_cmt/config/regional_cmt.gronf

@@ -29,6 +29,8 @@ rundir_template: 'runs/${problem_name}.grun'
 # -----------------------------------------------------------------------------
 
 dataset_config: !grond.DatasetConfig
+  # More information on the data configuration at
+  # https://pyrocko.org/grond/docs/current/config/dataset/index.html
 
   # List of files with station coordinates.
   stations_stationxml_paths: 
@@ -56,6 +58,11 @@ dataset_config: !grond.DatasetConfig
   - 'data/events/${event_name}/waveforms/stations.geofon.xml'
   - 'data/events/${event_name}/waveforms/stations.iris.xml'
 
+  # Apply correction factors from station corrections.
+  apply_correction_factors: true
+
+  # Extend incomplete seismic traces
+  extend_incomplete: false
 
 # -----------------------------------------------------------------------------
 # Configuration section for the observational data fitting
@@ -111,7 +118,14 @@ target_groups:
     # How to fit the data (available: 'time_domain', 'frequency_domain',
     # 'log_frequency_domain', 'absolute', 'envelope', 'cc_max_norm')
     domain: 'time_domain'
+
+    # If non-zero, allow synthetic and observed traces to be shifted
+    # against each other by up to +/- the given value [s].
     tautoshift_max: 4.0
+
+    # If non-zero, a penalty misfit is added for non-zero shift values.
+    # The penalty value is computed as
+    # autoshift_penalty_max * normalization_factor * tautoshift**2 / tautoshift_max**2
     autoshift_penalty_max: 0.05
     
     # For L1 norm: 1, L2 norm: 2, etc.
@@ -172,7 +186,14 @@ target_groups:
     # How to fit the data (available: 'time_domain', 'frequency_domain',
     # 'log_frequency_domain', 'absolute', 'envelope', 'cc_max_norm')
     domain: 'time_domain'
+
+    # If non-zero, allow synthetic and observed traces to be shifted
+    # against each other by up to +/- the given value [s].
     tautoshift_max: 4.0
+
+    # If non-zero, a penalty misfit is added for non-zero shift values.
+    # The penalty value is computed as
+    # autoshift_penalty_max * normalization_factor * tautoshift**2 / tautoshift_max**2
     autoshift_penalty_max: 0.05
     
     # For L1 norm: 1, L2 norm: 2, etc.