Browse Source

docs: improvements

whitelist
miili 2 years ago
parent
commit
0348d02732
3 changed files with 12 additions and 8 deletions
  1. +8
    -8
      docs/source/config/dataset/dataset.gronf
  2. +2
    -0
      docs/source/config/problems/index.rst
  3. +2
    -0
      docs/source/config/targets/index.rst

+ 8
- 8
docs/source/config/dataset/dataset.gronf View File

@ -12,13 +12,19 @@ dataset_config: !grond.DatasetConfig
# Optional prefix for all paths in this config file
path_prefix: .
# File with hypocenter information and possibly reference solution
events_path: 'data/events/${event_name}/event.txt'
# List of files with station coordinates.
stations_stationxml_paths:
- 'data/events/${event_name}/waveforms/stations.geofon.xml'
- 'data/events/${event_name}/waveforms/stations.iris.xml'
# File with hypocenter information and possibly reference solution
events_path: 'data/events/${event_name}/event.txt'
# List of files with instrument response information (can be the same as in
# stations_stationxml_paths above)
responses_stationxml_paths:
- 'data/events/${event_name}/waveforms/stations.geofon.xml'
- 'data/events/${event_name}/waveforms/stations.iris.xml'
# List of directories with raw waveform data
waveform_paths: ['data/events/${event_name}/waveforms/raw']
@ -31,9 +37,3 @@ dataset_config: !grond.DatasetConfig
# format as above)
blacklist_paths:
- 'data/events/${event_name}/waveforms/blacklist.txt'
# List of files with instrument response information (can be the same as in
# stations_stationxml_paths above)
responses_stationxml_paths:
- 'data/events/${event_name}/waveforms/stations.geofon.xml'
- 'data/events/${event_name}/waveforms/stations.iris.xml'

+ 2
- 0
docs/source/config/problems/index.rst View File

@ -250,6 +250,8 @@ particularly for the ``DoubleDCProblem``.
strike: '80 .. 330'
dip: '0 .. 60'
rake: '60 .. 90'
# Dynamic constraints, not needed for static inversion
time: '-15. .. 10. | add'
nucleation_x: '-1. .. 1.'
nucleation_y: '-1. .. 1.'


+ 2
- 0
docs/source/config/targets/index.rst View File

@ -44,6 +44,8 @@ Parameters valid for all types of ``MisfitTargets`` are:
Waveform targets
----------------
See the :doc:`dataset configuration <../dataset/index>` for loading waveforms and response information.
.. code-block :: yaml
:caption: Example ``WaveformTarget`` configuration


Loading…
Cancel
Save