.. highlight:: rst .. _catalyst: ######## catalyst ######## **Event-parametric catalogue evaluation GUI** Description =========== |appname| is an interactive catalogue-building, review, relocation and quality-control tool for seismic and infrasound events. |appname| loads picks and origins from the database or from a |scname| XML file, nucleates events (DBSCAN, back projection, GaMMA-lite or the scautoloc grid search), associates and relocates them, applies configurable quality-control rules to separate real events from false detections, and can derive automatic-processing parameters, for example a :program:`scanloc` configuration, from the hand-curated result. Most interactive settings - clustering, association, relocation, QC rules, aggregation - are handled in the GUI and stored in named :ref:`processing profiles `, not in the module configuration. The parameters below configure only the application-level behaviour that is not part of a profile. See the :ref:`introduction ` for an overview and the :ref:`typical workflow ` for a walk-through. Module Configuration ==================== | :file:`etc/defaults/global.cfg` | :file:`etc/defaults/catalyst.cfg` | :file:`etc/global.cfg` | :file:`etc/catalyst.cfg` | :file:`~/.seiscomp/global.cfg` | :file:`~/.seiscomp/catalyst.cfg` catalyst inherits :ref:`global options`. .. note:: Modules/plugins may require a license file. The default path to license files is :file:`@DATADIR@/licenses/` which can be overridden by global configuration of the parameter :confval:`gempa.licensePath`. Example: :: gempa.licensePath = @CONFIGDIR@/licenses .. confval:: maxOrigins Default: ``1000`` Type: *int* Hard cap on the number of origins a single nucleation run may create. This is a runaway guard, not a tuning parameter: if a clustering bug or a pathological parameter set starts producing origins without end, this stops it. Nucleation logs a warning when the cap bites, so a truncated run is never silent. Set to 0 to disable the cap \(no limit\). Not exposed in the GUI on purpose. .. confval:: minPhases Default: ``5`` Type: *int* Minimum number of phases an origin must have to be kept by the nucleation \/ smart\-locate pipeline. Values below 4 are clamped to 4, since fewer than four observations cannot constrain a hypocentre and origin time. .. confval:: faultPointBudget Default: ``500000`` Type: *int* Maximum number of vertices rendered for fault meshes in the 3D view. A budget guard for large fault models: when a loaded mesh exceeds it, the geometry is decimated so the 3D scene stays interactive. Only affects display, not any computation. .. confval:: demPath Type: *directory* Directory holding the digital elevation model \(GeoTIFF\) tiles used to draw terrain and coastlines in the 3D hypocentre view. If unset or empty, the 3D view falls back to a flat base and the terrain layer is disabled. .. confval:: cities Type: *list:string* Names of reference cities to mark on the 3D hypocentre view \(a plain list, e.g. Reykjavik, Grindavik, Husavik\). Each name is looked up by name in the cities XML \(see citiesFile\) for its coordinates; names not found are skipped with a log warning. Leave empty to show none. .. confval:: citiesFile Default: ``@DATADIR@/cities.xml`` Type: *file* SeisComP cities XML used to resolve the names listed in \"cities\" to coordinates. Defaults to the standard \@DATADIR\@\/cities.xml that ships with SeisComP. .. confval:: profiles Type: *list:string* Names of the processing profiles offered in the \"Profile\" dropdown at the top of the Catalyst window. A profile captures the full set of interactive CLUSTERING and REFINE settings \(nucleation method and parameters, locator, QC rules, preference lists, aggregation, database window, ...\). Each name listed here must have a matching profile.\$name.configFile. .. confval:: defaultProfile Type: *string* Name of the profile applied at start\-up, so the profile the dropdown shows is the one actually in effect. Must be one of the names in \"profiles\"; if unset or unknown, the first configured profile is used. .. _profile: .. _profile.$name: .. note:: **profile.$name.\*** $name is a placeholder for the name to be used and needs to be added to :confval:`profiles` to become active. .. code-block:: sh profiles = a,b profile.a.value1 = ... profile.b.value1 = ... # c is not active because it has not been added # to the list of profiles profile.c.value1 = ... .. confval:: profile.$name.configFile Type: *file* Path to the .profile settings file for this profile \(key \= value pairs written and read by Catalyst\). SeisComP path placeholders such as \@SYSTEMCONFIGDIR\@, \@CONFIGDIR\@, \@DATADIR\@ and \@ROOTDIR\@ are resolved at runtime. .. _ttt: .. _ttt.$name: .. note:: **ttt.$name.\*** $name is a placeholder for the name to be used. .. confval:: ttt.$name.tables Type: *list:string* Travel\-time table models offered for this travel\-time interface \(the struct name is the interface name, e.g. LOCSAT or libtau\). The listed models populate the model dropdown when this interface is selected; if the key is absent, Catalyst falls back to the interface's built\-in models. Separate model names by comma. Command-Line Options ==================== :program:`catalyst [options] [SCML file]` .. _Generic: Generic ------- .. option:: -h, --help Show help message. .. option:: -V, --version Show version information. .. option:: --config-file file The alternative module configuration file. When this option is used, the module configuration is only read from the given file and no other configuration stage is considered. Therefore, all configuration including the definition of plugins must be contained in that file or given along with other command\-line options such as \-\-plugins. .. option:: --plugins arg Load given plugins. .. _Verbosity: Verbosity --------- .. option:: --verbosity arg Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug. .. option:: -v, --v Increase verbosity level \(may be repeated, e.g., \-vv\). .. option:: -q, --quiet Quiet mode: no logging output. .. option:: --component arg Limit the logging to a certain component. This option can be given more than once. .. option:: -s, --syslog Use syslog logging backend. The output usually goes to \/var\/lib\/messages. .. option:: -l, --lockfile arg Path to lock file. .. option:: --console arg Send log output to stdout. .. option:: --debug Execute in debug mode. Equivalent to \-\-verbosity\=4 \-\-console\=1 . .. option:: --trace Execute in trace mode. Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1 \-\-print\-context\=1 . .. option:: --log-file arg Use alternative log file. .. _Messaging: Messaging --------- .. option:: -u, --user arg Overrides configuration parameter :confval:`connection.username`. .. option:: -H, --host arg Overrides configuration parameter :confval:`connection.server`. .. option:: -t, --timeout arg Overrides configuration parameter :confval:`connection.timeout`. .. option:: -g, --primary-group arg Overrides configuration parameter :confval:`connection.primaryGroup`. .. option:: -S, --subscribe-group arg A group to subscribe to. This option can be given more than once. .. option:: --offline Do not connect to the messaging bus. A database given with \-d is still used \(e.g. for inventory\); only the live bus is disabled, so send\-to\-scolv and review\-in\-scolv are unavailable. Mirrors scolv's offline mode. .. _Database: Database -------- .. option:: --db-driver-list List all supported database drivers. .. option:: -d, --database arg The database connection string, format: service:\/\/user:pwd\@host\/database. \"service\" is the name of the database driver which can be queried with \"\-\-db\-driver\-list\". .. option:: --config-module arg The config module to use. .. option:: --inventory-db arg Load the inventory from the given database or file, format: [service:\/\/]location . .. _Input: Input ----- .. option:: -i, --input arg Type: *string* SeisComP XML \(SCML\) file to open on start\-up. The file's picks and origins are loaded into the working set. A single positional argument \(a file path with no flag\) is accepted as an equivalent to \-i.