Configuration

Before DUGSeis can be used, the setup of any given project must be configured. It can be passed to the DUGSeisProject class either as a dictionary or as a YAML file.

This, additionally, is the configuration file passed to the graphical interface.

Here is an annotated example YAML file that explains the available options:

# File format version number.
version: 14

# Meta information. Does not influence any functionality.
meta:
  project_name: Grimsel_dummy
  project_location: Grimsel
  project_description: Grimsel_dummy

# Define the internal Cartesian DUGSeis coordinate system.
local_coordinate_system:
  # EPSG code of the local coordinate system. Here the CH1903 Swiss system.
  epsg_code: 21781
  # Translation vector to convert local coordinates to the coordinate system
  # specified by the EPSG code. Thus the internal local coordinate system is a
  # translated system.
  translation_vector: [579300.0, 247500.0, 500.0]

# Where things are on disc.
paths:
  # A list of folders with the waveform files as ASDF files. Can be one or more.
  asdf_folders:
    - 'C:\Users\lionk\Downloads\DUGSeis\DUGSeis\01_dummy_Grimsel\01_ASDF_data'
  # Folders with the corresponding StationXML files. Can be one or more.
  stationxml_folders:
    - 'C:\Users\lionk\Downloads\DUGSeis\DUGSeis\01_dummy_Grimsel\StationXML'
  # Path to the SQLite database storing all event information.
  database: 'sqlite://C:\Users\lionk\Downloads\DUGSeis\DUGSeis\01_dummy_Grimsel\db2.sqlite'
  # Cache folder - can be safely deletes but might be expensive to recompute.
  cache_folder: 'C:\Users\lionk\Downloads\DUGSeis\DUGSeis\01_dummy_Grimsel\cache'

# Temporal range of the experiment. All parts of DUGSeis will only use data in
# that range.
temporal_range:
  start_time: 2017-02-09T13:22:00.000Z
  end_time: 2017-02-09T13:52:00.000Z

# Settings affecting the graphical interface.
graphical_interface:
  # Available options for manual event classifications.
  classifications:
    - passive
    - active
    - electronic
    - unknown
    - random
  # Available manual phases for picks.
  pick_types:
    - P
    - S
  # List of available uncertainties in the graphical picker.
  uncertainties_in_ms:
    - 0.00001
    - 0.000025
    - 0.00005
  # Optional: Number of channels the "Show closest channels" button shows.
  number_of_closest_channels: 4
  # Optional: Color for the scatter plot that shows all picks.
  color_all_picks: [0.8, 1.0, 0.0, 0.9]
  # Optional: Settings for the 3-D receiver/event view.
  # All colors are RGBA with ranges from 0 to 1.
  # (R=red, G=green, B=blue, A=alpha)
  3d_view:
    # Hide the coordinates for the triggering channel.
    hide_channels:
      - GRM.001.001.001
    # Optionally plot some line segments. Useful to show certain features
    # like boreholes in the 3-D plot. Coordinates are in the coordinate system
    # defined above.
    line_segments:
      - [[0.0, 0.0, 0.0], [100.0, 0.0, 0.0], [100.0, 100.0, 0.0], [400.0, 400.0, 400.0]]
      - [[200.0, 0.0, 200.0], [200.0, 100.0, 200.0], [200.0, 100.0, 0.0]]
    # Width and color of the line segments.
    line_segments_width: 4.0
    line_segments_color: [0.0, 0.0, 1.0, 1.0]
    # Size and color of channels and events in the 3-D view.
    size_channels_in_pixel: 10
    color_channels: [1.0, 1.0, 1.0, 0.5]
    size_events_in_pixel: 3
    color_events: [0.204, 0.922, 0.776, 0.5]
    size_active_event_in_pixel: 25
    color_active_event: [1.0, 0.0, 0.0, 1.0]
    size_active_channels_in_pixel: 15
    color_active_channels: [0.0, 1.0, 0.0, 1.0]
  # Optional: Default arguments for the location algorithm used in the
  # relocation part of the graphical interface.
  location_algorithm_default_args:
    velocity: 
      P: 4866.0
      S: 3500.0
    damping: 0.01
    use_anisotropy: true
    anisotropy_parameters:
      P:
        azi: 310.0
        inc: 28.6
        delta: 0.071
        epsilon: 0.067
      S:
        azi: 311.0
        inc: 29.6
        delta: 0.081
        epsilon: 0.077

# Available filters - either in the GUI or for any automatic picking
# algorithms. The filter will be applied and the corresponding processing
# id will be stored alongside the picks.
filters:
  # Best use descriptive id.
  - filter_id: smi:local/bandpass_causal_1000_5000
    filter_settings:
      filter_type: butterworth_bandpass
      highpass_frequency_in_hz: 1000.0
      lowpass_frequency_in_hz: 5000.0
      filter_corners: 4
      zerophase: false
  - filter_id: smi:local/bandpass_acausal_1000_5000
    filter_settings:
      filter_type: butterworth_bandpass
      highpass_frequency_in_hz: 1000.0
      lowpass_frequency_in_hz: 5000.0
      filter_corners: 2
      zerophase: true
  # Example for a high-pass filter.
  - filter_id: smi:local/highpass_acausal_2000
    filter_settings:
      filter_type: butterworth_highpass
      frequency_in_hz: 2000.0
      filter_corners: 4
      zerophase: true
  # Example for a low-pass filter.
  - filter_id: smi:local/lowpass_acausal_500
    filter_settings:
      filter_type: butterworth_lowpass
      frequency_in_hz: 500.0
      filter_corners: 4
      zerophase: true