[installation] Change to nightly

This commit is contained in:
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions

View File

@ -6,8 +6,8 @@
scevent
#######
**Associates an Origin to an Event or forms a new Event if no match is found.
Selects the preferred origin, magnitude and focal mechanism.**
**Associate an Origin to an Event or form a new Event if no match is found.
Select the preferred origin, magnitude and focal mechanism.**
Description
@ -307,6 +307,46 @@ The following actions are supported by scevent:
:param parameters: The event type certainty
.. _scevent-restapi:
REST API
========
:program:`scevent` provides a HTTP REST API which may be enabled by defining a
bind address under :confval:`restAPI`. The following enpoints are available
.. _scevent-restapi-associate:
try-to-associate
----------------
Allows to query for possible event associations of origin candidates. An event
ID is returned if a matching event is found. No event is ever created.
================== =========================
**Location** `/api/1/try-to-associate`
**HTTP Methods** POST
**Request data** :term:`SCML` containing an :ref:`EventParameters <api-python-datamodel-eventparameters>` element with one and only one :ref:`Origin <api-python-datamodel-origin>`
**Request header** `ContentType: text/xml` (no subtype allowed)
**Response data** EventID string
**Response code** **200** (matching event found), **204** (no matching event found), **400** (invalid input)
================== =========================
The following example demonstrates how to query the event id for an origin
defined in :file:`origin.xml` using the command line programm :program:`curl`.
The request header `Content-Type` must be specified and must have a value of
`text/xml`. No subtype is allowed. It is assumed that :program:`scevent` is
configured with `restAPI = 18182`.
.. code-block:: sh
curl -v -X POST http://localhost:18182/api/1/try-to-associate -H "Content-Type: text/xml" -d @origin.xml
Plugins
=======
@ -370,13 +410,14 @@ scevent inherits :ref:`global options<global-configuration>`.
Default: ``-1``
Type: *integer*
Type: *int*
Configures the number of event ID slots to look back and
forth when an event ID is already taken. The default in
previous versions was 5. Now \-1 means that the margin is
determined automatically based on \"eventAssociation.eventTimeBefore\"
and \"eventAssociation.eventTimeAfter\". According to the
determined automatically based on
\"eventAssociation.eventTimeBefore\" and
\"eventAssociation.eventTimeAfter\". According to the
configured \"eventIDPattern\" a fixed time range per slot
can be computed and with that width the number of look
ahead slots and look back slots can be computed based on
@ -398,8 +439,9 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *string*
Defines the bind adress of the REST API endpoint. This API
allows to query for possible event associations of origin
Defines the bind address of the REST API of form [address:]port.
This API currently provides one endpoint, \/api\/1\/try\-to\-associate,
which allows to query for possible event associations of origin
candidates.
@ -428,8 +470,9 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *int*
Minimum number of Picks for an Origin that is automatic and cannot be
associated with an Event to be allowed to form an new Event.
Minimum number of Picks for an Origin that is automatic
and cannot be associated with an Event to be allowed to
form an new Event.
.. confval:: eventAssociation.minimumScore
@ -464,8 +507,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Unit: *s*
Time range before the Origin time of an incoming Origin to search for
matching events.
Time range before the Origin time of an incoming Origin to
search for matching events.
.. confval:: eventAssociation.eventTimeAfter
@ -476,8 +519,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Unit: *s*
Time range after the Origin time of an incoming Origin to search for
matching events.
Time range after the Origin time of an incoming Origin to
search for matching events.
.. confval:: eventAssociation.minimumMatchingArrivals
@ -486,8 +529,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *int*
Minimum number of matching picks between two Origins to be associated
to the same event.
Minimum number of matching picks between two Origins to be
associated to the same event.
.. confval:: eventAssociation.maximumMatchingArrivalTimeDiff
@ -511,11 +554,11 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *boolean*
This parameter is only used in conjunction with
eventAssociation.maximumMatchingArrivalTimeDiff.
\"eventAssociation.maximumMatchingArrivalTimeDiff\".
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
eventAssociation.maximumMatchingArrivalTimeDiff
\"eventAssociation.maximumMatchingArrivalTimeDiff\"
or if one matching arrival is enough.
@ -536,9 +579,9 @@ scevent inherits :ref:`global options<global-configuration>`.
Unit: *s*
Associates an Origin with an existing event if the Origin
time differs not more than 60 seconds unless the
minimumMatchingArrivals criteria matches.
Associates an Origin with an existing event if the Origin
time differs not more than 60 seconds unless
\"eventAssociation.minimumMatchingArrivals\" matches.
.. confval:: eventAssociation.maximumDistance
@ -549,8 +592,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Unit: *degrees*
Allowed location difference between an incoming Origin compared with
preferred Origins to get associated.
Allowed location difference between an incoming Origin
compared with preferred Origins to get associated.
.. confval:: eventAssociation.magTypes
@ -559,22 +602,29 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *list:string*
Magnitude type priority list for becoming a preferred magnitude for an
event.
List of magnitude types considered for computing priorities
in order to declare the preferred magnitude of an event.
Magnitudes not listed have a priority of 0 and are ranked
by station count only.
Magnitudes must meet
\"eventAssociation.minimumMagnitudes\" and
\"eventAssociation.minMwCount\" unless
\"eventAssociation.enableFallbackMagnitude\" is true.
If listed, Mw\-\/Mw\(\)\-type magnitudes are preferred over all
others. Next, the magnitude type with the largest station
count wins \(default\) unless
\"eventAssociation.magPriorityOverStationCount\" is
true. If the station count is equal, priority is highest
for the magnitude earliest in the list.
If \"eventAssociation.magPriorityOverStationCount\" is
true, highest priority is first given to magnitude types
earliest in the list before testing the station count.
Example:
M, mBc, Mw\(mB\), Mwp, ML, MLh, MLv, mb
.. confval:: eventAssociation.enableFallbackMagnitude
Default: ``false``
Type: *boolean*
If true, one magnitude will be preferred even if magnitude criteria are
not fullfilled.
M, mBc, Mw\(mB\), Mwp, ML, MLv, mb
.. confval:: eventAssociation.minimumMagnitudes
@ -583,8 +633,12 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *int*
Minimum number of station magnitudes referenced to a network magnitude
to become a preferred magnitude.
Minimum number of station magnitudes required for
considering non\-Mw or non\-Mw\(\) magnitudes, as
preferred magnitude.
Also consider
\"eventAssociation.enableFallbackMagnitude\".
.. confval:: eventAssociation.minMwCount
@ -593,8 +647,25 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *int*
Minimum number of station magnitudes required for Mw\(mB\) to be considered as
preferred magnitude.
Minimum number of station magnitudes required for
considering Mw or any derived moment magnitude, Mw\(\), as
preferred magnitude. The moment magnitudes must also meet
\"eventAssociation.minimumMagnitudes\".
Also consider
\"eventAssociation.enableFallbackMagnitude\".
.. confval:: eventAssociation.enableFallbackMagnitude
Default: ``false``
Type: *boolean*
If true, one magnitude will be preferred even if magnitude
criteria \(\"eventAssociation.minimumMagnitudes\",
\"eventAssociation.minMwCount\"\) are not fulfilled
by any magnitude.
.. confval:: eventAssociation.mbOverMwCount
@ -603,8 +674,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *int*
Minimum number of station magnitudes which ensures that Mw\(mB\) will be
preferred and not mb.
Minimum number of station magnitudes which ensures that
Mw\(mB\) will be preferred and not mb.
.. confval:: eventAssociation.mbOverMwValue
@ -613,8 +684,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *double*
Average between mb and Mw\(mB\) which must be exceeded to become Mw\(mB\)
preferred.
Average between mb and Mw\(mB\) which must be exceeded to
become Mw\(mB\) preferred.
.. confval:: eventAssociation.magPriorityOverStationCount
@ -623,105 +694,130 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *boolean*
If false then the station count rules out the magnitude priority
If false, then the station count rules out the magnitude priority
which is only taken into account if two magnitudes have the
same station count.
If true then the priority rules out the station count
If true, then the priority rules out the station count
which is only taken into account if two magnitudes have the
same priority.
.. confval:: eventAssociation.priorities
Default: ``AGENCY, STATUS, PHASES_AUTOMATIC, TIME_AUTOMATIC``
Default: ``AGENCY,STATUS,PHASES_AUTOMATIC,TIME_AUTOMATIC``
Type: *list:string*
The general priority list to decide if an Origin becomes preferred.
The priority decreases in the order of the parameters.
This list is not used unless this parameter is activated.
Values: ``'',AGENCY,AUTHOR,MODE,PHASES,PHASES_AUTOMATIC,RMS,RMS_AUTOMATIC,SCORE,STATUS,TIME,TIME_AUTOMATIC``
The general priority list to decide if new Origins become
preferred.
Empty priority list: scevent replicates the default hard wired behaviour:
AGENCY, STATUS, PHASES_AUTOMATIC, TIME_AUTOMATIC
Tokens are processed in the given order. Each token in the
list corresponds to a check that is performed. Each check
computes a score of the incoming Origin \(s1\) and the
currently preferred Origin \(s2\). The origin with the higher
score becomes preferred for the event. If s1 equals s2, the
next check in the list is performed. Once a check prefers an
origin, all subsequent checks are ignored.
Each item in the list corresponds to a check that is performed.
Each check computes a score of the incoming Origin \(s1\) and the
current preferred Origin \(s2\). If the s1 is lower than s2,
the incoming Origin is rejected and does not become preferred.
All subsequent checks are ignored.
If s1 is equal to s2, the next check in the list is performed.
If s1 is larger than s2, the Origin becomes preferred and
all subsequent checks are ignored.
Available tokens \(checks\):
Available tokens:
\* AGENCY: check based on agency priorities
AGENCY: check based on agency priorities
\* AUTHOR: check based on author priorities
AUTHOR: check based on author priorities
\* MODE: priority from evaluation mode. Priority values are
MODE: evaluation mode priority: 0 \= unset, 1 \= automatic, 2 \= manual, manual over\-rules automatic
0 : unset
STATUS: priority combined from evaluation status and evaluation mode:
\-100 \= status is rejected, \-1 \= status is reported,
0 \= status is preliminary or status is unset and mode is automatic,
1 \= status is confirmed or status is unset and mode is manual,
2 \= status is reviewed, 3 \= status is final,
1 : automatic
METHOD: check based on the method priorities
2 : manual, manual over\-rules automatic
PHASES: higher phase count \= higher priority
\* STATUS: priority combined from evaluation status and
evaluation mode. Priority values are
PHASES_AUTOMATIC: only checks phase priorities for incoming automatic Origins
\-100 : status is rejected
RMS: lower rms \= higher priority
\-1 : status is reported
RMS_AUTOMATIC: only check RMS on incoming automatic Origins
0 : status is preliminary or status is unset and mode is automatic
TIME: more recent Origins \(creationTime\) have higher priorities
1 : status is confirmed or status is unset and mode is manual
TIME_AUTOMATIC: only check creationTime priority on incoming automatic Origins
2 : status is reviewed
SCORE: evaluates the score according to a configured ScoreProcessor and
prefers the Origin\/Focalmechanism with the highest score.
3 : status is final
\* METHOD: priority based on the methods defined in \"eventAssociation.methods\"
\* PHASES: higher phase count \= higher priority
\* PHASES_AUTOMATIC: only checks phase priorities for incoming
automatic Origins. Higher phase count \= higher priority.
\* RMS: lower RMS \= higher priority.
\* RMS_AUTOMATIC: only check RMS on incoming automatic Origins.
Lower RMS \= higher priority.
\* TIME: more recent Origins \(creationTime\) have higher priorities.
\* TIME_AUTOMATIC: only check creationTime of incoming
automatic Origins. More recent Origins \(creationTime\) have higher priorities.
\* SCORE: priority based on the score according to a configured
ScoreProcessor and prefers the Origin\/Focalmechanism with
the highest score.
Empty priority list replicates the hard\-wired default
behaviour: AGENCY,STATUS,PHASES_AUTOMATIC,TIME_AUTOMATIC
.. confval:: eventAssociation.agencies
Type: *list:string*
The agencyID priority list. When the eventtool comes to the point to
select a preferred Origin based on AGENCY it orders all Origins by its agency priority and
selects then the best one among the highest priority agency. It also defines the
agency priority for custom priority checks
\(eventAssociation.priorities\).
The priority list of agency IDs. When scevent comes to the
point to select a preferred Origin based on AGENCY it orders
all Origins by its agency priority selecting the best one
among the highest priority agency. It also defines the
agency priority for custom priority checks.
The parameter is only considered when defined in \"priorities\".
The parameter is only considered when AGENCY is used in
\"eventAssociation.priorities\".
.. confval:: eventAssociation.authors
Type: *list:string*
The author priority list. When the eventtool comes to the point to
select a preferred Origin based on AUTHOR it orders all Origins by its author priority and
selects then the best one among the highest priority author. It also defines the
author priority for custom priority checks \(eventAssociation.priorities\).
The author priority list. When scevent comes to the
point to select a preferred Origin based on AUTHOR it orders
all Origins by its author priority and selects then the best
one among the highest priority author. It also defines the
author priority for custom priority checks.
The parameter is only considered when defined in \"priorities\".
The parameter is only considered when AUTHOR is used
in \"eventAssociation.priorities\".
.. confval:: eventAssociation.methods
Type: *list:string*
The method priority list. When the eventtool comes to the point to
select a preferred Origin based on METHOD it orders all Origins by its methodID priority and
selects then the best one among the highest priority method. It also defines the
method priority for custom priority checks \(eventAssociation.priorities\).
A defined method string must match exactly the string in Origin.methodID.
The method priority list. When the scevent comes to the
point to select a preferred Origin based on METHOD it orders
all Origins by its methodID priority and selects then the
best one among the highest priority method. It also defines
the method priority for custom priority checks. A defined
method string must match exactly the string in
Origin.methodID.
The parameter is only considered when defined in \"priorities\".
The parameter is only considered when METHODS is used
in \"eventAssociation.priorities\".
.. confval:: eventAssociation.score
@ -729,9 +825,20 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *string*
Defines the ScoreProcessor interface to be used along
with priority \"SCORE\".
The parameter is only considered when defined in \"priorities\".
with priority \"SCORE\" when defined in
\"eventAssociation.priorities\".
.. confval:: eventAssociation.enablePreferredFMSelection
Default: ``true``
Type: *boolean*
Enables the selection of the preferred focalmechanism. If set
to false then only explicit commands will have effect on the
preferred focalmechanism selection, namely the EvPrefFocMecID
command.
.. confval:: eventAssociation.declareFakeEventForRejectedOrigin
@ -748,30 +855,32 @@ scevent inherits :ref:`global options<global-configuration>`.
.. confval:: eventAssociation.delayTimeSpan
Default: ``0``
Type: *int*
Unit: *s*
Configures a timespan to delay Event creation. If a new Origin arrives
which cannot be associated to an existing Event, delay the Event creation for a certain
timespan.
The timespan to delay Event creation from new Origins which
cannot be associated to an existing Event.
.. note::
**eventAssociation.region.\***
*Region filter for creating events. Use with care! Origins*
*outside may be ignored even if they would*
*become preferred otherwise.*
*outside may be ignored even if they would become preferred*
*otherwise. Empty value deactivates testing this parameter.*
.. confval:: eventAssociation.region.rect
Type: *string*
Type: *list:double*
Region by geographic coordinates.
Region by geographic coordinates. Empty value
deactivates testing this parameter.
Format: \"South, East, North, West\"
Format: \"South,East,North,West\"
.. confval:: eventAssociation.region.minDepth
@ -780,7 +889,8 @@ scevent inherits :ref:`global options<global-configuration>`.
Unit: *km*
Minimum depth.
Minimum depth. Empty value deactivates testing this
parameter.
.. confval:: eventAssociation.region.maxDepth
@ -789,13 +899,16 @@ scevent inherits :ref:`global options<global-configuration>`.
Unit: *km*
Maximum depth.
Maximum depth. Empty value deactivates testing this
parameter.
.. note::
**eventAssociation.delayFilter.\***
*The delayFilter group configures an Origin filter to activate the delay feature for*
*this Origin. If more than one filter is given they are combined with AND.*
*Configure an Origin filter to delay Origin for being*
*processed. If more than one filter is given they are*
*combined with AND. The application requires*
*eventAssociation.delayTimeSpan > 0.*
@ -803,7 +916,7 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *string*
The agencyID of the Origin to be delayed.
The agency ID of the Origin to be delayed.
.. confval:: eventAssociation.delayFilter.author
@ -817,8 +930,9 @@ scevent inherits :ref:`global options<global-configuration>`.
Type: *string*
The evaluation mode of the Origin to be delayed. Can be either \"manual\"
or \"automatic\".
Values: ``automatic,manual``
The evaluation mode of the Origin to be delayed.
.. _scevent/EventType:
@ -1080,7 +1194,7 @@ Generic
.. option:: -O, --origin-id publicID
OriginID to be associated. When given no messages are sent.
Origin ID to be associated. When given no messages are sent.
Only the status of the association is written to stdout.
@ -1135,18 +1249,22 @@ Messaging
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.
@ -1154,6 +1272,8 @@ Messaging
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@ -1184,3 +1304,39 @@ Database
Do not use the database at all
Input
-----
.. option:: --ep
Event parameters XML file for offline processing of all
contained origins. Use '\-' to read from stdin.
.. option:: --reprocess
Reprocess event parameters ignoring all event and journal
objects in input file. Works only in combination with '\-\-ep'.
.. option:: --update-event-id
Update IDs of events if they already exist. Works only in
combination with '\-\-ep'.
.. option:: --clear-cache
Send a clear cache message and quit.
.. option:: --disable-info-log
Do not populate the scevent\-processing\-info.log file.
Output
------
.. option:: -f, --formatted
Use formatted XML output along with '\-\-ep'. Otherwise XML
is unformatted.