SCRUG-NA/2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[seiscomp, scanloc] Install, add .gitignore

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-09 15:07:02 +02:00
commit 20f5301bb1
2848 changed files with 1315858 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

658
etc/descriptions/scanloc.xml Normal file
View File

@ -0,0 +1,658 @@
<?xml version="1.0" encoding="UTF-8"?>
<seiscomp>
<module name="scanloc" category="Processing">
<description>
Module for locating local earthquakes and man-made seismicity by DBSCAN
cluster search.
</description>
<configuration>
<parameter name="defaultDepth" type="double" unit="km" default="0.0">
<description>
Default source depth used for locating origins. The range of
supported values depends on the configured
travel-time interface and locator.
When origin depth after locating is 0.0 or undefined, the depth
is corrected to &quot;defaultDepth&quot; without relocating
since the situation indicates issues.
Note: A similar parameter may require configuration for score
plugins.
</description>
</parameter>
<parameter name="ignoreDepth" type="double" unit="km" default="650.0">
<description>
Maximum depth of an origin to be sent.
Note: A similar parameter may require configuration for score
plugins.
</description>
</parameter>
<parameter name="use3D" type="boolean" default="false">
<description>
Compute distances in 3D for cluster search,
phase association and internal event association. Otherwise,
distances are measured from geographic coordinates ignoring elevation.
</description>
</parameter>
<parameter name="maxRMS" type="double" unit="s" default="1.5">
<description>
Maximum allowed overall residual of an origin to be sent.
</description>
</parameter>
<parameter name="minScore" type="double" default="0.0">
<description>
Minimum score of an origin to be sent.
</description>
</parameter>
<parameter name="score" type="string" default="OriginSum" values="OriginSum,OriginMultiFeature">
<description>
Defines the score processor to be used for ranking origins of
events. Additional configuration of the plugin and the plugin
parameters is required.
</description>
</parameter>
<parameter name="pickComparisonLevel" type="string" default="loc" values="sta,loc,cha">
<description>
The level up to which compare stream IDs of multiple picks in
order to avoid origins with multiple picks from identical stream
level, e.g., station (sta), sensor location (loc) or channel
(cha).
The level is derived from the NET.STA.LOC.CHA stream
representation. Picks with equal stream IDs on the given level
are treated as originating from the same stream no matter of the
ID on a lower level. Clusters having picks on streams equal on
the given level are split into new clusters with unique streams.
During association picks equal on the given level are ignored -
the first assigned pick is considered.
</description>
</parameter>
<group name="buffer">
<description>
Define buffering of picks and origins. scanloc only treats picks
and origins kept in the buffer.
</description>
<parameter name="pickKeep" type="double" unit="s" default="180.0">
<description>
Time to keep picks. Time comparison is based on the pick
times. In non-real time playbacks the time to keep picks is
usually compressed.
</description>
</parameter>
<parameter name="pickIgnoreStreamID" type="list:string">
<description>
Ignore picks created on given stream ID(s). Stream IDs may
contain wildcards. Separate multiple IDs by comma.
</description>
</parameter>
<parameter name="ignorePickTimeDifference" type="double" default="0.0" unit="s">
<description>
Generally, all available picks are added to the buffer and
made available for processing. Use this option to ignore new
picks made on the same data stream within the given time
difference to a previously buffered pick. A value of 0.0 s
ignores all picks with identical times.
</description>
</parameter>
<parameter name="originKeep" type="double" unit="s" default="180.0">
<description>
Time to keep origins. Time comparison is based on the origin
times. In non-real time playbacks the time to keep orgins is
usually compressed.
</description>
</parameter>
<parameter name="ignoreOrigins" type="boolean" default="false">
<description>
Ignore and do not buffer external origins received from
messaging or from XML files.
Default: Accept external origins from messaging or XML and
associate more phases.
</description>
</parameter>
<parameter name="ignoreManualOrigins" type="boolean" default="true">
<description>
Ignore and do not buffer manual external origins received
from messaging or from XML files.
The parameter &quot;buffer.ignoreOrigins&quot; must be
inactive for this option to be effective.
</description>
</parameter>
<parameter name="originStatusIgnore" type="list:string" default="" values="rejected,reported,preliminary,confirmed,reviewed,final">
<description>
Ignore an external origin if its status has any of the given
states. The option is ignored for manual origins if
buffer.ignoreManualOrigins = false.
</description>
</parameter>
<parameter name="authorWhiteList" type="list:string" default="">
<description>
Only buffer picks or origins from the given authors.
Separate multiple authors by comma. Picks and origins from
other authors will be ignored. Wildcards are supported.
This parameter overrides
&quot;buffer.originAuthorWhiteList&quot;. Manual origins are
treated regardless of the author as defined by
&quot;buffer.ignoreManualOrigins&quot;.
The parameter allows operation of scanloc based on picks and
origins from a specific module, e.g., in a pipeline.
</description>
</parameter>
<parameter name="originAuthorWhiteList" type="list:string" default="">
<description>
Deprecated parameter which will be removed in 2025. Use
&quot;buffer.authorWhiteList&quot; instead which overrides
this parameter!
Only buffer external origins from the given authors to the.
Separate multiple authors by comma. Manual origins
are treated regardless of the author as defined by
&quot;buffer.ignoreManualOrigins&quot;.
The parameter &quot;buffer.ignoreOrigins&quot; must be
inactive for this option to be effective.
</description>
</parameter>
<parameter name="futureTimeDelta" type="double" default="0.0" unit="s">
<description>
The time delta to the future. Positive values allow objects
with times in the future to be buffered when the difference
to current time or to creation time is not larger than the
given value.
Normally, objects like picks and origins are created after
their actual times and all other objects are spurious and
should be ignored. In case of wrong sensor timing or
faster-than-real-time waveform playbacks, objects may be
generated with actual times (pick time or origin time) in
the future.
If less or equal to 0.0, then all objects created before
time of the object or with object times in the future are
ignored.
</description>
</parameter>
</group>
<group name="clusterSearch">
<description>
Parameters controlling the cluster search based on phase
picks of configured phase type.
</description>
<parameter name="phaseType" type="string" default="P">
<description>
Phase type of considered picks. Valid types: P or Is.
</description>
</parameter>
<parameter name="minSize" type="int" default="4">
<description>
Minimum number of core points (picks) to form a cluster.
</description>
</parameter>
<parameter name="maxSize" type="int" default="-1">
<description>
Maximum number of picks in a cluster when stopping
clustering. Eventual clusters may still be larger from core
points. Using values &lt; 0 deactivates the feature.
The parameter is meant to support large-N networks where the
high network density results in very many clusters with high
computational load effectively slowing down the processing
of picks. Using reasonable values such as 10 or 15 will
reduce the number of clusters while maintaining high quality
initial origins.
</description>
</parameter>
<parameter name="maxPickDelay" type="double" default="-1.0" unit="s">
<description>
Maximum allowed difference between considered picks and cluster reference
time (latest pick time). Optimum values can be derived from
travel times.The cluster search ignores all
picks which exceed the value. Using "-1" enables all picks
regardless of the delay.
</description>
</parameter>
<parameter name="referenceTimeMode" type="string" default="LastPick" values="LastPick,MaxPickDelay">
<description>
Mode to set the cluster reference time. Read the documentation
for the details. Available modes:
LastPick: The pick time of the last incoming P pick is the
cluster reference time.
MaxPickDelay: Setting the cluster reference time is delayed
until clusterSearch.minSize and association.minPhase picks
are available.
</description>
</parameter>
<parameter name="regionFilter" type="list:double">
<description>
Cluster only picks which sensor locations are inside
the defined region. The region is defined by latitude,
longitude and a radius in km. By default the region filter
is disabled.
Example: 50.1,12.3,20
</description>
</parameter>
<parameter name="averageVelocity" type="double" unit="km/s" default="7.0">
<description>
Average velocity used for distance calculation.
</description>
</parameter>
<parameter name="maxSearchDist" type="double" unit="s" default="60">
<description>
Maximum allowed distance over all core points and
maximum allowed distance for neighborhood search. Both account
for travel-time difference, inter-station distance and the
configured averageVelocity.
</description>
</parameter>
<parameter name="maxOrigins" type="uint" default="128">
<description>
Maximum allowed origins derived from cluster search. Set this
option to zero to disable the cluster search completely.
</description>
</parameter>
<parameter name="preliminary" type="boolean" default="false">
<description>
Send origins based on cluster search as preliminary origins
if the location fails. Otherwise those origins are ignored.
Consider activating &quot;checkOrigins&quot;.
</description>
</parameter>
<parameter name="checkOrigins" type="boolean" default="false">
<description>
Check, if derived origins fulfill the cluster search criteria
anymore. Activating this option may lower the number of events
and suppress fake events.
</description>
</parameter>
</group>
<group name="association">
<description>
Parameters controlling the association of P and S phases to cluster
origins or external origins.
</description>
<parameter name="minPhase" type="int" default="4">
<description>
Number picks in cluster origin to be reached for starting to
associate more P and S picks.
</description>
</parameter>
<parameter name="maxDist" type="double" unit="km" default="1000.0">
<description>
Maximum distance from origin to stations
for associating P and S picks.
</description>
</parameter>
<parameter name="stationConfig" type="file" options="read">
<description>
The station configuration file contains lines consisting of
network code, station code, weight (0 or 1) and maximum
association distance given in degree. The maximum association
distance is the distance in degrees from the origin up to
which this station may contribute to a new origin. This
parameter overrides the global parameter
&quot;association.maxDist&quot;.
If this distance is 180 deg, this station may contribute to
new origins world-wide. However, if the distance is only 10
degree, the range of this station is limited. This is a helpful
setting in case of mediocre stations in a region where there
are numerous good and reliable stations nearby. The station
will then not pose a risk for locations generated
outside the maximum association distance. The last item found
in the list overrules previous ones.
Network and station codes may be wildcards (*) for
convenience. Example:
* * 1 10
GE * 1 180
</description>
</parameter>
<parameter name="maxPResidual" type="double" unit="s" default="4.0">
<description>
Maximum allowed difference between measured and predicted arrival
times for associating P phases to origin.
Larger values allow significant correction of initial locations.
</description>
</parameter>
<parameter name="dropReferenceCheck" type="boolean" default="false">
<description>
Allow S-type picks without checking for a reference pick.
References to P picks are typically added to S picks by
scautopick but picks from other modules may not have this
feature. When this option is active, the reference pick is
not tested at all. Manual picks are always considered
without a reference check.
</description>
</parameter>
<parameter name="maxSResidual" type="double" unit="s" default="4.0">
<description>
Maximum allowed difference between measured and predicted arrival
time for associating S phases to origins. Larger values allow
significant correction of initial locations.
</description>
</parameter>
<parameter name="maxResidual" type="double" unit="s" default="2.0">
<description>
Maximum allowed time residuals of picks after association and
relocation. Picks will be removed at exceedence starting with
largest residual and origins will be relocated.
</description>
</parameter>
<parameter name="arrivalCountMinRes" type="int" unit="" default="-1">
<description>
The number of arrivals of an origin for controlling the
association of more picks. Beyond this number, the minimum
of maxPResidual or maxSResidual and maxResidual for
associating P or S phases, respectively, is tested before
association.
The parameter also speeds up the evaluation of origins with
more arrivals than configured: Instead of
testing residuals of arrivals individually and relocating
thereafter, all arrivals not passing the residual check are
removed in a bulk.
The parameter is meant to support large-N networks where the
high network density results in very many picks and high
computational load, effectively slowing down the quality
check of picks. Setting a reasonable value, e.g., >20 will
only associate the best picks to origins already well
constraint.
Using values &lt;= 0 deactivates the feature.
</description>
</parameter>
<parameter name="tableType" type="string" default="LOCSAT" values="LOCSAT,libtau,homogeneous">
<description>
Type of travel-time tables for phase association.
May be different from locator.
</description>
</parameter>
<parameter name="table" type="string" default="iasp91" values="iasp91,iasp91_scanloc">
<description>
Name of travel-time table used for phase association.
May be different from locator profile. Using a different
table/profile may result in increased runtime.
</description>
</parameter>
<parameter name="zeroWeightProfiles" type="list:string">
<description>
zeroWeight-profile name for associating the configured phases
with zero weight to origins. Multiples profile names may be set
separated by comma. The order of names determines order of
checked phases. Each profile can have different parameters.
</description>
</parameter>
<group name="zeroWeight">
<description>
Zero-weight profiles containing the parameters for associating
phases with zero weight to origins.
</description>
<struct type="zeroWeight profile" link = "zeroWeight.profiles">
<parameter name="phaseType" type="String">
<description>
One phase type to be associated with zero weight.
Examples: PKP or Pdiff.
</description>
</parameter>
<parameter name="minDistance" type="double" default="120.0" unit="degree">
<description>
Minimum distance from origin to stations.
</description>
</parameter>
<parameter name="maxResidual" type="double" default="5.0" unit="s">
<description>
Maximum time residual of the associated phase.
</description>
</parameter>
</struct>
</group>
</group>
<group name="locator">
<description>
Parameters controlling the locator for locating scanloc
origins.
</description>
<parameter name="type" type="string" default="LOCSAT" values="External,FixedHypocenter,Hypo71,iLoc,LOCSAT,NonLinLoc,Router,StdLoc">
<description>
The locator type to be used.
</description>
</parameter>
<parameter name="profile" type="string" default="iasp91" values="iasp91,iasp91_scanloc">
<description>
The locator profile to be used. Using a different profile/table
for locating and associating may result in increased runtime.
</description>
</parameter>
<parameter name="fixDepth" type="boolean" default="false">
<description>
If enabled, the locator fixes the depth to the configured
default value &quot;defaultDepth&quot; in case that all
previous attempts to relocate fail.
This option may result in many more origins. It
prevents &quot;ignoreDepth&quot; from beeing
effective if &quot;defaultDepth&quot; &lt; &quot;ignoreDepth&quot;.
</description>
</parameter>
<parameter name="forceFixDepth" type="boolean" default="false">
<description>
If enabled, the locator is forced to fix the depth to the
value configured by &quot;defaultDepth&quot;. Free-depth
solutions are thus excluded. Activating this option may be
useful for sources with known depths or in case of sparse
networks.
</description>
</parameter>
</group>
<group name="eventAssociation">
<description>
Parameters controlling the association of interval scanloc
origins to internal scanloc events.
</description>
<parameter name="compareAllArrivalTimes" type="boolean" default="false">
<description>
This parameter is only used in conjunction with
&quot;eventAssociation.maximumMatchingArrivalTimeDiff&quot;.
If a station has multiple associated arrivals for a
particular event, this flag defines if the time distance
of a new pick to all arrivals must be within
&quot;eventAssociation.maximumMatchingArrivalTimeDiff&quot;
or if one matching arrival is enough.
</description>
</parameter>
<parameter name="minMatchingArrivals" type="int" default="3">
<description>
Minimum number of matching picks between two origins to be
associated to the same event.
</description>
</parameter>
<parameter name="maxMatchingArrivalTimeDiff" type="double" unit="s" default="-1">
<description>
If this time window in seconds is negative, pickIDs
are compared to find matching arrivals. A non negative
value (including 0) compares pick times regardless
of the pickID. Pass: |pick1.time - pick2.time| &lt;= threshold.
</description>
</parameter>
<parameter name="maxDist" type="double" unit="km" default="500.0">
<description>
Allowed difference in epicenter between an incoming origin
compared with preferred origins to get associated.
</description>
</parameter>
<parameter name="maxTimeSpan" type="double" unit="s" default="60.0">
<description>
Associates an origin with an existing event if the origin
time differs not more than 60 seconds unless the
minimumMatchingArrivals criteria matches.
</description>
</parameter>
</group>
<group name="publication">
<description>
Parameters controlling the publication delay of origin for
internal events to the messaging system. The delay
time, t, is calculated as t = a x N + b where N is the number
of arrivals of the origin. After t seconds, the best origin
is published. The first origin is always published.
</description>
<parameter name="intervalTimeSlope" type="double" unit="s/count" default="0.5">
<description>
Parameter &quot;a&quot; in the equation t = a x N + b.
Increasing the value reduces the amount of sent origins.
With the option --ep (playback mode) this value is set to 0.
</description>
</parameter>
<parameter name="intervalTimeIntercept" type="double" unit="s" default="0.0">
<description>
Parameter &quot;b&quot; in the equation t = a x N + b.
Increasing the value reduces the amount of sent origins.
With the option --ep (playback mode) this value is set to 0.
</description>
</parameter>
<parameter name="wakeUpInterval" type="int" unit="s" default="5">
<description>
Integer interval to check the origin buffer for sending
origins if no other origins have been created.
Reducing the value may be required in EEW: it increases the
load on scanloc but allows to send origins more rapidly.
</description>
</parameter>
</group>
</configuration>
<command-line>
<synopsis>
scanloc [options]
</synopsis>
<group name="Generic">
<optionReference>generic#help</optionReference>
<optionReference>generic#version</optionReference>
<optionReference>generic#config-file</optionReference>
<optionReference>generic#plugins</optionReference>
<optionReference>generic#daemon</optionReference>
</group>
<group name="Verbosity">
<optionReference>verbosity#verbosity</optionReference>
<optionReference>verbosity#v</optionReference>
<optionReference>verbosity#quiet</optionReference>
<optionReference>verbosity#print-component</optionReference>
<optionReference>verbosity#print-context</optionReference>
<optionReference>verbosity#component</optionReference>
<optionReference>verbosity#syslog</optionReference>
<optionReference>verbosity#lockfile</optionReference>
<optionReference>verbosity#console</optionReference>
<optionReference>verbosity#debug</optionReference>
<optionReference>verbosity#trace</optionReference>
<optionReference>verbosity#log-file</optionReference>
</group>
<group name="Messaging">
<optionReference>messaging#user</optionReference>
<optionReference>messaging#host</optionReference>
<optionReference>messaging#timeout</optionReference>
<optionReference>messaging#primary-group</optionReference>
<optionReference>messaging#subscribe-group</optionReference>
<optionReference>messaging#encoding</optionReference>
<optionReference>messaging#start-stop-msg</optionReference>
</group>
<group name="Database">
<optionReference>database#db-driver-list</optionReference>
<optionReference>database#database</optionReference>
<optionReference>database#config-module</optionReference>
<optionReference>database#inventory-db</optionReference>
<option flag="" long-flag="db-disable" argument="" publicID="database#db-disable">
<description>Do not use the database at all.</description>
</option>
</group>
<group name="Input">
<option flag="" long-flag="ep" argument="arg" type="string">
<description>
Name of input XML file (SCML) with all picks and origins
for offline processing. The database connection is not
received from messaging and must be provided. Results
are sent as XML to stdout.
</description>
</option>
<option flag="" long-flag="timing" argument="arg" default="pickTime" values="creationTime,pickTime">
<description>
Timing reference in offline processing with --ep: Use
pickTime and creationTime for sorting picks according to
pick time and creation time, respectively. pickTime is
assumed if no timing is specified. Note: In real-time
processing picks are treated as they arrive corresponding to
creationTime and this option is irrelevant.
</description>
</option>
</group>
<group name="Buffer">
<option flag="" long-flag="allow-rejected-picks">
<description>
Allow processing of picks with evaluation status 'rejected'.
Otherwise these picks are ignored and not buffered.
</description>
</option>
<option flag="" long-flag="drop-reference-check" param-ref="association.dropReferenceCheck"/>
<option flag="" long-flag="author-whitelist" argument="arg" type="list:string">
<description>
Only consider picks and origins created by the given
author(s). Separate multiple authors by
comma. Wildcards are supported.Empty strings
allow all authors. Manual origins are treated regardless of
the author as defined by
&quot;buffer.ignoreManualOrigins&quot;. The option allows
operating scanloc based on picks and origins from a specific
module, e.g., in a pipeline.
</description>
</option>
<option flag="" long-flag="future-time-delta" argument="arg" param-ref="buffer.futureTimeDelta"/>
<option flag="" long-flag="origin-keep" argument="arg" param-ref="buffer.originKeep"/>
<option flag="" long-flag="pick-keep" argument="arg" param-ref="buffer.pickKeep"/>
</group>
<group name="Locator">
<option long-flag="locator-type" argument="arg" param-ref="locator.type"/>
<option long-flag="locator-profile" argument="arg" param-ref="locator.profile" type="string"/>
<option long-flag="locator-list">
<description>
List all registered locators.
</description>
</option>
</group>
<group name="Output">
<option flag="" long-flag="final-only">
<description>
Limit result set to final origins only. This option is
available for non-real-time (--ep) processing only.
</description>
</option>
<option long-flag="dump-origins">
<description>
Don't publish origins, write them to stdout. Useful for
tuning.
</description>
</option>
<option long-flag="cluster-search-log-file" argument="arg" type="string">
<description>
File name to output detailed cluster search information.
Useful for tuning.
</description>
</option>
<option flag="f" long-flag="formatted">
<description>
Use formatted XML output along with '--ep'. Otherwise XML
is unformatted.
</description>
</option>
</group>
</command-line>
</module>
</seiscomp>