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

[installation] Change to nightly

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
share/doc/seiscomp/html/_sources/apps/bindings2cfg.rst.txt
View File

@@ -196,18 +196,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.
@@ -217,8 +221,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

2
share/doc/seiscomp/html/_sources/apps/diskmon.rst.txt
View File

@@ -36,7 +36,7 @@ Module Configuration
.. note::
diskmon is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
diskmon is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
| :file:`etc/defaults/diskmon.cfg`

4
share/doc/seiscomp/html/_sources/apps/dlsv2inv.rst.txt
View File

@@ -31,10 +31,6 @@ While importing the attribute :confval:`datacenterID` is read and written into
the archive attribute of all networks and stations available in the dataless.
The datacenterID can be overridden with the ``--dcid`` command-line option.
.. note::
Conversion of inventory in |scname| XML to dataless SEED is provided by :ref:`inv2dlsv`.
Examples
========

9
share/doc/seiscomp/html/_sources/apps/ew2sc.rst.txt
View File

@@ -276,18 +276,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.
@@ -297,8 +301,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

109
share/doc/seiscomp/html/_sources/apps/fdsnws.rst.txt
View File

@@ -12,12 +12,9 @@ fdsnws
Description
===========
fdsnws is a server that provides event and station information by FDSN Web Services
(:cite:t:`fdsn`)
from a SeisComP database and waveforms from a :ref:`global_recordstream` source.
Also it may be configured to serve data
availability information as described in the IRIS DMC FDSNWS availability Web
Service Documentation (:cite:t:`iris-dmc`).
fdsnws is a server that provides event, station and data availability
information by FDSN Web Services (:cite:t:`fdsn`) from a SeisComP database and
waveforms from a :ref:`global_recordstream` source.
.. caution::
If you expose the FDSN Web Service as a public service, make sure that
@@ -262,10 +259,6 @@ what time series data is available at the DMC archive. The availability informat
can be created by :ref:`scardac` in the |scname| database from where it is
fetched by fdsnws.
The availability service is no official standard yet. This implementation aims
to be compatible with the IRIS DMC availability FDSN Web Service
(:cite:t:`iris-dmc`) implementation.
* request type: HTTP-GET, HTTP-POST
* results may be filtered e.g. by channel code, time and quality
@@ -540,16 +533,16 @@ station AAI (assuming that we are authorized to get data of this station).
.. code-block:: sh
sysop@host:~$ wget --post-file token.asc https://geofon.gfz-potsdam.de/fdsnws/dataselect/1/auth -O cred.txt
sysop@host:~$ curl --data-binary @token.asc https://geofon.gfz-potsdam.de/fdsnws/dataselect/1/auth -o cred.txt
sysop@host:~$ wget --post-file token.asc https://geofon.gfz.de/fdsnws/dataselect/1/auth -O cred.txt
sysop@host:~$ curl --data-binary @token.asc https://geofon.gfz.de/fdsnws/dataselect/1/auth -o cred.txt
* The resulting file "cred.txt" contains username and password separated by
a colon, so one can conveniently use a shell expansion:
.. code-block:: sh
sysop@host:~$ wget "http://`cat cred.txt`@geofon.gfz-potsdam.de/fdsnws/dataselect/1/queryauth?starttime=2015-12-15T16:00:00Z&endtime=2015-12-15T16:10:00Z&network=IA&station=AAI" -O data.mseed
sysop@host:~$ curl --digest "http://`cat cred.txt`@geofon.gfz-potsdam.de/fdsnws/dataselect/1/queryauth?starttime=2015-12-15T16:00:00Z&endtime=2015-12-15T16:10:00Z&network=IA&station=AAI" -o data.mseed
sysop@host:~$ wget "http://`cat cred.txt`@geofon.gfz.de/fdsnws/dataselect/1/queryauth?starttime=2015-12-15T16:00:00Z&endtime=2015-12-15T16:10:00Z&network=IA&station=AAI" -O data.mseed
sysop@host:~$ curl --digest "http://`cat cred.txt`@geofon.gfz.de/fdsnws/dataselect/1/queryauth?starttime=2015-12-15T16:00:00Z&endtime=2015-12-15T16:10:00Z&network=IA&station=AAI" -o data.mseed
* Using the :ref:`fdsnws_fetch <sec-fdsnws-related>` utility, the two steps above can be combined into
one:
@@ -745,10 +738,11 @@ fdsnws inherits :ref:`global options<global-configuration>`.
Unit: *s*
Restrict end time of requests to current time \- realtimeGap
seconds. Negative values allowed. Used in fdsnws\-dataselect.
WARNING: If this value is unset and a realtime recordsource
\(e.g. slink\) is used, requests may block if end time in future
is requested.
seconds. Negative values are allowed. Used in fdsnws\-dataselect.
WARNING: If this value is unset and a real\-time RecordStream
\(e.g. slink\) is used, requests may block if end times in the
future are requested.
.. confval:: samplesM
@@ -771,7 +765,7 @@ fdsnws inherits :ref:`global options<global-configuration>`.
Set the number of bytes to buffer for each chunk of waveform data
served to the client. The lower the buffer the higher the overhead
of Python Twisted. The higher the buffer the higher the memory
usage per request. 100kB seems to be a good trade\-off.
usage per request. 100 kB seems to be a good trade\-off.
.. confval:: htpasswd
@@ -790,14 +784,14 @@ fdsnws inherits :ref:`global options<global-configuration>`.
Type: *string*
Path to access log file. If unset no access log is created.
Path to access log file. If unset, no access log is created.
.. confval:: requestLog
Type: *string*
Path to request log file. If unset no request log is created.
Path to request log file. If unset, no request log is created.
.. confval:: userSalt
@@ -816,7 +810,10 @@ fdsnws inherits :ref:`global options<global-configuration>`.
List of domain names Cross\-Origin Resource Sharing \(CORS\)
request may originate from. A value of '\*' allows any web page
to embed your service. An empty value will switch of CORS
requests entirely. An example of multiple domains might be:
requests entirely.
Example of multiple domains:
'https:\/\/test.domain.de, https:\/\/production.domain.de'.
@@ -873,6 +870,8 @@ fdsnws inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``,automatic,manual``
If set, the event service will only return events having a
preferred origin with a matching evaluationMode property.
@@ -881,6 +880,8 @@ fdsnws inherits :ref:`global options<global-configuration>`.
Type: *list:string*
Values: ``csv,qml,qml-rt,sc3ml,text,xml``
List of enabled event formats. If unspecified, all supported
formats are enabled.
@@ -924,14 +925,14 @@ fdsnws inherits :ref:`global options<global-configuration>`.
.. confval:: stationFilter
Type: *string*
Type: *file*
Path to station inventory filter file.
.. confval:: dataSelectFilter
Type: *string*
Type: *file*
Path to dataselect inventory filter file.
@@ -1076,6 +1077,60 @@ fdsnws inherits :ref:`global options<global-configuration>`.
List of revoked token IDs.
.. confval:: jwt.enable
Default: ``false``
Type: *boolean*
Enable JWT extension.
.. confval:: jwt.issuers
Default: ``https://geofon.gfz.de/eas2,https://login.earthscope.org/``
Type: *list:string*
List of issuer URLs.
.. confval:: jwt.audience
Default: ``eas,fdsn``
Type: *list:string*
List of valid audience.
.. confval:: jwt.algorithms
Default: ``RS256``
Type: *list:string*
List of allowed algorithms.
.. confval:: jwt.updateMinSeconds
Default: ``300``
Type: *int*
Minimum time to wait between requesting updated keys from a key server.
.. confval:: jwt.updateMaxSeconds
Default: ``86400``
Type: *int*
Maximum time to cache received keys.
Command-Line Options
====================
@@ -1216,12 +1271,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg

2108
share/doc/seiscomp/html/_sources/apps/global.rst.txt
View File

File diff suppressed because it is too large Load Diff

32
share/doc/seiscomp/html/_sources/apps/global_fixedhypocenter.rst.txt
View File

@@ -235,6 +235,38 @@ Module Configuration
documentation for the required interface name.
.. confval:: FixedHypocenter.lat
Type: *double*
The fixed latitude to use. If not set then this
value is read from the input origin.
.. confval:: FixedHypocenter.lon
Type: *double*
The fixed longitude to use. If not set then this
value is read from the input origin.
.. confval:: FixedHypocenter.depth
Type: *double*
The fixed depth to use. If not set then this
value is read from the input origin.
.. confval:: FixedHypocenter.time
Type: *string*
The fixed time to use. If not set then this
value is read from the input origin.
.. confval:: FixedHypocenter.usePickUncertainties
Default: ``false``

424
share/doc/seiscomp/html/_sources/apps/global_gui.rst.txt
View File

@@ -916,11 +916,14 @@ Module Configuration
.. confval:: map.format
Default: ``Rectangular``
Default: ``rectangular``
Type: *string*
Projection of the map tiles configured in 'map.location'.
Values: ``rectangular,mercator``
Projection of the map tiles configured in \"map.location\".
Note: Additional projections may be available by plugins.
@@ -971,6 +974,23 @@ Module Configuration
layer is \"cities\".
.. note::
**map.mercator.\***
*Parameters specifically related to maps loaded with*
*mercator projection.*
.. confval:: map.mercator.discrete
Default: ``false``
Type: *boolean*
Only support discrete zoom levels. The parameter impacts
the effect of \"map.zoom.sensitivity\".
.. note::
**map.layers.events.\***
*Configuration options for the events layer that*
@@ -992,7 +1012,7 @@ Module Configuration
.. note::
**map.layers.fep.\***
*Configuration for the fep layer showing the polygons*
*of FEP (FLinn-Engdahl-Polygon) files on maps if they*
*of FEP (Flinn-Engdahl-Polygon) files on maps if they*
*exist in @DATADIR@/fep or @CONFIGDIR@/fep.*
@@ -1013,9 +1033,9 @@ Module Configuration
Type: *int*
Maximum number of cities to be rendered. If
cityPopulationWeight is less or equal than 0 then
all cities are rendered ordered by population count,
highest first.
\"scheme.map.cityPopulationWeight\" is less
or equal than 0 then all cities are rendered ordered
by population count, highest first.
To show the N most populated places in the visible
map region, set
\"scheme.map.cityPopulationWeight\" to 0
@@ -1033,16 +1053,17 @@ Module Configuration
.. note::
**scheme.\***
*This group defines various options for color, pen, brush, font, etc. for SeisComP*
*graphical user interfaces. There are various conventions to*
*define colors, fonts and gradients.*
*This group defines various options controlling the look and feel*
*of graphical modules. The options include symbols, units,*
*precision, color, pen, brush, font, etc. There are various*
*conventions to define colors, fonts and gradients.*
**
*Colors are defined in HTML*
*convention, e.g. as rgb values, hexadecimal numbers or color*
*keyword names defined by W3C. If rgb or rgba is used, it must*
*be quoted because the comma is handled as list separator by*
*the configuration.*
*Examples: "rgb(255,0,0)", FF00FF40, green.*
*Examples: "rgb(0,128,0)", 00800040, green.*
**
*Gradients are configured as lists of tuples where each tuple*
*is colon separated in the form value:color. Value is either*
@@ -1073,10 +1094,22 @@ Module Configuration
Type: *string*
Set position if tab bar. An unset value lets the application
decide where to place the tab bar. This option might not be
supported by all applications. Valid positions are: off, north,
south, east, west
Values: ``off,north,south,east,west``
The position of tab bar of GUI applications like scolv.
An unset value lets the application decide where to place
the tab bar. This option might not be supported by all
applications. Valid positions are: off, north, south,
east, west.
.. confval:: scheme.distanceHypocentral
Default: ``false``
Type: *boolean*
Show hypocentral instead of epicentral distances.
.. confval:: scheme.map.stationSize
@@ -1087,7 +1120,7 @@ Module Configuration
Unit: *px*
The station symbol size \(e.g. in scmv\).
The station symbol size, e.g., in scmv.
.. confval:: scheme.map.originSymbolMinSize
@@ -1098,8 +1131,43 @@ Module Configuration
Unit: *px*
The origin symbol minimum size. The formula to compute the
size of the origin symbol is: 4.9\*\(M\-1.2\).
The minimum symbol size of origins. The size is scaled
with magnitude according to
\"scheme.mag.originSymbolScaleMag\".
.. confval:: scheme.map.originSymbolMinMag
Default: ``1.2``
Type: *double*
The minimum magnitude to be represented by an origin
symbol. The symbol size of origins with this or lower
magnitude is configured by
\"scheme.mag.originSymbolMinSize\". For origins
with larger magnitudes the symbol sizes are scaled according
to \"scheme.mag.originSymbolScaleMag\".
Starting from the minimum magnitude legends explaining
magnitudes will show eight symbols in steps of one
magnitude.
.. confval:: scheme.map.originSymbolScaleMag
Default: ``4.9``
Type: *double*
Unit: *px/magnitude*
The factor for scaling the symbol size of origins with
some magnitude as:
\"scheme.mag.originSymbolScaleMag\" \* \(magnitude \- \"scheme.mag.originSymbolMinMag\"\).
The color of origins symbols is controlled by the parameters
\"scheme.colors.originSymbol.\*\".
.. confval:: scheme.map.vectorLayerAntiAlias
@@ -1179,8 +1247,14 @@ Module Configuration
Type: *string*
SeisComP ships with the rectangular projection built\-in.
Values: ``Rectangular,Mercator``
The projection for showing maps. SeisComP ships with
Rectangular and Mercator.
Other projections may be provided through plugins.
The visible latitude range of maps shown with Mercator
is limited to \-85 \- +85 deg.
.. confval:: scheme.map.toBGR
@@ -1203,6 +1277,25 @@ Module Configuration
Minimum screen distance to plot a polygon or polyline line segment.
.. confval:: scheme.map.maxZoom
Default: ``24``
Type: *float*
Range: ``1:24``
Maximum allowed zoom level.
.. note::
**scheme.colors.\***
*Colors can be configured as rgb, rgba. hexadecimal numbers or color keyword names*
*defined by W3C. If a color is unset, SeisComP applications*
*attempt to read it from your Desktop theme.*
.. confval:: scheme.colors.background
Type: *color*
@@ -1304,7 +1397,10 @@ Module Configuration
Type: *string*
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
Values: ``NoPen, SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
.. confval:: scheme.colors.map.directivity.width
@@ -1339,7 +1435,11 @@ Module Configuration
Type: *string*
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine,
DashDotDotLine.
.. confval:: scheme.colors.map.grid.width
@@ -1393,6 +1493,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1429,6 +1531,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1465,6 +1569,8 @@ Module Configuration
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagcross``
The style of the brush. Supported values are, e.g.:
solid, dense1, dense7, horizontal, vertical,
cross, bdiag, fdiag, diagcross.
@@ -1491,6 +1597,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1527,6 +1635,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1563,6 +1673,8 @@ Module Configuration
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagcross``
The style of the brush. Supported values are, e.g.:
solid, dense1, dense7, horizontal, vertical,
cross, bdiag, fdiag, diagcross.
@@ -1583,7 +1695,7 @@ Module Configuration
Type: *color*
A general trace color of the alternate trace \(eg scheli\).
A general trace color of the alternate trace, e.g., scheli.
.. confval:: scheme.colors.records.background
@@ -1665,6 +1777,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1680,7 +1794,7 @@ Module Configuration
.. note::
**scheme.colors.records.borders.standard.brush.\***
*Defines the brush of the enlcosed area.*
*Defines the brush of the enclosed area.*
@@ -1695,6 +1809,8 @@ Module Configuration
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagcross``
The style of the brush. Supported values are, e.g.:
solid, dense1, dense7, horizontal, vertical,
cross, bdiag, fdiag, diagcross.
@@ -1723,6 +1839,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1753,6 +1871,8 @@ Module Configuration
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagcross``
The style of the pen. Supported values are, e.g.:
solid, dense1, dense7, horizontal, vertical,
cross, bdiag, fdiag, diagcross.
@@ -1781,6 +1901,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are:
NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1811,6 +1933,8 @@ Module Configuration
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagcross``
The style of the pen. Supported values are, e.g.:
solid, dense1, dense7, horizontal, vertical,
cross, bdiag, fdiag, diagcross.
@@ -1837,6 +1961,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1872,6 +1998,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -1907,6 +2035,8 @@ Module Configuration
Type: *string*
Values: ``NoPen,SolidLine,DashLine,DotLine,DashDotLine,DashDotDotLine``
The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine.
@@ -2052,7 +2182,7 @@ Module Configuration
The gradient of arrivals residuals. A gradient is defined as
a list of tuples separated by colon where the first item is
the value and the second is the color. Colors can be given in
rgb notation or hexadecimal. When rgb is used double quotes are needed to
rgb notation or hexadecimal. When rgb is used, double quotes are needed to
protect the comma inside the rgb definition, e.g.
\-8:\"rgb\(0,0,100\)\", \-4:\"rgb\(0,0,255\)\", \-3:\"rgb\(100,100,255\)\", ...
@@ -2106,7 +2236,7 @@ Module Configuration
Type: *color*
The color of associated stations \(e.g. in scmv\).
The color of associated stations, e.g., in scmv.
.. confval:: scheme.colors.stations.triggering
@@ -2328,7 +2458,7 @@ Module Configuration
Type: *color*
The color of the selected zoom area \(e.g. manual picker\).
The color of the selected zoom area, e.g., in scolv picker.
.. confval:: scheme.colors.legend.background
@@ -2359,6 +2489,14 @@ Module Configuration
The map legend header color.
.. note::
**scheme.colors.originSymbol.\***
*Parameters controlling the color of origin symbols. The*
*size is controlled by the parameters*
*"scheme.mag.originSymbol*".*
.. confval:: scheme.colors.originSymbol.classic
Default: ``false``
@@ -2388,7 +2526,7 @@ Module Configuration
.. note::
**scheme.colors.originStatus.\***
*The origin status colors (e.g. in event list).*
*The origin status colors, e.g., in event lists.*
@@ -2434,7 +2572,7 @@ Module Configuration
Unit: *px*
The line width of the marker \(e.g. picks of manual picker\).
The line width of the marker, e.g., picks of scolv picker\).
.. confval:: scheme.records.lineWidth
@@ -2445,7 +2583,7 @@ Module Configuration
Unit: *px*
The line width of the records \/ traces.
The line width of the records\/traces.
.. confval:: scheme.records.antiAliasing
@@ -2454,7 +2592,7 @@ Module Configuration
Type: *boolean*
Configures antialiasing of records \/ traces. Antialiasing
Configures antialiasing of records\/traces. Antialiasing
needs more two times to storage space as non antialiasing
but it improves visual quality.
@@ -2465,9 +2603,30 @@ Module Configuration
Type: *boolean*
Configures optimization of trace polylines. If activated
then lines on the same pixel line or same pixel row
collapse into single lines.
Configures optimization of trace polylines. If activated,
lines on the same pixel line or same pixel row collapse
into single lines.
.. confval:: scheme.records.showEngineeringValues
Default: ``true``
Type: *boolean*
Shows numerical values in the vertical axis and the min\/mean
values between 0 and 1000 with a unit prefix such as
m \(milli\) or M \(mega\).
Supported prefixes are:
Q \(queta \= 10\*\*30\), R \(ronna \= 10\*\*27\), Y \(yotta \= 10\*\*24\),
Z \(zetta \= 10\*\*21\), E \(exa \= 10\*\*18\), P \(peta \= 10\*\*15\),
T \(tera \= 10\*\*12\), G \(giga \= 10\*\*9\), M \(mega \= 10\*\*6\),
k \(kilo \= 10\*\*3\),
m \(milli \= 10\*\*\-3\), µ \(micro \= 10\*\*\-6\), n \(nano \= 10\*\*\-9\),
p \(pico \= 10\*\*\-12\), f \(femto \= 10\*\*\-15\), a \(atto \= 10\*\*\-18\),
z \(zepto \= 10\*\*\-21\), y \(yocto \= 10\*\*\-24\), r \(ronto \= 10\*\*\-27\),
q \(quekto \= 10\*\*\-30\).
.. confval:: scheme.records.borders.drawMode
@@ -2476,6 +2635,8 @@ Module Configuration
Type: *string*
Values: ``topline,box,bottomline``
Mode for drawing record borders as box or line on top or
bottom.
@@ -2493,14 +2654,15 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.base.size
Type: *int*
Defines the point size of the font
Defines the point size of the font.
.. confval:: scheme.fonts.base.bold
@@ -2537,7 +2699,8 @@ Module Configuration
.. note::
**scheme.fonts.small.\***
*The smallest available font. If undefined the point size is 2 points smaller than the base font.*
*The smallest available font. If undefined, the point*
*size is 2 points smaller than the base font.*
@@ -2545,7 +2708,8 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.small.size
@@ -2589,7 +2753,8 @@ Module Configuration
.. note::
**scheme.fonts.normal.\***
*The default text font. If undefined the point size is 2 points larger than the base font.*
*The default text font. If undefined, the point size is 2*
*points larger than the base font.*
@@ -2597,14 +2762,15 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.normal.size
Type: *int*
Defines the point size of the font
Defines the point size of the font.
.. confval:: scheme.fonts.normal.bold
@@ -2641,7 +2807,8 @@ Module Configuration
.. note::
**scheme.fonts.large.\***
*The largest text font. If undefined the point size is 6 points larger than the base font.*
*The largest text font. If undefined, the point size is 6*
*points larger than the base font.*
@@ -2649,7 +2816,8 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.large.size
@@ -2693,7 +2861,8 @@ Module Configuration
.. note::
**scheme.fonts.highlight.\***
*Font used to highlight text. If undefined it equals the normal font except for a bold font face.*
*Font used to highlight text. If undefined, it equals the*
*normal font except for a bold font face.*
@@ -2701,7 +2870,8 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.highlight.size
@@ -2745,7 +2915,8 @@ Module Configuration
.. note::
**scheme.fonts.heading1.\***
*The largest heading font. If undefined it uses a bold font face and a font size twice as large as the normal font.*
*The largest heading font. If undefined, it uses a bold*
*font face and a font size twice as large as the normal font.*
@@ -2753,14 +2924,15 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.heading1.size
Type: *int*
Defines the point size of the font
Defines the point size of the font.
.. confval:: scheme.fonts.heading1.bold
@@ -2797,7 +2969,8 @@ Module Configuration
.. note::
**scheme.fonts.heading2.\***
*The second largest heading font. If undefined it uses a bold font face and a font size twice as large as the base font.*
*The second largest heading font. If undefined, it uses a*
*bold font face and a font size twice as large as the base font.*
@@ -2805,14 +2978,15 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.heading2.size
Type: *int*
Defines the point size of the font
Defines the point size of the font.
.. confval:: scheme.fonts.heading2.bold
@@ -2849,7 +3023,8 @@ Module Configuration
.. note::
**scheme.fonts.heading3.\***
*The smallest heading font. If undefined it uses a bold font face and a font size 4 points larger than the base font.*
*The smallest heading font. If undefined, it uses a bold*
*font face and a font size 4 points larger than the base font.*
@@ -2857,7 +3032,8 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.heading3.size
@@ -2901,7 +3077,8 @@ Module Configuration
.. note::
**scheme.fonts.cityLabels.\***
*Font used for city labels. If undefined it equals the base font.*
*Font used for city labels. If undefined, it equals the*
*base font.*
@@ -2909,14 +3086,15 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.cityLabels.size
Type: *int*
Defines the point size of the font
Defines the point size of the font.
.. confval:: scheme.fonts.cityLabels.bold
@@ -2953,7 +3131,9 @@ Module Configuration
.. note::
**scheme.fonts.splashVersion.\***
*Font used for version string in the splash dialog shown at application startup. If undefined it equals the base font with a bold font face and a font size of 12.*
*Font used for version string in the splash dialog shown*
*at application startup. If undefined, it equals the base*
*font with a bold font face and a font size of 12.*
@@ -2961,14 +3141,15 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.splashVersion.size
Type: *int*
Defines the point size of the font
Defines the point size of the font.
.. confval:: scheme.fonts.splashVersion.bold
@@ -3005,7 +3186,9 @@ Module Configuration
.. note::
**scheme.fonts.splashMessage.\***
*Font used for the message text in the splash dialog shown at application startup. If undefined it equals the base font with a font size of 12.*
*Font used for the message text in the splash dialog*
*shown at application startup. If undefined, it equals*
*the base font with a font size of 12.*
@@ -3013,7 +3196,8 @@ Module Configuration
Type: *string*
Sets the family name of the font. The name is case insensitive and may include a foundry name.
Sets the family name of the font. The name is case
insensitive and may include a foundry name.
.. confval:: scheme.fonts.splashMessage.size
@@ -3055,6 +3239,13 @@ Module Configuration
*No description available*
.. note::
**scheme.precision.\***
*Display values with the precisions configured as the number*
*of decimal places.*
.. confval:: scheme.precision.depth
Default: ``0``
@@ -3080,7 +3271,7 @@ Module Configuration
Type: *int*
The precision of lat\/lon values.
The precision of latitude\/longintude values.
.. confval:: scheme.precision.magnitude
@@ -3098,7 +3289,8 @@ Module Configuration
Type: *int*
The precision of origin times.
The precision of origin times and creation times of
origins and focal mechanisms.
.. confval:: scheme.precision.pickTime
@@ -3116,7 +3308,8 @@ Module Configuration
Type: *int*
Precision of displayed offset\/amp in all trace widgets.
Precision of displayed offset\/amplitude in all trace
widgets.
.. confval:: scheme.precision.rms
@@ -3134,7 +3327,8 @@ Module Configuration
Type: *int*
Precision of uncertainty values, e.g. latitude errors.
Precision of uncertainty values, e.g., for latitude and
longitude.
.. confval:: scheme.unit.distanceInKM
@@ -3152,7 +3346,9 @@ Module Configuration
Type: *boolean*
Display times in localtime or UTC \(default\).
Display times in localtime. If disabled all times are
shown in UTC which is also the time zone of all values
stored in the database.
.. note::
@@ -3249,7 +3445,8 @@ Module Configuration
.. note::
**events.timeAgo.\***
*Defines maximum age of events to load. The value of all parameters are aggregated.*
*Defines maximum age of events to load. The value of all*
*parameters are aggregated.*
@@ -3344,12 +3541,11 @@ Module Configuration
Type: *list:string*
Values: ``TimeAgo,Certainty,Type,M,MType,RMS,AzGap,Phases,Lat,Lon,Depth,DType,Stat,FM,Origins,Agency,Author,Region,ID``
Configure the columns of the event list that are visible
initially. The first column containing the origin time is
always visible and cannot be hidden. Possible values are:
Certainty, Type, M, MType, RMS, AzGap, Phases, Lat, Lon, Depth, DType,
Stat, FM, Origins, Agency, Author, Region, ID.
always visible and cannot be hidden.
Custom columns can be added by eventlist.customColumn.\* or
eventlist.scripts.\* parameters.
@@ -3419,6 +3615,15 @@ Module Configuration
.. confval:: eventlist.scripts.export
Type: *file*
Defines the export script to be called with the selected
event IDs in stdin when the corresponding action is triggered
from the context menu of the list of events.
.. confval:: eventlist.scripts.columns
Type: *list:string*
@@ -3452,7 +3657,7 @@ Module Configuration
.. confval:: eventlist.scripts.column.$name.script
Type: *path*
Type: *file*
External script to invoke for each event list entry. The object represented by the
list entry is serialized to XML and passed to the script on stdin. If the return
@@ -3700,6 +3905,20 @@ Module Configuration
Maximum depth
.. confval:: eventlist.filter.database.minphasecount
Type: *int*
Minimum number of phases
.. confval:: eventlist.filter.database.maxphasecount
Type: *int*
Maximum number of phases
.. confval:: eventlist.filter.database.minmag
Type: *double*
@@ -3714,6 +3933,48 @@ Module Configuration
Maximum magnitude
.. note::
**eventlist.timeAgo.\***
*Parameters controlling the appearance of the TimeAgo column.*
.. confval:: eventlist.timeAgo.interval
Default: ``1.0``
Type: *double*
Unit: *s*
Update interval in seconds.
.. confval:: eventlist.timeAgo.background.gradient
Type: *gradient*
Unit: *s:color*
Mapping of time values in seconds to colors used as
cell backgroud color. E.g., a mapping from green
over yellow \(5min\), red \(10min\) to
transparent \(30min\) can be expressed as
\"0:40FF40FF,300:FFFF40FF,600:FF4040FF,1800:FF4040FF,1801:00000000\".
.. confval:: eventlist.timeAgo.background.discrete
Default: ``true``
Type: *boolean*
If time ago value falls between two color positions,
the resulting color will be interpolated linearly
between both colors by default. When the discrete
flag is set, the interpolation will be disabled.
.. note::
**eventedit.\***
*Control the Event tab, e.g. in scolv, showing origins and*
@@ -3732,10 +3993,12 @@ Module Configuration
.. confval:: eventedit.origin.visibleColumns
Default: ``Phases, Lat, Lon, Depth, DType, RMS, AzGap, Stat, Method, Agency, Author, Region, ID``
Default: ``Phases,Lat,Lon,Depth,DType,RMS,AzGap,Stat,Method,Agency,Author,Region,ID``
Type: *list:string*
Values: ``Phases,Lat,Lon,Depth,DType,RMS,AzGap,Stat,Method,Agency,Author,Region,ID``
Configure the columns of the event edit origin table
that are visible initially. Origin creation time and
origin time are always visible.
@@ -3771,32 +4034,38 @@ Module Configuration
Type: *int*
Position of the column. If the configured position is less than 0 or if it
exceeds the total number of columns then the column is appended to the right.
Position of the column. If the configured position
is less than 0 or if it exceeds the total number of
columns, then the column is appended to the right.
.. confval:: eventedit.origin.customColumn.default
Type: *string*
Default value to display if the specified origin or event comment id was not found.
Default value to display if the specified origin or
event comment id was not found.
.. confval:: eventedit.origin.customColumn.colors
Type: *list:string*
Mapping of comment values to colors used as text color. E.g. \"foo:#000,bar:red\".
Mapping of comment values to colors used as text
color. E.g. \"foo:#000,bar:red\".
.. confval:: eventedit.fm.visibleColumns
Default: ``Depth, M, Count, Misfit, STDR, AzGap, Stat, DC, CLVD, ISO, S1, D1, R1, S2, D2, R2, Agency, Author``
Default: ``Depth,M,Count,Misfit,STDR,AzGap,Stat,DC,CLVD,ISO,S1,D1,R1,S2,D2,R2,Agency,Author``
Type: *list:string*
Values: ``Depth,M,Count,Misfit,STDR,AzGap,Stat,DC,CLVD,ISO,S1,D1,R1,S2,D2,R2,Agency,Author``
Configure the columns of the event edit focal mechanism
tab that are visible initially.
Possible values are: Depth, M, Count, Misfit, STDR,
AzGap, Stat, DC, CLVD, ISO, S1,
D1, R1, S2, D2, R2, Agency, Author
@@ -3839,6 +4108,7 @@ Module Configuration
Unit: *pt*
The text size of the time ago label in case of an active alert.
The text size of the time ago label in case of an active
alert.

2
share/doc/seiscomp/html/_sources/apps/global_homogeneous.rst.txt
View File

@@ -28,7 +28,7 @@ e.g., in :file:`$SEISCOMP_ROOT/etc/global.cfg`:
Example configuration:
.. code-block:: params
.. code-block:: properties
# The list of supported model names per interface.
ttt.homogeneous.tables = "5"

28
share/doc/seiscomp/html/_sources/apps/global_hypo71.rst.txt
View File

@@ -345,7 +345,7 @@ Module Configuration
Default: ``@LOGDIR@/HYPO71.LOG``
Type: *string*
Type: *file*
Temporary file used by Hypo71 to store calculation logs.
@@ -354,7 +354,7 @@ Module Configuration
Default: ``@DATADIR@/hypo71/HYPO71.INP``
Type: *string*
Type: *file*
Temporary file to write Hypo71 input data to.
@@ -363,7 +363,7 @@ Module Configuration
Default: ``@DATADIR@/hypo71/HYPO71.PRT``
Type: *string*
Type: *file*
Temporary output file to read Hypo71 location data from.
@@ -372,19 +372,21 @@ Module Configuration
Default: ``@DATADIR@/hypo71/profiles/default.hypo71.conf``
Type: *string*
Type: *file*
Hypo71 default profile.
If no custom profile is specified, this profile will be used by the plugin when proceeding to a localization.
Hypo71 default profile. If no custom profile is specified,
this profile will be used by the plugin when proceeding to a
localization.
.. confval:: hypo71.hypo71ScriptFile
Default: ``@DATADIR@/hypo71/run.sh``
Type: *string*
Type: *file*
Bash script executed when calling the Hypo71 locator plugin for locating the earthquake.
Bash script executed when calling the Hypo71 locator plugin
for locating the earthquake.
.. confval:: hypo71.profiles
@@ -400,19 +402,21 @@ Module Configuration
Type: *string*
Custom patternID to use when generating origin publicID
Custom patternID to use when generating origin publicID.
.. confval:: hypo71.useHypo71PatternID
Type: *boolean*
Specifies if the given publicD should be used for generating origin publicID
Specifies if the given public ID shall be used for
generating origin publicID.
.. note::
**hypo71.profile.\***
*Profiles containing the profile-specific velocity model and the Hypo71 parameters.*
*Profiles containing the profile-specific velocity model and*
*the Hypo71 parameters.*
@@ -450,7 +454,7 @@ Module Configuration
.. confval:: hypo71.profile.$name.controlFile
Type: *string*
Type: *file*
File containing the profile parameters.

137
share/doc/seiscomp/html/_sources/apps/global_iloc.rst.txt
View File

@@ -205,9 +205,9 @@ the configuration in |scname|.
Velocity models
---------------
iLoc ships with the global models *iasp91* and *ak135* as well as with regional
seismic travel-time tables, RSTT, which, if activated by configuration, replaces
the global models in areas where they are defined.
iLoc ships with the global velocity models *iasp91* and *ak135* as well as with
regional seismic travel-time tables, RSTT, which, if activated by configuration,
replace the global models in areas where they are defined.
.. _iloc-velocity_global:
@@ -215,8 +215,23 @@ the global models in areas where they are defined.
Global models
~~~~~~~~~~~~~
The global models *iasp91* and *ak135* and RSTT are available by default without
further configuration.
The global Earth velocity models *iasp91* and *ak135* as well as *RSTT*
(section :ref:`iloc-velocity_rstt`) are available and applicable by default
without further configuration if the default iLoc profile names *iasp91*
and *ak135*, respectively, are considered. The same is true if explicit iLoc
profiles using *iasp91* or *ak135* for the profile names are added to the iLoc
configuration. Any other global model can be added, by explicitly adding an iLoc
profile as set out in section :ref:`iloc-setup`. The respective model name is
configured in :confval:`iLoc.profile.$name.globalModel`.
Similar to :ref:`global_locsat` the global models require travel-time tables for
each phase which is to be considered. The table files are located in
:confval:`iLoc.auxDir`:file:`/[model name]`.
If available, corrections for Earth's
ellipticity are considered from
:confval:`iLoc.auxDir`:file:`/[model name]/ELCOR.dat`, e.g.,
:file:`@DATADIR@/iloc/iLocAuxDir/iasp91/ELCOR.dat`.
.. _iloc-velocity_rstt:
@@ -224,7 +239,8 @@ further configuration.
RSTT
~~~~
RSTT are available in :file:`@DATADIR@/iloc/RSTTmodels/pdu202009Du.geotess`.
RSTT are available in :file:`@DATADIR@/iloc/RSTTmodels/pdu202009Du.geotess` and
applied by default.
Custom RSTT can be integrated into iLoc and provided to |scname|.
For adding custom RSTT to iLoc read the original iLoc documentation from the
:cite:t:`iloc-github` software repository.
@@ -232,9 +248,13 @@ For adding custom RSTT to iLoc read the original iLoc documentation from the
The usage of RSTT is controlled per iLoc profile by global configuration
parameters
* :confval:`iLoc.profile.$name.UseRSTT`
* :confval:`iLoc.profile.$name.UseRSTTPnSn`
* :confval:`iLoc.profile.$name.UseRSTTPgLg`
* :confval:`iLoc.profile.$name.UseRSTT`,
* :confval:`iLoc.profile.$name.UseRSTTPnSn`,
* :confval:`iLoc.profile.$name.UseRSTTPgLg`.
In order to adjust these configuration parameters for the *iasp91*,
*ak135* or any other model, the profile must be added first as set out
in section :ref:`iloc-setup`.
.. _iloc-velocity_local:
@@ -258,8 +278,8 @@ Custom local velocity models can be provided by a file in
45.000 8.0400 4.4800 MOHO
77.500 8.0400 4.4800 x
Once added, the velocity can be configured in |scname| as set out in section
:ref:`iloc-setup`.
Once added, the velocity can be configured along with iLoc profiles as set out
in section :ref:`iloc-setup`.
Station elevation
@@ -280,7 +300,7 @@ where
of the phase name.
.. note ::
.. note::
iLoc does not allow airquakes or source locations above datum (0 km). If the
depth of an origin becomes negative, iLoc
@@ -332,7 +352,7 @@ Setup in |scname|
installation read the install scripts located in
:file:`@DATADIR@/deps/[os]/[version]/install-iloc.sh`.
.. note ::
.. note::
* Check the :cite:t:`iloc-github` website for updates before downloading
the file since the version number, hence the name of the download file
@@ -363,7 +383,7 @@ Setup in |scname|
Activate the parameter to avoid phase renaming.
* Consider the remaining parameters.
.. note ::
.. note::
Creating the profiles allows using the same global velocity model along
with different local models or RSTT settings in separate profiles.
@@ -411,7 +431,7 @@ which opens the iLoc settings dialog:
Adjust the settings and click OK to confirm
.. warning ::
.. warning::
By default, automatic phase renaming by iLoc is active. The renaming may
change the phase names, e.g. from P to Pn.
@@ -450,9 +470,9 @@ Module Configuration
Default: ``@DATADIR@/iloc/iLocAuxDir``
Type: *string*
Type: *directory*
iLoc directory for auxialiary files and directories. Some
iLoc directory for auxiliary files and directories. Some
of them must be provided from the iLoc website. Read the
documentation for their installation.
@@ -486,9 +506,9 @@ Module Configuration
Type: *list:string*
iLoc profile name.
Multiples names may be set separated by comma.
Each profile can have different velocity or parameters.
List of iLoc profile name\(s\). Separate multiple names by comma.
Each profile can have different velocity or parameters. The
must be defined separate by iLoc profiles.
.. note::
@@ -540,7 +560,7 @@ Module Configuration
Type: *boolean*
Use regional seismic travel\-time tables
Use regional seismic travel\-time tables.
.. confval:: iLoc.profile.$name.UseRSTTPnSn
@@ -549,7 +569,7 @@ Module Configuration
Type: *boolean*
Use regional seismic travel\-time tables for Pn and Sn
Use regional seismic travel\-time tables for Pn and Sn.
.. confval:: iLoc.profile.$name.UseRSTTPgLg
@@ -558,7 +578,7 @@ Module Configuration
Type: *boolean*
Use regional seismic travel\-time tables for Pg and Lg
Use regional seismic travel\-time tables for Pg and Lg.
.. confval:: iLoc.profile.$name.UseLocalTT
@@ -572,7 +592,7 @@ Module Configuration
.. confval:: iLoc.profile.$name.LocalVmodel
Type: *string*
Type: *file*
Full path to a file containing the local velocity model.
Requires: UseLocalTT \= true. Empty string or unset or
@@ -602,7 +622,7 @@ Module Configuration
Type: *boolean*
Perform neighbourhood algorithm
Perform neighbourhood algorithm.
.. confval:: iLoc.profile.$name.NAsearchRadius
@@ -614,7 +634,7 @@ Module Configuration
Unit: *deg*
Neighbourhood Algorithm: Search radius around initial
epicentre
epicentre.
.. confval:: iLoc.profile.$name.NAsearchDepth
@@ -626,7 +646,7 @@ Module Configuration
Unit: *km*
Neighbourhood Algorithm: Search radius around initial
depth
depth.
.. confval:: iLoc.profile.$name.NAsearchOT
@@ -638,7 +658,7 @@ Module Configuration
Unit: *s*
Neighbourhood Algorithm: Search radius around initial
origin time
origin time.
.. confval:: iLoc.profile.$name.NAlpNorm
@@ -647,54 +667,56 @@ Module Configuration
Type: *float*
Range: ``1:2``
Neighbourhood Algorithm: p\-value for norm to compute
misfit [1,2]
misfit.
.. confval:: iLoc.profile.$name.NAiterMax
Default: ``5``
Type: *integer*
Type: *int*
Neighbourhood Algorithm: Maximum number of iterations
Neighbourhood Algorithm: Maximum number of iterations.
.. confval:: iLoc.profile.$name.NAcells
Default: ``25``
Type: *integer*
Type: *int*
Neighbourhood Algorithm: Number of cells to be resampled
at each iteration
at each iteration.
.. confval:: iLoc.profile.$name.NAinitialSample
Default: ``1000``
Type: *integer*
Type: *int*
Neighbourhood Algorithm: Size of initial sample
Neighbourhood Algorithm: Size of initial sample.
.. confval:: iLoc.profile.$name.NAnextSample
Default: ``100``
Type: *integer*
Type: *int*
Neighbourhood Algorithm: Size of subsequent samples
Neighbourhood Algorithm: Size of subsequent samples.
.. confval:: iLoc.profile.$name.MinDepthPhases
Default: ``3``
Type: *integer*
Type: *int*
Depth resolution: Minimum number of depth phases for depdp
Depth resolution: Minimum number of depth phases.
.. confval:: iLoc.profile.$name.MaxLocalDistDeg
@@ -705,16 +727,16 @@ Module Configuration
Unit: *deg*
Depth resolution: Maximum local distance
Depth resolution: Maximum local distance.
.. confval:: iLoc.profile.$name.MinLocalStations
Default: ``1``
Type: *integer*
Type: *int*
Depth resolution: Minimum number of local defining stations
Depth resolution: Minimum number of local defining stations.
.. confval:: iLoc.profile.$name.MaxSPDistDeg
@@ -725,23 +747,24 @@ Module Configuration
Unit: *deg*
Depth resolution: Maximum distance for using S\-P travel\-time differences.
Depth resolution: Maximum epicentral distance for
using S\-P travel\-time differences.
.. confval:: iLoc.profile.$name.MinSPpairs
Default: ``3``
Type: *integer*
Type: *int*
Depth resolution: Minimum number of defining S\-P phase pairs
Depth resolution: Minimum number of defining S\-P phase pairs.
.. confval:: iLoc.profile.$name.MinCorePhases
Default: ``3``
Type: *integer*
Type: *int*
Depth resolution: Minimum number of defining core reflection phases
@@ -754,7 +777,7 @@ Module Configuration
Unit: *km*
Depth resolution: Maximum depth error for crustal free\-depth
Depth resolution: Maximum depth error for crustal free\-depth.
.. confval:: iLoc.profile.$name.MaxDeepDepthError
@@ -765,7 +788,7 @@ Module Configuration
Unit: *km*
Depth resolution: Maximum depth error for deep free\-depth
Depth resolution: Maximum depth error for deep free\-depth.
.. confval:: iLoc.profile.$name.DoCorrelatedErrors
@@ -774,7 +797,7 @@ Module Configuration
Type: *boolean*
Linearized inversion: Account for correlated errors
Linearized inversion: Account for correlated errors.
.. confval:: iLoc.profile.$name.SigmaThreshold
@@ -785,7 +808,7 @@ Module Configuration
Unit: *s*
Linearized inversion: Used to exclude big residuals from solution
Linearized inversion: Used to exclude big residuals from solution.
.. confval:: iLoc.profile.$name.AllowDamping
@@ -794,34 +817,34 @@ Module Configuration
Type: *boolean*
Linearized inversion: Allow damping of model vector
Linearized inversion: Allow damping of model vector.
.. confval:: iLoc.profile.$name.MinIterations
Default: ``4``
Type: *integer*
Type: *int*
Linearized inversion: Minimum number of iterations
Linearized inversion: Minimum number of iterations.
.. confval:: iLoc.profile.$name.MaxIterations
Default: ``20``
Type: *integer*
Type: *int*
Linearized inversion: Maximum number of iterations
Linearized inversion: Maximum number of iterations.
.. confval:: iLoc.profile.$name.MinNdefPhases
Default: ``4``
Type: *integer*
Type: *int*
Linearized inversion: Minimum number of defining phases
Linearized inversion: Minimum number of defining phases.
.. confval:: iLoc.profile.$name.DoNotRenamePhases

2
share/doc/seiscomp/html/_sources/apps/global_locrouter.rst.txt
View File

@@ -192,7 +192,7 @@ Module Configuration
.. confval:: RouterLocator.regions
Type: *string*
Type: *file*
A GeoJSON or BNA file defining locator profiles by region.
Supported polygon attributes:

85
share/doc/seiscomp/html/_sources/apps/global_locsat.rst.txt
View File

@@ -30,7 +30,14 @@ phases, epicentral distance, soure depth and station elevation.
Locator Interface
=================
LOCSAT provides the hypocenter parameters through the locator interface.
LOCSAT provides the hypocenter parameters through the locator interface. Instead
of specifying an Earth model, LOCSAT queries travel times via the
:ref:`LOCSAT travel-time interface <locsat_tti>` which makes use of
:ref:`pre-defined travel-time tables <locsat_ttt>`. Note the
:ref:`limitations <locsat_tt>`.
Use "LOCSAT" as a value for the locator interface along with a profile when
configurable, e.g., by :ref:`scolv`, :ref:`scautoloc` or :ref:`screloc`.
.. _locsat_tti:
@@ -38,12 +45,16 @@ LOCSAT provides the hypocenter parameters through the locator interface.
Travel-Time Interface
=====================
LOCSAT provides an interface for computing travel times based on coordinates and
depth. The times are plotted on waveforms, e.g., blue marks in
:ref:`scolv picker window <scolv-sec-waveform-review>`.
LOCSAT provides an interface for computing travel times based on station and
source coordinates with non-negative source depths. Note the
:ref:`limitations <locsat_tt>`.
The travel times are used for predicting phase arrival times in various
applications such as :ref:`scautoloc` or :ref:`scolv`. The times are visualized,
e.g., as blue marks in the :ref:`scolv picker window <scolv-sec-waveform-review>`.
Use "LOCSAT" as a value for the travel-time interface when configurable, e.g.,
by :ref:`global_fixedhypocenter`.
by :ref:`global_fixedhypocenter` or :ref:`global_stdloc`.
.. _locsat_ttt:
@@ -70,16 +81,19 @@ your |scname| modules.
Limitations
-----------
#. The source depth is limited to non-negative values up to 800 km.
#. Only phases for which a travel-time table exists can be considered.
#. LOCSAT currently considers travel-time tables for phases which are hard-coded
* seismic body waves: P, Pg, Pb, Pn, Rg, pP, sP, PKP, PP, PKPab, PKPbc, PKPdf,
SKPdf, PcP,
S, Sg, Sb, Sn, Lg, SKS, SS, ScS,
* seismic body waves: P, Pb, Pg, Pn, pP, PP, PcP, PKiKP, PKIKP, PKKP, PKP,
PKPab, PKPbc, PKPdf, pPKPab, pPKPbc, pPKPdf,
where P and S are the direct P and S phases, respectively, at all distances
no matter the take-off angle at the source.
* seismic surface waves: LQ, LR.
S, Sb, Sg, Sn, sP, sS, SS, ScP, ScS, SKKP, SKP, SKPdf, SKS, SKSac, SKSdf,
sPKPab, sPKPbc, sPKPdf,
where P and S are the frist-arrival direct P and S phases, respectively, at
all distances no matter the take-off angle at the source.
* seismic surface waves: LQ, LR, Lg, Rg.
* infrasound: Is, It, Iw.
#. The maximum number of distance and depth intervals per table file is
@@ -98,21 +112,21 @@ Limitations
#. The considered minimum depth is 0 km. Elevations and depths above datum are
not natively considered. The effects of station elevation can be
:ref:`corrected for empirically <locsat_station_elevation>`.
:ref:`empirically corrected for<locsat_station_elevation>`.
.. _locsat_station_elevation:
Station elevations
------------------
LOCSAT does not natively support corrections of travel-time tables for station
LOCSAT does not natively support corrections of travel times for station
elevations. At least checking the code:
.. code-block:: c
sta_cor[i] = 0.0; /* FIX !!!!!!*/
However, the |scname| wrapper adds this feature. It allows to define a
:file:`.stacor` file which defines emperic corrections of observed travel times.
The corrections are provided in seconds and **subtracted** (not added) from
@@ -121,28 +135,43 @@ station correction definitions.
Each LOCSAT profile (travel time table) can have one associated station
correction file. E.g. for adding station corrections to the iasp91 tables, the
file :file:`$SEISCOMP_ROOT/share/locsat/tables/iasp91.stacor` needs to be created.
file :file:`$SEISCOMP_ROOT/share/locsat/tables/iasp91.stacor` needs to be
created.
A station correction table takes the form:
Station correction files take the form (example):
.. code-block:: params
.. code-block:: properties
# LOCDELAY code phase numReadings delay
LOCDELAY GE.MORC P 1 -0.1
LOCDELAY GE.MORC P 1 0.15
LOCDELAY IU.ANMO.00 P 1 0.36
LOCDELAY IU.KONO.20 P 1 -0.03
with
- **code** (*string*) station code (after all alias evaluations)
- **phase** (*string*) phase type (any of the available travel time tables)
- **numReadings** (*integer*) number of residuals used to calculate mean residual/delay
(not used by NLLoc, included for compatibility with the format of a summary,
phase statistics file)
- **delay** (*float*) delay in seconds, subtracted from observed time
- **LOCDELAY**: Required fixed string.
- **code** (*string*): Stream code (after all alias evaluations) up to sensor
location code with network and station code as a minium. Exception: If only
a station code is given, then only the station code is checked. This is a
fallback for data centers ignoring network codes and should be used
exceptionally only.
Network, station and
sensor location codes are separated by '.'. If no sensor location is given, an
empty code is assumed. Wildcards are not supported.
- **phase** (*string*): Phase type (any of the available travel time tables)
- **numReadings** (*integer*): Number of residuals used to calculate mean
residual/delay. Not used by LOCSAT, included for compatibility reasons with
:ref:`NonLinLoc <global_nonlinloc>`
- **delay** (*float*): Delay in seconds, subtracted from observed time.
.. note::
The fourth column (numReadings) is ignored and just provided for compatibility
reasons with :ref:`NonLinLoc <global_nonlinloc>`.
* Station corrections are only considered by the locator, not the travel-time
interface. Therefore, they do not find application for locating by
:ref:`global_fixedhypocenter` or for phase association in :ref:`scautoloc`.
* The example file for station corrections above reflect the format not any
empirically derived relationship and the values themselves have no meaning.
.. _locsat_station_application:
@@ -168,13 +197,13 @@ Custom travel-time tables
#. Add your available custom LOCSAT travel-time tables in global configuration,
e.g., to the list of tables of travel-time interfaces
.. code-block:: params
.. code-block:: properties
ttt.LOCSAT.tables = iasp91, tab, custom
and to the list of locator profiles
.. code-block:: params
.. code-block:: properties
LOCSAT.profiles = iasp91, tab, custom

6
share/doc/seiscomp/html/_sources/apps/global_ml.rst.txt
View File

@@ -18,7 +18,7 @@ General (default) conditions apply:
* Time window, configurable: 150 s by :ref:`scautopick` or distance dependent, configurable.
* Distance type: epicentral distance.
* Distance range: 0 - 8 deg, maximum is configurable:
:confval:`magnitudes.ML.maxDistanceKm`,
:confval:`magnitudes.ML.maxDist`,
measurements beyond 8 deg will be strictly ignored.
* Depth range: 0 - 80 km, configurable for amplitude measurements.
@@ -49,10 +49,10 @@ function and distance range can be configured globally or per station using
global bindings or the global module configuration variable
module.trunk.global.magnitudes.ML.logA0 in :file:`global.cfg`, e.g.
.. code-block:: params
.. code-block:: properties
module.trunk.global.magnitudes.ML.logA0 = "0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85"
module.trunk.global.magnitudes.ML.maxDistanceKm = "-1"
module.trunk.global.magnitudes.ML.maxDist = 1000km
The *logA0* configuration string consists of an arbitrary number of
distance-value pairs separated by comma. Within the pairs, the values are

264
share/doc/seiscomp/html/_sources/apps/global_mlc.rst.txt
View File

@@ -36,53 +36,54 @@ Amplitudes
Some general conditions apply for measuring amplitudes:
* Measured amplitude type: MLc.
* Name amplitude type: MLc.
* Expected unit of gain-corrected input data: m/s. Activate response correction
in global bindings in case data are provided in acceleration.
* Components used for amplitude measurements: both horizontal components
separately.
The default parameters for measuring MLc amplitudes can be adjusted by global
The parameters for measuring MLc amplitudes can be adjusted by global
binding parameters:
* Filtering before instrument simulation: :ref:`BW(3,0.5,12) <filter-bw>`,
configurable by :confval:`amplitudes.MLc.preFilter`.
* :term:`Wood-Anderson seismometer` simulation: yes, can be deactivated by
:confval:`amplitudes.MLc.applyWoodAnderson`.
* Characteristics of :term:`Wood-Anderson seismometer`: according to IASPEI
recommendations. Can be adjusted by :confval:`amplitudes.WoodAnderson.gain`,
:confval:`amplitudes.WoodAnderson.T0`, :confval:`amplitudes.WoodAnderson.h`
in global bindings or global module configuration.
* Amplitude scaling: 1, configure by :confval:`amplitudes.MLc.amplitudeScale`
for considering non-default units by magnitude.
* Method applied for measuring amplitudes: absolute maximum, configurable in
global bindings by :confval:`amplitudes.MLc.measureType`.
* Method for combining amplitude measurements: *max* (maximum from both
horizontal components), configurable in global bindings by
:confval:`amplitudes.MLc.combiner`.
.. csv-table::
:widths: 20 25 15 30
:header: Topic, Parameter, Default, Comment
:align: left
:delim: ;
:ref:`Filtering <filter-grammar>`; :confval:`amplitudes.MLc.preFilter`; :ref:`BW(3,0.5,12) <filter-bw>`; Applied before instrument simulation
:term:`Wood-Anderson simulation <Wood-Anderson seismometer>`; :confval:`amplitudes.MLc.applyWoodAnderson`; true; When WA simulation is inactive, measured amplitudes take the units of the gain of the stream on which they were measured.
:term:`Wood-Anderson parameters <Wood-Anderson seismometer>`; :confval:`amplitudes.WoodAnderson.gain`, :confval:`amplitudes.WoodAnderson.T0`, :confval:`amplitudes.WoodAnderson.h`; 2080, 0.8, 0.7; Defaults: see :ref:`IASPEI recommendation <concepts_magnitudes-wa>`.
Amplitude scaling; :confval:`amplitudes.MLc.amplitudeScale`; 1; Apply for scaling measured amplitudes to units required by the magnitude
Amplitude combination; :confval:`amplitudes.MLc.combiner`;max; Method for combining amplitudes measured on both horizontal components
Some additional parameters require you to create an amplitude-type profile for
global binding parameters. Name the profile like the amplitude name, hence MLc:
global binding parameters. Name the profile like the amplitude name, hence MLc
replacing '$name' in the parameters below:
* Time window for measuring signal amplitudes [s]: P pick time + 150 s by
:ref:`scautopick` or distance [km]/3 km/s + 30 s,
the relevant parameters are: :confval:`amplitudes.MLc.signalBegin`,
:confval:`amplitudes.MLc.signalEnd`. :ref:`Time grammar <time-grammar>` may be
applied for begin and end times.
* Time window for measuring noise amplitudes [s]: 30 s before the P pick,
the relevant parameters are: :confval:`amplitudes.MLc.noiseBegin`,
:confval:`amplitudes.MLc.noiseEnd`. :ref:`Time grammar <time-grammar>` may be
applied for begin and end times.
* Minimum SNR: 0, configurable by :confval:`amplitudes.MLc.minSNR`.
* Distance range: 0 - 8 deg, configurable by :confval:`amplitudes.MLc.minDist`,
:confval:`amplitudes.MLc.maxDist`, stations at distances beyond 8 deg will be strictly
ignored.
* Depth range: <= 80 km, can be adjusted and extended by
:confval:`amplitudes.MLc.minDepth` and :confval:`amplitudes.MLc.maxDepth`.
.. csv-table::
:widths: 20 25 15 30
:header: Topic, Parameter, Default, Comment
:align: left
:delim: ;
Most parameters controlling the amplitude measurements are configurable in
global bindings or global module configuration.
Minimum distance; :confval:`amplitudes.$name.minDist`; 0;
Maximum distance; :confval:`amplitudes.$name.maxDist`; 8; Cannot be extended beyond default
Minimum source depth; :confval:`amplitudes.$name.minDepth`; 0; Can be negative
Maximum source depth; :confval:`amplitudes.$name.maxDepth`; 80; Can be extended beyond default
Noise window begin; :confval:`amplitudes.$name.noiseBegin`; -30; (+++)
Noise window end; :confval:`amplitudes.$name.noiseEnd`; -5; (+++)
Signal window begin; :confval:`amplitudes.$name.signalBegin`; -5; (+++)
Signal window end; :confval:`amplitudes.$name.signalEnd`; 150 (+) or distance/3+30 (++); (**+**) When measured by :ref:`scautopick`, (**++**) When measured by :ref:`scamp` or :ref:`scolv` (+++)
Minimum :term:`SNR`; :confval:`amplitudes.$name.minSNR`;not applied; Compares the maximum amplitudes measured within the signal and noise windows
Period range; NA; NA; Period is not measured. A configuration will prevent any MLc amplitude from being measured
Amplitude saturation; :confval:`amplitudes.$name.saturationThreshold`; false; Apply for avoiding measurements on clipped data
Response correction; :confval:`amplitudes.$name.enableResponses`; false; Activate for input units other than nm/s and set :confval:`amplitudes.$name.resp.minFreq`, :confval:`amplitudes.$name.resp.maxFreq`
**(+++)** All values defining the time windows for measuring noise and signal
are relative to P arrival time, read :ref:`Time grammar <time-grammar>`.
The default values are valid for SW-Germany (:cite:t:`stange-2006`).
The Wood-Anderson simulation will convert input velocity data to ground
displacement in mm. The input data may be of a different unit after applying
:confval:`amplitudes.MLc.preFilter`, e.g. when integration is applied, and / or
@@ -95,7 +96,9 @@ amplitude.
.. note::
For comparing MLc amplitudes with :ref:`ML amplitudes <global_ml>` set the
global bindings parameters ::
global bindings parameters
.. code-block:: properties
amplitudes.MLc.preFilter = ""
amplitudes.MLc.combiner = average
@@ -106,54 +109,39 @@ amplitude.
Station magnitudes
------------------
Default properties, most parameters are configurable in global bindings:
Station magnitudes are computed from measured amplitudes by applying a
configurable calibration function when the origin is within depths and distance
constraints. The parameters are configurable in global bindings or by global
module parameters when applying
:ref:`regionalization <concepts-magnitudes-regionalization>`.
* Distance type: hypocentral, epicentral can be selected by :confval:`magnitudes.MLc.distMode`.
* Distance range: 0 - 8 deg, configurable by :confval:`magnitudes.MLc.minDist`,
:confval:`magnitudes.MLc.maxDist`, measurements beyond 8 deg will be strictly
ignored.
* Depth range: <= 80 km, can be extended by :confval:`magnitudes.MLc.maxDepth`.
* Expected amplitude type: MLc, configurable by magnitude alias.
* Expected amplitude unit: millimeter (mm), other units can be assumed by
amplitude scaling with :confval:`amplitudes.MLc.amplitudeScale`.
* Magnitude calibration type: parametric, parametric and non-parametric are
available through :confval:`magnitudes.MLc.calibrationType`.
* Calibration function (see below for the equations), configurable by global bindings
depending on the actual calibration type:
* parametric: :confval:`magnitudes.MLc.parametric.c0`,
:confval:`magnitudes.MLc.parametric.c1`,
:confval:`magnitudes.MLc.parametric.c2`,
:confval:`magnitudes.MLc.parametric.c3`,
:confval:`magnitudes.MLc.parametric.c4`,
:confval:`magnitudes.MLc.parametric.c5`
* A0: :confval:`magnitudes.MLc.A0.logA0`
* Station correction: none, configurable by a magnitude-type profile in global
bindings with :confval:`magnitudes.MLc.offset` or the equivalent in global
module configuration as :confval:`module.trunk.NET.STA.magnitudes.MLc.offset`.
The latter is not supported by :ref:`scconfig` but it reduces the amount of
required bindings.
Station corrections are configurable by a magnitude-type profile named MLc in
global bindings with :confval:`magnitudes.$name.offset` or the equivalent in
global module configuration as :confval:`module.trunk.NET.STA.magnitudes.MLc.offset`.
The latter is not supported by :ref:`scconfig` but it reduces the amount of
required bindings.
The calibration function is considered in one of the forms
* parametric when :confval:`magnitudes.MLc.calibrationType` = "parametric"`:
* Parametric when :confval:`magnitudes.MLc.calibrationType` = "parametric"`:
.. math::
MLc = \log_{10}(A) + c_3 * \log_{10}(r/c_5) + c_2 * (r + c_4) + c_1 + c_0(station)
MLc = \log_{10}(A) + c_7 * e^{c8 * r} + c_6 * h + c_3 * \log_{10}(r / c_5) + c_2 * (r + c_4) + c_1 + c_0(station)
where
* *A*: displacement amplitude measured in unit of mm or as per configuration
* *r*: hypocentral (default) or epicentral distance
* *c1*, *c2*, *c3*, *c4*, *c5*: general calibration parameters
* *c1 - c8*: general calibration parameters
* *c0*: station-specific correction
* *r*: Hypocentral (default) or epicentral distance as configured by
:confval:`magnitudes.MLc.distMode`.
:confval:`magnitudes.MLc.distMode`
* h: (source depth - :confval:`magnitudes.MLc.parametric.H`) when
source depth > :confval:`magnitudes.MLc.parametric.H` but 0 otherwise.
The default values are valid for SW-Germany (:cite:t:`stange-2006`), c6 and H
have been added for supporting dependency on depth (:cite:t:`rhoades-2020`).
The default values are valid for SW-Germany (:cite:t:`stange-2006`). *c6*,
*H* have been added for supporting dependency on depth (:cite:t:`rhoades-2020`)
and *c7*, *c8* for observations at short distances (:cite:t:`luckett2019`).
* log10(A0)-based non-parametric when :confval:`magnitudes.MLc.calibrationType` = "A0"`:
@@ -168,10 +156,89 @@ The calibration function is considered in one of the forms
.. note::
The magnitude calibration function can be regionalized by adjusting global
module configuration parameters in MLc region profiles of
:confval:`magnitudes.MLc.region.*` and in a *MLc* Magnitude type profile e.g.
in :file:`global.cfg`.
* The magnitude calibration function can be regionalized by adjusting global
module configuration parameters in MLc region profiles of
:confval:`magnitudes.MLc.region.*` and in a *MLc* Magnitude type profile
e.g., in :file:`global.cfg`.
Configurable parameters:
.. csv-table::
:widths: 20 25 15 30
:header: Topic, Parameter, Default, Comment
:align: left
:delim: ;
Distance type; :confval:`magnitudes.MLc.distMode`; hypocentral; epicentral or hyocentral can be selected
Minimum distance; :confval:`magnitudes.MLc.minDist`; -1;
Maximum distance; :confval:`magnitudes.MLc.maxDist`; 8; Measurements beyond 8 deg are strictly ignored
Minimum source depth; :confval:`magnitudes.MLc.minDepth`; -10;
Maximum source depth; :confval:`magnitudes.MLc.maxDepth`; 80; Can be extended beyond default
Period range; NA; NA; Period is not measured. A configuration will prevent any MLc magnitude from being computed
Amplitude type;; MLc; Configurable by :ref:`amplitude and magnitude alias <concepts_magnitudes-aliases>`
Amplitude unit;; mm; other units can be assumed by amplitude scaling with :confval:`amplitudes.MLc.amplitudeScale`
Magnitude calibration type; :confval:`magnitudes.MLc.calibrationType`; parametric; parametric and A0 (non-parametric) are available
Linear magnitude correction;:confval:`magnitudes.$name.multiplier`; 1.0; Configure station corrections more conveniently configurable in global module configuration as :confval:`module.trunk.NET.STA.magnitudes.MLc.multiplier`
Constant magnitude correction;:confval:`magnitudes.$name.offset`; 0.0; Configure station corrections more conveniently configurable in global module configuration as :confval:`module.trunk.NET.STA.magnitudes.MLc.offset`
;;;
**parametric** calibration;;; Parameters are used for :confval:`magnitudes.MLc.calibrationType` = parametric
;:confval:`magnitudes.MLc.parametric.c0`;0.0;
;:confval:`magnitudes.MLc.parametric.c1`;0.69;
;:confval:`magnitudes.MLc.parametric.c2`;0.00095;
;:confval:`magnitudes.MLc.parametric.c3`;1.11;
;:confval:`magnitudes.MLc.parametric.c4`;0.0;
;:confval:`magnitudes.MLc.parametric.c5`;1.0;
;:confval:`magnitudes.MLc.parametric.c6`;0.0; see :cite:t:`rhoades-2020`
;:confval:`magnitudes.MLc.parametric.H`;40.0; see :cite:t:`rhoades-2020`
;:confval:`magnitudes.MLc.parametric.c7`;0.0; see :cite:t:`luckett2019`
;:confval:`magnitudes.MLc.parametric.c8`;0.0; see :cite:t:`luckett2019`
;;;
**non-parametric** calibration;;; Parameters are used for :confval:`magnitudes.MLc.calibrationType` = A0
;:confval:`magnitudes.MLc.A0.logA0`;0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85; from :ref:`ML magnitude <global_ml>`
Network magnitude
-----------------
The network magnitude is computed from station magnitudes automatically by
:ref:`scmag` or interactively by :ref:`scolv`.
Originally the median was computed from all station MLc to form the
:term:`network magnitude` MLc. Here, the trimmed mean is applied. Outliers
beyond the outer 12.5% percentiles are removed before forming the mean. The
method can be adjusted in :ref:`scmag` by :confval:`magnitudes.average`.
Moment magnitude
----------------
MLc can be scaled to a moment magnitude, Mw(MLc), by a magnitude-type profile in
global module configuration. Read the
:ref:`Tutorial on moment magnitudes <tutorials_mags_moment>` for the details.
Aliases
-------
Amplitude and magnitude aliases can be created by :confval:`magnitudes.aliases`
and :confval:`amplitudes.aliases`, respectively, in global module configuration
in order to derive other magnitude types from
original amplitudes and magnitudes. The actual amplitude and magnitude
parameters of the aliases will be configured in global bindings or by
magnitude-type profiles in global module configuration. Read the
:ref:`Tutorial on magnitude aliases <tutorials_magnitude-aliases>` for the
details.
Regionalization
---------------
Regionalization may be achieved by a magnitude-type profile in global module
configuration. Read the
:ref:`Tutorial on regionalization <tutorials_magnitude-region>` for the details.
Examples
========
The flexibility of the amplitude and magnitude processing allows for MLc to be
applied in various use cases. Examples are given below.
@@ -207,46 +274,6 @@ applied in various use cases. Examples are given below.
California (*MLc_hb*, :cite:t:`hutton-1987`).
Network magnitude
-----------------
The network magnitude is computed from station magnitudes automatically by
:ref:`scmag` or interactively by :ref:`scolv`.
Originally the median was computed from all station MLc to form the
:term:`network magnitude` MLc. Here, the trimmed mean is applied. Outliers
beyond the outer 12.5% percentiles are removed before forming the mean. The
method can be adjusted in :ref:`scmag` by :confval:`magnitudes.average`.
Moment magnitude
----------------
MLc can be scaled to a moment magnitude, Mw(MLc), by a magnitude-type profile in
global module configuration. Read the
:ref:`Tutorial on moment magnitudes <tutorials_mags_moment>` for the details.
Magnitude aliases
-----------------
Magnitude aliases can be created by :confval:`magnitudes.aliases` in
global module configuration in order to derive other magnitude types from
original amplitudes and magnitudes. The actual amplitude and magnitude
parameters of the aliases will be configured in global bindings or by
magnitude-type profiles in global module configuration. Read the
:ref:`Tutorial on magnitude aliases <tutorials_magnitude-aliases>` for the
details.
Regionalization
---------------
Regionalization may be achieved by a magnitude-type profile in global module
configuration. Read the
:ref:`Tutorial on regionalization <tutorials_magnitude-region>` for the details.
Setup
=====
@@ -256,7 +283,7 @@ Setup
or station bindings one line per parameter can be added to the global module
configuration (:file:`global.cfg`) which takes the form
.. code-block:: params
.. code-block:: properties
module.trunk.NET.STA.amplitudes.MLc.preFilter = value
module.trunk.NET.STA.magnitudes.MLc.parametric.c0 = value
@@ -267,7 +294,7 @@ Setup
for choosing the method to form the
network magnitude from station magnitudes, e.g.
.. code-block:: params
.. code-block:: properties
magnitudes.average = MLc:median
@@ -276,8 +303,3 @@ Setup
MLc become the preferred magnitude.
#. Set defaults/visibility of MLc in :term:`GUI` modules, e.g. :ref:`scolv`
or :ref:`scesv`.
.. note::
All default values for bindings configuration parameters are from
:cite:t:`stange-2006`.

25
share/doc/seiscomp/html/_sources/apps/global_mlv.rst.txt
View File

@@ -9,15 +9,16 @@ Local (Richter) magnitude measured on the vertical component
Description
===========
MLv is the local (Richter) magnitude (:cite:t:`richter-1935`) computed from amplitudes measured on the
vertical component.
MLv is the local (Richter) magnitude (:cite:t:`richter-1935`) computed from
amplitudes measured on the vertical component.
General (default) conditions apply:
* Amplitude unit in SeisComP: **millimeter** (mm) by simulation of a :term:`Wood-Anderson seismometer`.
* Amplitude unit in SeisComP: **millimeter** (mm) by simulation of a
:term:`Wood-Anderson seismometer`.
* Time window: 150 s by :ref:`scautopick` or distance dependent, configurable.
* Default distance range: 0 - 8 deg, maximum is configurable
:confval:`magnitudes.MLv.maxDistanceKm`, measurements beyond 8 deg will be
:confval:`magnitudes.MLv.maxDist`, measurements beyond 8 deg will be
strictly ignored.
* Depth range: no limitation.
@@ -34,7 +35,7 @@ Station Magnitudes
------------------
The individual station MLv is calculated up to the epicentral distance
:confval:`magnitudes.MLv.maxDistanceKm` using the following formula:
:confval:`magnitudes.MLv.maxDist` using the following formula:
.. math::
@@ -48,7 +49,7 @@ bindings or the global module configuration variable
module.trunk.global.magnitudes.MLv.logA0 in :file:`global.cfg`, e.g. ::
module.trunk.global.magnitudes.MLv.logA0 = "0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85"
module.trunk.global.magnitudes.MLv.maxDistanceKm = "-1"
module.trunk.global.magnitudes.MLv.maxDist = 1000km
The logA0 configuration string consists of an arbitrary number of
distance-value pairs separated by semicolons. The distance is in km
@@ -94,24 +95,24 @@ added to the global module configuration (:file:`global.cfg`), e.g.
global:
.. code-block:: params
.. code-block:: properties
module.trunk.global.magnitudes.MLv.logA0 = "0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85"
module.trunk.global.magnitudes.MLv.maxDistanceKm = -1
module.trunk.global.magnitudes.MLv.maxDist = 1000km
or per network:
.. code-block:: params
.. code-block:: properties
module.trunk.GR.magnitudes.MLv.logA0 = "0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85"
module.trunk.GR.magnitudes.MLv.maxDistanceKm = -1
module.trunk.GR.magnitudes.MLv.maxDist = 1000km
or per station:
.. code-block:: params
.. code-block:: properties
module.trunk.GR.MOX.magnitudes.MLv.logA0 = "0:-1.3,60:-2.8,100:-3.0,400:-4.5,1000:-5.85"
module.trunk.GR.MOX.magnitudes.MLv.maxDistanceKm = -1
module.trunk.GR.MOX.magnitudes.MLv.maxDist = 1000km
Set the configuration and calibration parameters in the global bindings. By
default MLv is computed by :ref:`scautopick` and is visible in GUIs.

49
share/doc/seiscomp/html/_sources/apps/global_mn.rst.txt
View File

@@ -67,52 +67,3 @@ Add the Nuttli magnitude type, **MN**, to the range of magnitudes to be calculat
Adjust MN-specific global bindings parameters in the magnitude section and define
the region polygons in the global module configuration (magnitude section).
.. _global_mn_configuration:
Module Configuration
====================
.. note::
**amplitudes.MN.\***
*Amplitude control parameters for MN (Nuttli magnitude).*
.. confval:: amplitudes.MN.velocityModel
Default: ``iasp91``
Type: *string*
The travel time table set compiled for LocSAT. The tables
are located in \"share\/locsat\/tables\/[vmodel].\*\".
.. note::
**magnitudes.MN.\***
*Regionalization of MN (Nuttli magnitude).*
.. confval:: magnitudes.MN.region
Default: ``@DATADIR@/magnitudes/MN/MN.bna``
Type: *path*
The path to the BNA file which defines the valid region
for the MN magnitude. Note that the entire path from
source to receiver must lie entirely within the polygon\(s\).
.. confval:: magnitudes.MN.offsetMw
Type: *double*
The offset applied to the MN network magnitude to
estimate Mw\(MN\). If not configured then no Mw estimation
will be applied.

57
share/doc/seiscomp/html/_sources/apps/global_nonlinloc.rst.txt
View File

@@ -373,9 +373,9 @@ Module Configuration
Default: ``/tmp/sc3.nll``
Type: *path*
Type: *directory*
Defines the output path for all native NonLinLoc input and output files.
Defines the output directory for all native NonLinLoc input and output files.
.. confval:: NonLinLoc.saveInput
@@ -401,9 +401,10 @@ Module Configuration
.. confval:: NonLinLoc.controlFile
Type: *path*
Type: *file*
The default NonLinLoc control file to use.
The default NonLinLoc control file to use. Parameters
therein are overridden per profile.
.. confval:: NonLinLoc.defaultPickError
@@ -473,7 +474,7 @@ Module Configuration
Type: *string*
earthModelID that is stored in the created origin.
Earth model ID stored in the created origin.
.. confval:: NonLinLoc.profile.$name.methodID
@@ -482,14 +483,22 @@ Module Configuration
Type: *string*
methodID that is stored in the created origin.
Method ID stored in the created origin.
.. confval:: NonLinLoc.profile.$name.tablePath
Type: *path*
Path to travel time tables \(grids\).
Path to travel time tables \(grids\) including the
full path and the names of the table files before
the phase name.
Example:
\@DATADIR\@\/nonlinloc\/iasp91\/iasp91 for P and S tables
files
seiscomp\/share\/nonlinloc\/iasp91\/iasp91.[PS].\*
.. confval:: NonLinLoc.profile.$name.stationNameFormat
@@ -506,15 +515,15 @@ Module Configuration
To overcome this limitation this parameter could be set in a more general way, for
example \@NET\@_\@STA\@_\@LOC\@. In this way NonLinLoc will look for
travel time table \(grid\) files of the form: tablePath.P.\@NET\@_\@STA\@_\@LOC\@.time.\*
Where \@NET\@ \@STA\@ \@LOC\@ are just placeholder for the actual codes
Where \@NET\@ \@STA\@ \@LOC\@ are just placeholder for the actual codes.
.. confval:: NonLinLoc.profile.$name.controlFile
Type: *path*
Type: *file*
Control file of the current profile. If not set, the default
control file will be used instead.
Control file of the current profile overriding
parameters of the default control file.
.. confval:: NonLinLoc.profile.$name.transform
@@ -523,10 +532,8 @@ Module Configuration
Type: *string*
Transformation type of the configured region. Supported are
SIMPLE and GLOBAL.
Default: GLOBAL is assumed.
Transformation type of the configured region.
Supported are SIMPLE and GLOBAL.
.. confval:: NonLinLoc.profile.$name.region
@@ -537,11 +544,18 @@ Module Configuration
The original epicentre must be within the region.
If transform is GLOBAL: min_lat, min_lon, max_lat, max_lon.
The values define the geographic corner coordinates. Unit is degree.
The values define the geographic corner coordinates.
Unit: degree.
If transform is SIMPLE: xmin, ymin, xmax, ymax.
The values define the region relative to the configured origin.
Unit is km.
If transform is SIMPLE: min_x, min_y, max_x, max_y.
The values define the region relative to the origin
configured with \"origin\".
Unit: km.
When this parameter is empty, the generated NonLinLoc
configuration is automatically overwritten with
TRANS GLOBAL.
Otherwise TRANS from \"controlFile\" applies.
.. confval:: NonLinLoc.profile.$name.origin
@@ -552,7 +566,6 @@ Module Configuration
Only used for transformation SIMPLE. Expects 2 values: latitude, longitude.
The value define the geographic origin of the area spanned by region.
Unit is degree.
.. confval:: NonLinLoc.profile.$name.rotation
@@ -561,7 +574,7 @@ Module Configuration
Unit: *deg*
Only used for transformation SIMPLE. Defines the rotation around the
origin of the defined region.
Only used for transformation SIMPLE. Defines the
rotation around the origin of the defined region.

6
share/doc/seiscomp/html/_sources/apps/global_recordstream.rst.txt
View File

@@ -77,7 +77,7 @@ Examples
^^^^^^^^
- ``slink://``
- ``slink://geofon.gfz-potsdam.de?timeout=60&retries=5``
- ``slink://geofon.gfz.de?timeout=60&retries=5``
- ``slink://localhost:18000``
.. _rs-arclink:
@@ -106,7 +106,7 @@ Examples
^^^^^^^^
- ``arclink://``
- ``arclink://geofon.gfz-potsdam.de?user=foo&pwd=secret``
- ``arclink://geofon.gfz.de?user=foo&pwd=secret``
- ``arclink://localhost:18042``
- ``arclink://localhost?dump=test.mseed``
@@ -141,7 +141,7 @@ Examples
- ``fdsnws://service.iris.edu``
- ``fdsnws://service.iris.edu:80/fdsnws/dataselect/1/query``
- ``fdsnwss://geofon.gfz-potsdam.de``
- ``fdsnwss://geofon.gfz.de``
.. _rs-file:

84
share/doc/seiscomp/html/_sources/apps/global_stdloc.rst.txt
View File

@@ -13,10 +13,16 @@ StdLoc is a SeisComP locator plugin that combines standard location methods
and was developed with the focus on local seismicity, although the methods
are generic enough to work at larger scales as well.
Plugin
======
To enable StdLoc the plugin ``stdloc`` must be loaded.
To enable StdLoc the plugin ``stdloc`` must be loaded. Add this value to the
global configuration parameter :confval:`plugins` as or similar to
.. code-block:: sh
plugins = ${plugins},stdloc
How does it work?
@@ -25,7 +31,7 @@ How does it work?
The locator can apply a multitude of location methods and it is particularly useful to
combine them to achieve better solutions:
- LeastSquares: this is the classic algorithm that solves the linearized problem of
* LeastSquares: this is the classic algorithm that solves the linearized problem of
travel time residual minimization via iterative least squares. However an initial
location estimate is required. This is the intended method to select when StdLoc
is used in combination with a pick associator: it provides the initial location
@@ -33,11 +39,11 @@ combine them to achieve better solutions:
the location of the origin to be relocated is used as starting estimate.
The configuration doesn't require any mandatory parameters:
.. code-block:: params
.. code-block:: params
method = LeastSquares
method = LeastSquares
- GridSearch: finds the source parameters by evaluating the hypocenter probability
* GridSearch: finds the source parameters by evaluating the hypocenter probability
of each point in a grid and returning the maximum likelihood hypocenter.
Because the search space is fully evaluated there is no need for an initial
location estimate and the location uncertainty is completely known. However the
@@ -47,14 +53,14 @@ combine them to achieve better solutions:
location of the picked stations. The grid points are spaced apart 0.5km
horizontally and 2km vertically.
.. code-block:: params
.. code-block:: params
method = GridSearch
GridSearch.center = auto,auto,15
GridSearch.size = 40,40,30
GridSearch.numPoints = 81,81,16
method = GridSearch
GridSearch.center = auto,auto,15
GridSearch.size = 40,40,30
GridSearch.numPoints = 81,81,16
- GridSearch+LeastSquares: this method can be used in very complex networks where
* GridSearch+LeastSquares: this method can be used in very complex networks where
a bad initial location estimates can get LeastSquares stuck in a local minimum.
The method finds a LeastSquares solution for each cell in a (coarse) grid, using
the cell centroid as initial location estimate. If finally returns the maximum
@@ -63,14 +69,14 @@ combine them to achieve better solutions:
The following example configuration returns the best among the 75 (5x5x3)
LeastSquares solutions, computed for every point in the grid.
.. code-block:: params
.. code-block:: params
method = GridSearch+LeastSquares
GridSearch.center = auto,auto,15
GridSearch.size = 100,100,30
GridSearch.numPoints = 5,5,3
method = GridSearch+LeastSquares
GridSearch.center = auto,auto,15
GridSearch.size = 100,100,30
GridSearch.numPoints = 5,5,3
- OctTree: this method produces similar results to GridSearch but it is extremely
* OctTree: this method produces similar results to GridSearch but it is extremely
faster and it follows the NonLinLoc approach. The OctTree search starts by
evaluating the hypocenter probability of each cell in a grid, computed as the
probability density at the cell center coordinates times the cell volume. The
@@ -87,20 +93,20 @@ combine them to achieve better solutions:
The following example is a plausible configuration for the entire Swiss
network:
.. code-block:: params
.. code-block:: params
method = OctTree
GridSearch.center = 47.0,8.5,50
GridSearch.size = 700,700,100
GridSearch.numPoints = 21,21,11
OctTree.maxIterations = 100000
OctTree.minCellSize = 0.001
method = OctTree
GridSearch.center = 47.0,8.5,50
GridSearch.size = 700,700,100
GridSearch.numPoints = 21,21,11
OctTree.maxIterations = 100000
OctTree.minCellSize = 0.001
However in this example we are at the size limit for a flat earth study
geometry and for bigger regions `GridSearch.center` should be set to
`auto` and `GridSearch.size` to a smaller size.
- OctTree+LeastSquares: this method allows the OctTree search to find the
* OctTree+LeastSquares: this method allows the OctTree search to find the
maximum probability cell in the network and uses that as the initial
location estimate for LeastSquares.
This method is intended to be used in :ref:`screloc` or :ref:`scolv` to
@@ -108,14 +114,14 @@ combine them to achieve better solutions:
The following example is a plausible configuration for the entire Swiss
network:
.. code-block:: params
.. code-block:: params
method = OctTree+LeastSquares
GridSearch.center = 47.0,8.5,50
GridSearch.size = 700,700,100
GridSearch.numPoints = 21,21,11
OctTree.maxIterations = 10000
OctTree.minCellSize = 1.0
method = OctTree+LeastSquares
GridSearch.center = 47.0,8.5,50
GridSearch.size = 700,700,100
GridSearch.numPoints = 21,21,11
OctTree.maxIterations = 10000
OctTree.minCellSize = 1.0
However in this example we are at the size limit for a flat earth study
geometry and for bigger regions `GridSearch.center` should be set to
@@ -134,9 +140,9 @@ When dealing with very local seismicity (few kilometers or hundreds of meters)
simplifications that are common for regional seismicity have to be removed.
In particular the locator should take into consideration:
- station elevation and even negative elevation (e.g. borehole sensors)
- earthquake location can be above a seismic sensor (e.g. borehole sensors)
- possible negative earthquake depth (above surface)
* Station elevation and even negative elevation (e.g. borehole sensors)
* Earthquake location can be above a seismic sensor (e.g. borehole sensors)
* Possible negative earthquake depth (above surface).
More importantly the travel time tables used by the locator must be able to take
into consideration all the above too.
@@ -195,6 +201,8 @@ Module Configuration
Type: *string*
Values: ``LeastSquares,GridSearch,OctTree,GridSearch+LeastSquares,OctTree+LeastSquares``
The location method to use: LeastSquares, GridSearch,
OctTree, GridSearch+LeastSquares or OctTree+LeastSquares.
@@ -277,6 +285,8 @@ Module Configuration
Type: *double*
Range: ``0.5:1.0``
Confidence level, between 0.5 and 1.0, used in
computing the hypocenter confidence ellipsoid.
@@ -343,6 +353,8 @@ Module Configuration
Type: *string*
Values: ``L1,L2``
The type of misfit to use, from which
the likelihood function is derived: L1 or L2 norm.
L1 is less sensitive to outliers and so more
@@ -450,6 +462,8 @@ Module Configuration
Type: *string*
Values: ``LSMR,LSQR``
Algorithm to use: either LSMR or LSQR.

1
share/doc/seiscomp/html/_sources/apps/import_inv.rst.txt
View File

@@ -22,7 +22,6 @@ an input format such as
:delim: ;
scml; :ref:`scml2inv`; :ref:`SeisComP inventory XML <concepts_inventory>`, schema: :file:`$SEISCOMP_ROOT/share/xml/`
sc3; :ref:`sc32inv`; Alias for scml for backwards compatibility to SeisComP3
arclink; :ref:`arclink2inv`; Arclink inventory XML
dlsv; :ref:`dlsv2inv`; `dataless SEED <http://www.iris.edu/data/dataless.htm>`_
fdsnxml; :ref:`fdsnxml2inv`; `FDSN StationXML <http://www.fdsn.org/xml/station/>`_

63
share/doc/seiscomp/html/_sources/apps/inv2dlsv.rst.txt
View File

@@ -1,63 +0,0 @@
.. highlight:: rst
.. _inv2dlsv:
########
inv2dlsv
########
**Converts SC3 inventory XML to dataless SEED.**
Description
===========
inv2dlsv is a simple filter that converts inventory in |scname| XML (:term:`SCML`)
format from stdin (or a file) to dataless SEED on stdout (or a file). It does
not support processing of input XML such as extraction of networks or channels.
To accomplish this task, combine :program:`inv2dlsv` with :ref:`invextr`.
.. note::
Conversion of dataless SEED to |scname| XML is provided by :ref:`dlsv2inv`.
Examples
========
.. note::
"-" can always be used as filename to refer to the standard input/output channel.
#. Convert an inventory XML file to a dataless SEED file
.. code-block:: sh
inv2dlsv inv.xml inv.seed
#. Convert an inventory XML file to a compressed dataless SEED file
.. code-block:: sh
inv2dlsv inv.xml | gzip > inv.seed.gz
#. Convert a subset of an inventory XML using :ref:`invextr`.
.. code-block:: sh
invextr --chans "*MORC*" inv.xml | inv2dlsv - inv.seed
Command-Line Options
====================
.. program:: inv2dlsv
:program:`inv2dlsv [in_xml [out_dataless]]`
If in_xml is not given, stdin is used. If out_dataless is not given,
stdout is used.

85
share/doc/seiscomp/html/_sources/apps/invextr.rst.txt
View File

@@ -6,7 +6,7 @@
invextr
#######
**Extract channels from inventory.**
**Extract and clean or remove streams from inventory.**
Description
@@ -14,31 +14,37 @@ Description
invextr reads and modifies inventory XML provided as file or on stdin:
* Extract or remove networks, stations and channels based on
* Extract or remove networks, stations, sensor locations and channels based on
* channel IDs
* geographic region
* time
* stream IDs,
* geographic region,
* time.
* Clean inventories from unused objects such as data loggers, sensors or
instrument responses.
* Clean inventories from unreferenced objects such as data loggers, sensors or
instrument responses when extracting.
.. note::
Cleaning inventory may also be achieved by merging inventories with
:ref:`scinv`.
The important parameters are:
* Channel ID list (required)
* Stream ID list (:option:`--chans`, :option:`--nslc`). Without a stream ID,
only unreferenced objects are removed when extracting.
* Input file or stdin
* Output file or stdout
* Region bounding box (optional)
* Output file (:option:`--output`) or stdout
* Region bounding box (:option:`--region`, optional)
whereas the output file defaults to stdout and the input file to
where the output XML defaults to stdout and the input file to
stdin if not given.
The optional region box will be used to filter the read inventory based on the
coordinates of sensor locations. Only stations with sensor locations within the
region will be considered. All others will be ignored.
A channel ID is a simple string that is matched against the final channel ID
in the inventory. This final channel ID is constructed by joining the codes of
A stream ID is a simple string that is matched against the final stream ID
in the inventory. This final stream ID is constructed by joining the codes of
all stages with a dot where the stages are network, station, location and
channel.
@@ -48,7 +54,8 @@ The content of the resulting inventory may be listed using :ref:`scinv`.
Examples
--------
Suppose an inventory with network GE, a station MORC and several channels:
Suppose an inventory with network GE, a station MORC with one sensor locations
and several channels:
.. code-block:: sh
@@ -62,11 +69,18 @@ Suppose an inventory with network GE, a station MORC and several channels:
channel LHN ID: GE.MORC..LHN
channel LHE ID: GE.MORC..LHE
* The IDs are matched against streams passed with --chans.
* Just clean inventory from unreferenced objects such as data loggers, sensors
or instrument responses.
.. code-block:: sh
invextr --chans "GE*" inv.xml
invextr inventory.xml -o inventory-cleaned.xml
* The IDs are matched against streams passed with :option:`--chans`:
.. code-block:: sh
invextr --chans "GE*" inventory.xml
All streams are passed and nothing is filtered because GE* matches all
available IDs and region filter is not used. Since :file:`inv.xml` only
@@ -75,7 +89,7 @@ Suppose an inventory with network GE, a station MORC and several channels:
.. code-block:: sh
invextr -r 0,-180,90,180 inv.xml
invextr -r 0,-180,90,180 inventory.xml
All streams located in the northern hemisphere are passed as commanded by the
region bounding box.
@@ -84,33 +98,33 @@ Suppose an inventory with network GE, a station MORC and several channels:
.. code-block:: sh
invextr --chans "*MORC*" inv.xml
invextr --chans "*MORC*" inventory.xml
* Everything is filtered because GE.MORC does not match with any ID. To make it
work, an asterisk needs to be appended: GE.MORC* or GE.MORC.*.
.. code-block:: sh
invextr --chans "GE.MORC" inv.xml
invextr --chans "GE.MORC" inventory.xml
* To extract all vertical components, use:
.. code-block:: sh
invextr --chans "*Z" inv.xml
invextr --chans "*Z" inventory.xml
* To extract BHN and LHZ, use:
.. code-block:: sh
.. code-block:: sh
invextr --chans "*BHN,*LHZ" inv.xml
invextr --chans "*BHN,*LHZ" inventory.xml
* To remove all HH and SH channels, use:
.. code-block:: sh
invextr --rm --chans "*HH?,*SH?" inv.xml
invextr --rm --chans "*HH?,*SH?" inventory.xml
.. _invextr_configuration:
@@ -239,11 +253,15 @@ Extract
.. option:: --chans arg
A comma separated list of channel IDs to extract
which can contain wildcards. Default: \*.\*.\*.\* meaning
all streams.
A comma separated list of streams to extract or remove \(\-\-rm\)
which can contain wildcards. Avoiding confusion with files
names due to SHELL extension requires to enclose stream codes
by quotes. Default: \*.\*.\*.\* meaning all streams. Unreferenced
sensors, data loggers and resonses are removed when extracting.
A comma separated list of channel IDs to extract which may
contain wildcards. Default: \*.\*.\*.\* meaning all streams.
Example: invextr \-\-chans \"GE.\*.\*.BHZ,GE.MORC.\*.\*\" inv.xml
Example: invextr \-\-chans \"GE.\*.\*.BHZ,GE.MORC.\*.\*\" inventory.xml
.. option:: --nslc arg
@@ -253,7 +271,7 @@ Extract
.. option:: -r, --region arg
Filter streams by geographic region given as
\"South, East, North, West\". Region is unused by default.
\"South,West,North,East\". Region is unused by default.
.. option:: --rm arg
@@ -262,7 +280,16 @@ Extract
Example: invextr \-\-rm \-\-chans \"GE.\*\" inv.xml
Output
------
.. option:: -f, --formatted
Enables formatted XML output.
Enable formatted XML output.
.. option:: -o, --output
Name of output file. If not given or '\-', output is sent to
stdout.

2
share/doc/seiscomp/html/_sources/apps/kernel.rst.txt
View File

@@ -28,7 +28,7 @@ Module Configuration
.. note::
kernel is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
kernel is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
| :file:`etc/defaults/kernel.cfg`

27
share/doc/seiscomp/html/_sources/apps/msrtsimul.rst.txt
View File

@@ -68,7 +68,7 @@ etc. will run with current system time. The historic mode allows to process wave
with the stream inventory valid at the time when the data were recorded including
streams closed at current time.
.. warning ::
.. warning::
When repeating historic playbacks, the waveforms are fed multiple times to the
seedlink buffer and the resulting picks are also repeated with the same pick
@@ -108,7 +108,7 @@ Examples
.. code-block:: sh
$ msrtsimul -v miniSEED-file
msrtsimul -v miniSEED-file
#. Playback miniSEED waveforms in historic mode. This may require :ref:`scautopick`
to be started with the option *playback*:
@@ -124,22 +124,6 @@ Examples
msrtsimul -v --seedlink seedlink-test miniSEED-file
.. _msrtsimul_configuration:
Module Configuration
====================
| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/msrtsimul.cfg`
| :file:`etc/global.cfg`
| :file:`etc/msrtsimul.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/msrtsimul.cfg`
msrtsimul inherits :ref:`global options<global-configuration>`.
Command-Line Options
====================
@@ -175,10 +159,14 @@ Playback
.. option:: -j, --jump float
Unit: *minutes*
Minutes to skip at the beginning.
.. option:: -m, --mode string
Values: ``realtime,historic``
Playback mode: choose between 'realtime' and 'historic'
.. option:: --seedlink string
@@ -197,5 +185,6 @@ Playback
.. option:: -u, --unlimited
Allow miniSEED records which are not 512 bytes.
Allow miniSEED records which are not 512 bytes. By default
seedlink supports 512 bytes only.

58
share/doc/seiscomp/html/_sources/apps/ql2sc.rst.txt
View File

@@ -12,10 +12,10 @@ ql2sc
Description
===========
ql2sc manages the import of SeisComP objects from one or several QuakeLink servers
into a SeisComP system in real time. Like :ref:`scimex` but contrary to
:ref:`scimport` the exchange of the SeisComP objects is event based. This means no
messages will be exchanged until the exporting system has produced an event.
ql2sc manages the import of SeisComP objects from one or several QuakeLink
servers into a SeisComP system in real time. Like :ref:`scimex` but contrary to
:ref:`scimport` the exchange of the SeisComP objects is event based. This means
no messages will be exchanged until the exporting system has produced an event.
The user may control at various levels which information to import. Whenever
possible server-side filters should be preferred to reduce both the network
@@ -138,11 +138,11 @@ By default we route:
* Picks and Amplitudes to the ``IMPORT_GROUP`` group to prevent processing by
the local locator and amplitude processor
* Origins (including its StationMagnitude and Magnitude children) to the
``LOCATION`` to allow event association.
* FocalMechanisms to the ``FOCMECH`` group to trigger processing by specialized
applications, e.g., graphical user interfaces for strong motion analysis or
tsunami risk assessment.
* Origins and FocalMechanisms to the ``LOCATION`` group to allow event association.
A common deviation from the default is to route FocalMechanisms to the ``FOCMECH``
group to trigger processing by specialized applications, e.g., graphical user
interfaces for strong motion analysis or tsunami risk assessment.
We don't route events at all. With the help of :ref:`scevent` locations are
either associated to existing events or will create new events with local
@@ -262,7 +262,7 @@ happen that the imported event ID is different from the event ID of the local
system. The input host configuration parameter :confval:`syncEventAttributes`
controls that behaviour. It is set to true by default which means that imported
event attributes are going to be imported as well. ql2sc does not update
directly the attributes but commandates scevent in as many cases as possible
directly the attributes but commands scevent in as many cases as possible
to do so. To find the matching local event it takes the first occurrence which
has associated the currently imported preferred origin.
@@ -345,15 +345,6 @@ ql2sc inherits :ref:`global options<global-configuration>`.
Number of seconds to fetch missed updates on start up.
.. confval:: cacheSize
Default: ``5000``
Type: *int*
Number of public objects to cache.
.. confval:: batchSize
Default: ``2000``
@@ -488,7 +479,7 @@ ql2sc inherits :ref:`global options<global-configuration>`.
.. confval:: host.$name.keepAlive
Default: ``false``
Default: ``true``
Type: *boolean*
@@ -502,12 +493,20 @@ ql2sc inherits :ref:`global options<global-configuration>`.
Type: *string*
SQL like WHERE clause to filter the result set.
Server\-side SQL like WHERE clause to filter the result set. The actual
available parameters depend on the QuakeLink server version. Use
'telnet host port' followed by 'help select' to connect to a QuakeLink
server an request available parameters.
clause :\= condition[ AND\|OR [\(]clause[\)]] __
condition :\= MAG\|DEPTH\|LAT\|LON\|PHASES\|OTIME\|UPDATED [op float\|time]\|[IS [NOT] NULL] __
op :\= \=\|>\|>\=\|<\|<\=\|eq\|gt\|ge\|lt\|ge __
time :\= %Y,%m,%d[,%H,%M,%S,%f]
clause :\= condition[ AND\|OR [\(]clause[\)]]
condition :\= MAG\|DEPTH\|LAT\|LON\|PHASES\|DIST\(lat,lon\) op {float} \|
DIST\(lat,lon\) IN [{float}, {float}] \|
UPDATED\|OTIME op time \|
AGENCY\|AUTHOR\|STATUS\|ESTATUS\|EMODE\|TYPE\|CTYPE\|DTYPE\|REGION\|MAG_T op 'string' \|
MAG\|DEPTH\|LAT\|LON\|PHASES\|OTIME\|UPDATED IS [NOT] NULL
FELT\|NOT FELT
op :\= \=\|\!\=\|>\|>\=\|<\|<\=\|eq\|gt\|ge\|lt\|ge
time :\= %Y,%m,%d[,%H,%M,%S[,%f]]
.. confval:: host.$name.routingTable
@@ -700,18 +699,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.
@@ -721,8 +724,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

25
share/doc/seiscomp/html/_sources/apps/scalert.rst.txt
View File

@@ -117,7 +117,7 @@ scalert inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.pick
Type: *string*
Type: *file*
The script to be called when a pick
arrives. Network\-, station code, pick publicID are passed
@@ -126,7 +126,7 @@ scalert inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.amplitude
Type: *string*
Type: *file*
The script to be called when an amplitude
arrives. Network\-, station code, amplitude and amplitude
@@ -135,7 +135,7 @@ scalert inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.alert
Type: *string*
Type: *file*
The script to be called when a preliminary
origin arrives. Latitude and longitude are passed as
@@ -144,7 +144,7 @@ scalert inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.event
Type: *string*
Type: *file*
The script to be called when an event has been
declared. The message string, a flag \(1\=new event,
@@ -267,6 +267,7 @@ Generic
Overrides configuration parameter :confval:`firstNew`.
Verbosity
---------
@@ -318,18 +319,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.
@@ -339,8 +344,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -377,21 +387,26 @@ Alert
.. option:: --amp-type arg
Default: ``snr``
Specify the amplitude type to listen to.
.. option:: --amp-script arg
Overrides configuration parameter :confval:`scripts.amplitude`.
.. option:: --alert-script arg
Overrides configuration parameter :confval:`scripts.alert`.
.. option:: --event-script arg
Overrides configuration parameter :confval:`scripts.event`.
Cities
------
@@ -399,11 +414,13 @@ Cities
Overrides configuration parameter :confval:`poi.maxDist`.
.. option:: --min-population arg
Overrides configuration parameter :confval:`poi.minPopulation`.
Debug
-----

27
share/doc/seiscomp/html/_sources/apps/scamp.rst.txt
View File

@@ -336,18 +336,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.
@@ -357,8 +361,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
.. option:: --test
@@ -403,12 +412,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -424,7 +433,8 @@ Input
.. option:: --ep file
Defines an event parameters XML file to be read and processed. This
Defines an event parameters XML file to be read and
processed. Use '\-' to read from stdin. This
implies offline mode and only processes all origins contained
in that file. It computes amplitudes for all picks associated
with an origin and outputs an XML file that additionally
@@ -464,3 +474,12 @@ Reprocess
Send amplitude updates to the messaging otherwise an XML
document will be output.
Output
------
.. option:: -f, --formatted
Use formatted XML output along with '\-\-ep'. Otherwise XML
is unformatted.

11
share/doc/seiscomp/html/_sources/apps/scardac.rst.txt
View File

@@ -447,46 +447,57 @@ Collector
Overrides configuration parameter :confval:`archive`.
.. option:: --threads arg
Overrides configuration parameter :confval:`threads`.
.. option:: -j, --jitter arg
Overrides configuration parameter :confval:`jitter`.
.. option:: --nslc arg
Overrides configuration parameter :confval:`nslcFile`.
.. option:: --start arg
Overrides configuration parameter :confval:`filter.time.start`.
.. option:: --end arg
Overrides configuration parameter :confval:`filter.time.end`.
.. option:: --include arg
Overrides configuration parameter :confval:`filter.nslc.include`.
.. option:: --exclude arg
Overrides configuration parameter :confval:`filter.nslc.exclude`.
.. option:: --deep-scan
Overrides configuration parameter :confval:`mtime.ignore`.
.. option:: --modified-since arg
Overrides configuration parameter :confval:`mtime.start`.
.. option:: --modified-until arg
Overrides configuration parameter :confval:`mtime.end`.
.. option:: --generate-test-data arg
Do not scan the archive but generate test data for each

235
share/doc/seiscomp/html/_sources/apps/scautoloc.rst.txt
View File

@@ -24,8 +24,8 @@ but can also be provided by other means.
scautoloc normally runs as a :ref:`daemon <sec-scautoloc-daemon-mode>`
continuously reading picks and amplitudes and processing them in real time. An
:ref:`offline mode <sec-scautoloc-offline-mode>` is available as well, e.g., for
playbacks on demand.
:ref:`offline mode and non-real-time processing <sec-scautoloc-offline-mode>`
are available as well, e.g., for playbacks on demand.
Location procedure
@@ -346,77 +346,124 @@ the server. Log files are written as usual. This mode can be used to test
new parameter settings before implementation in the real-time system. It also
provides a simple way to log picks from a real-time system to the pick log.
Real-Time Proessing
===================
.. _sec-scautoloc-daemon-mode:
Daemon Mode
===========
-----------
For running scautoloc continuously in the background as a daemon it must be
enabled and started:
For running scautoloc continuously in real time and in the background as a
daemon it must be enabled and started:
.. code-block:: sh
seiscomp enable scautoloc
seiscomp start scautoloc
On-demand proessing
-------------------
.. _sec-scautoloc-offline-mode:
You may execute scautoloc on the command-line on demand giving the
possibility to use specific command-line options.
Offline Mode
============
scautoloc normally runs as a daemon in the background, continuously reading
picks and amplitudes and processing them in real time. However, scautoloc
may also be operated in offline mode. This is useful for debugging. Offline
mode is activated by adding the command-line parameter :option:`--ep` or
:option:`--offline`. When operated in offline mode,
scautoloc will not connect to the messaging. Instead, it reads picks from a
:term:`SCML` file provided with :option:`--ep` or from standard input in the pick file
format. The station coordinates are read from the inventory in the database or
from the file either defined in :confval:`autoloc.stationLocations` or
-\\-station-locations .
Example for entries in a pick file
Example:
.. code-block:: sh
2008-09-25 00:20:16.6 SK LIKS EH __ 4.6 196.953 1.1 A [id]
2008-09-25 00:20:33.5 SJ BEO BH __ 3.0 479.042 0.9 A [id]
2008-09-25 00:21:00.1 CX MNMCX BH __ 21.0 407.358 0.7 A [id]
2008-09-25 00:21:02.7 CX HMBCX BH __ 14.7 495.533 0.5 A [id]
2008-09-24 20:53:59.9 IA KLI BH __ 3.2 143.752 0.6 A [id]
2008-09-25 00:21:04.5 CX PSGCX BH __ 7.1 258.407 0.6 A [id]
2008-09-25 00:21:09.5 CX PB01 BH __ 10.1 139.058 0.6 A [id]
2008-09-25 00:21:24.0 NU ACON SH __ 4.9 152.910 0.6 A [id]
2008-09-25 00:22:09.0 CX PB04 BH __ 9.0 305.960 0.6 A [id]
2008-09-25 00:19:13.1 GE BKNI BH __ 3.3 100.523 0.5 A [id]
2008-09-25 00:23:47.6 RO IAS BH __ 3.1 206.656 0.3 A [id]
2008-09-25 00:09:12.8 GE JAGI BH __ 31.9 1015.304 0.8 A [id]
2008-09-25 00:25:10.7 SJ BEO BH __ 3.4 546.364 1.1 A [id]
scautoloc --debug
.. _sec-scautoloc-offline-mode:
Non-real Time Processing
========================
scautoloc normally runs in real time as a daemon in the background, continuously
receiving and processing picks and amplitudes from messaging in real time.
However, scautoloc may also be operated in non-real-time/offline mode. This is
useful for fast playbacks or debugging and tuning. Non-real-time processing is
activated by adding the command-line parameter :option:`--ep` and, for
offline mode, :option:`--offline`. Then,
scautoloc will not connect to the messaging. Instead, it reads picks from a
:term:`SCML` file provided with :option:`--ep` or from standard input in the
*pick file format*. The station coordinates are read from the inventory in the
database or from the file either defined in :confval:`autoloc.stationLocations`
or :option:`--station-locations`.
.. note::
When picks are created in real time, they are generally not in order of pick
time but in the order of creation time because of data latencies. Therefore,
processing of picks created in real time may result in differences to
playbacks of picks created in non-real-time playbacks.
Non-real-time playback from XML
-------------------------------
Non-real-time playback may be based on picks and amplitudes (snr and mb) in an
:term:`SCML` file. The database must be specified explicitly since it cannot be
received from the messaging. All picks, amplitudes and resulting origins are
output to stdout in SCML which can be redirected to an unformatted or formatted
file, :file:`origins.xml`.
Example:
.. code-block:: sh
scautoloc -d [database] --ep picks.xml -f > origins.xml
Offline mode
------------
Offline mode works with :option:`--offline` and picks are to be provided in the
*pick file format*:
.. code-block:: sh
2008-09-25 00:20:16.6 SK LIKS EH __ 4.6 196.953 1.1 A [id]
2008-09-25 00:20:33.5 SJ BEO BH __ 3.0 479.042 0.9 A [id]
2008-09-25 00:21:00.1 CX MNMCX BH __ 21.0 407.358 0.7 A [id]
2008-09-25 00:21:02.7 CX HMBCX BH __ 14.7 495.533 0.5 A [id]
2008-09-24 20:53:59.9 IA KLI BH __ 3.2 143.752 0.6 A [id]
2008-09-25 00:21:04.5 CX PSGCX BH __ 7.1 258.407 0.6 A [id]
2008-09-25 00:21:09.5 CX PB01 BH __ 10.1 139.058 0.6 A [id]
2008-09-25 00:21:24.0 NU ACON SH __ 4.9 152.910 0.6 A [id]
2008-09-25 00:22:09.0 CX PB04 BH __ 9.0 305.960 0.6 A [id]
2008-09-25 00:19:13.1 GE BKNI BH __ 3.3 100.523 0.5 A [id]
2008-09-25 00:23:47.6 RO IAS BH __ 3.1 206.656 0.3 A [id]
2008-09-25 00:09:12.8 GE JAGI BH __ 31.9 1015.304 0.8 A [id]
2008-09-25 00:25:10.7 SJ BEO BH __ 3.4 546.364 1.1 A [id]
where [id] is a placeholder for the real pick id which has been omitted in this
example.
.. note:: In the above example some of the picks are not in right order of
time because of data latencies. In offline mode scautoloc will not connect to
the database, in consequence the station coordinates cannot be read from the
database and thus have to be supplied via a file. The station coordinates file
has a simple format with one line per entry, consisting of 5 columns: network
code, station code, latitude, longitude, elevation (in meters). Example:
In offline mode scautoloc will not connect to the database. In consequence
station coordinates cannot be read from the database and must be supplied via
a station coordinates file. This file has a simple format with one line per
station, consisting of 5 columns:
network code, station code, latitude, longitude, elevation (in meters).
Sensor locations are not treated separately.
.. code-block:: sh
Example of a station coordinates file:
GE APE 37.0689 25.5306 620.0
GE BANI -4.5330 129.9000 0.0
GE BKB -1.2558 116.9155 0.0
GE BKNI 0.3500 101.0333 0.0
GE BOAB 12.4493 -85.6659 381.0
GE CART 37.5868 -1.0012 65.0
GE CEU 35.8987 -5.3731 320.0
GE CISI -7.5557 107.8153 0.0
.. code-block:: sh
The location of this file is specified in :confval:`autoloc.stationLocations` or on the
command line using -\\-station-locations
GE APE 37.0689 25.5306 620.0
GE BANI -4.5330 129.9000 0.0
GE BKB -1.2558 116.9155 0.0
GE BKNI 0.3500 101.0333 0.0
GE BOAB 12.4493 -85.6659 381.0
GE CART 37.5868 -1.0012 65.0
GE CEU 35.8987 -5.3731 320.0
GE CISI -7.5557 107.8153 0.0
The name of this file is configured in :confval:`autoloc.stationLocations` or
passed on the command line using :option:`--station-locations`.
scautopick and scautoloc Interaction
@@ -427,7 +474,7 @@ chain, :ref:`scautopick` and :program:`scautoloc`, only work together if the
information needed by scautoloc can be supplied by :ref:`scautopick` and received
by :program:`scautoloc` through the message group defined by
:confval:`connection.subscription` or through :term:`SCML` (:option:`--ep`,
:option:`-i`). This document explains current
:option:`--input`). This document explains current
implicit dependencies between these two utilities and is meant as a guide
especially for those who plan to modify or replace one or both of these
utilities by own developments.
@@ -598,7 +645,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``86400``
Type: *integer*
Type: *int*
Unit: *s*
@@ -609,7 +656,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``3600``
Type: *integer*
Type: *int*
Unit: *s*
@@ -648,7 +695,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``6``
Type: *integer*
Type: *int*
Minimum number of phases for reporting origins.
@@ -693,7 +740,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``15``
Type: *integer*
Type: *int*
If the station count for stations at < 105 degrees distance
exceeds this number, no picks at > 105 degrees will be
@@ -727,7 +774,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``@DATADIR@/scautoloc/grid.conf``
Type: *path*
Type: *file*
Location of the grid file for nucleating origins.
@@ -736,14 +783,14 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``@DATADIR@/scautoloc/station.conf``
Type: *path*
Type: *file*
Location of the station configuration file for nucleating origins.
.. confval:: autoloc.stationLocations
Type: *path*
Type: *file*
The station file to be used when in offline mode.
If no file is given the database is used. An example is given
@@ -845,7 +892,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``@LOGDIR@/autoloc-picklog``
Type: *string*
Type: *file*
Location of pick log file containing information about received
picks. Activate \"pickLogEnable\" for writing the files.
@@ -896,7 +943,7 @@ scautoloc inherits :ref:`global options<global-configuration>`.
Default: ``4``
Type: *integer*
Type: *int*
Minimum number of XXL picks for forming an origin.
Must be >\= 4.
@@ -1034,18 +1081,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.
@@ -1055,8 +1106,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -1124,9 +1180,9 @@ Input
.. option:: --ep file
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 in XML
to stdout.
offline processing. Use '\-' to read from stdin. The
database connection is not received from messaging and must
be provided. Results are sent in XML to stdout.
Settings
@@ -1158,84 +1214,135 @@ Settings
.. option:: --default-depth arg
Default: ``10``
Default depth for comparison with the depth after locating.
.. option:: --max-sgap arg
Default: ``360``
Maximum secondary azimuthal gap for an origin to be reported.
The secondary gap is the maximum of the sum of 2 station gaps.
.. option:: --max-rms arg
Default: ``3.5``
Maximum travel\-time RMS for a location to be reported.
.. option:: --max-residual arg
Default: ``3``
Maximum travel\-time residual \(unweighted\) for a pick at a
station to be used.
.. option:: --max-station-distance arg
Default: ``5``
Maximum distance of stations to be used.
.. option:: --max-nucleation-distance-default arg
Default: ``180``
Default maximum distance of stations to be used for nucleating new origins.
.. option:: --min-pick-affinity arg
Default: ``0.05``
.. option:: --min-phase-count arg
Default: ``4``
Minimum number of picks for an origin to be reported.
.. option:: --min-score arg
Default: ``8``
Minimum score for an origin to be reported.
.. option:: --min-pick-snr arg
Default: ``3``
Minimum SNR for a pick to be processed.
.. option:: --threshold-xxl arg
Default: ``10000000``
An amplitude exceeding this threshold will flag the pick as XXL.
.. option:: --min-phase-count-xxl arg
Default: ``4``
Minimum number of picks for an XXL origin to be reported.
.. option:: --max-distance-xxl arg
Default: ``15``
.. option:: --min-sta-count-ignore-pkp arg
Default: ``15``
Minimum station count for which we ignore PKP phases.
.. option:: --min-score-bypass-nucleator arg
Default: ``40``
Minimum score at which the nucleator is bypassed.
.. option:: --keep-events-timespan arg
Default: ``86400``
The timespan to keep historical events.
.. option:: --cleanup-interval arg
Default: ``3600``
The object cleanup interval in seconds.
.. option:: --max-age arg
Default: ``3784320000``
During cleanup all pick objects older than maxAge \(in seconds\)
are removed \(maxAge \=\= 0 disables cleanup\).
.. option:: --wakeup-interval arg
Default: ``5``
Unit: *s*
The interval in seconds to check pending operations.
.. option:: --dynamic-pick-threshold-interval arg
Default: ``60``
The interval in seconds in which to check for extraordinarily
high pick activity, resulting in a dynamically increased
pick threshold.
Output
------
.. option:: -f, --formatted
Use formatted XML output along with '\-\-ep'. Otherwise XML
is unformatted.

95
share/doc/seiscomp/html/_sources/apps/scautopick.rst.txt
View File

@@ -338,13 +338,12 @@ scautopick inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``AIC,BK,GFZ``
The re\-picker to use. By default only simple detections
are emitted as picks. To enable re\-picking on a time window around
the detection, an algorithm \(plugin\) can be defined with this parameter.
Currently available: \"AIC\", \"BK\" or
\"GFZ\".
More options may be available by plugins. Configure related
parameters in global bindings.
@@ -376,10 +375,12 @@ scautopick inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``S-L2,S-V``
The secondary picker to use, e.g., for picking S\-phases.
Currently available is: \"S\-L2\". More options may
be available by plugins. Configure related parameters
in global bindings.
More options may be available by plugins. Configure related
parameters in global bindings.
.. confval:: killPendingSPickers
@@ -416,16 +417,30 @@ scautopick inherits :ref:`global options<global-configuration>`.
with a non\-negative value.
.. confval:: simplifiedIDs
Default: ``false``
Type: *boolean*
If enabled then simplified pick and amplitude IDs will be created.
Rather than the configured publicID pattern, the following pattern
will be used: \"%Y%m%d.%H%M%S.%f\-\@net.sta.loc.cha\@\".
.. confval:: fx
Type: *string*
Values: ``DFX``
Configures the feature extraction type to use. Currently
available: \"DFX\". Configure related parameters
in global bindings.
When configured, the usability of the features for locating
events depends on the used locator, e.g. LOCSAT. Read the
events depends on the used locator, e.g. LOCSAT will by default
consider slowness and backazimuth when measured. Read the
locator's documentation and configuration parameters.
@@ -522,10 +537,16 @@ scautopick inherits :ref:`global options<global-configuration>`.
Type: *double*
Unit: *s*
The minimum duration to reach. The duration is measured as
the time between trigger on and trigger off. If this value
is configured the detection \(pick\) will be delayed in order
is configured, the detection \(pick\) will be delayed in order
to compute and check the duration.
The duration will be reported as comment to the pick when
activating \"extraPickComments\" allowing the tuning
of the acceptable duration range.
.. confval:: thresholds.maxDuration
@@ -534,10 +555,17 @@ scautopick inherits :ref:`global options<global-configuration>`.
Type: *double*
Unit: *s*
The maximum duration allowed. The duration is measured as
the time between trigger on and trigger off. If this value
is configured the detection \(pick\) will be delayed in order
to compute and check the duration.
is configured, the detection \(pick\) will be delayed in order
to compute and check the duration. Negative values
deactivate the check.
The duration will be reported as comment to the pick when
activating \"extraPickComments\" allowing the tuning
of the acceptable duration range.
.. confval:: amplitudes.enableUpdate
@@ -756,18 +784,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.
@@ -777,8 +809,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -819,12 +856,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -852,11 +889,15 @@ Mode
.. option:: --ep
Outputs an XML event parameters file containing all picks and amplitudes.
This option implies offline.
Outputs an XML event parameters file containing all
picks and amplitudes. This option implies '\-\-offline'.
Consider '\-\-playback' or configure accordingly for
processing data from the past.
.. option:: --amplitudes arg
Default: ``1``
Enables or disables computation of amplitudes.
.. option:: --test
@@ -884,59 +925,83 @@ Settings
Overrides configuration parameter :confval:`filter`.
.. option:: --time-correction time
Overrides configuration parameter :confval:`timeCorrection`.
.. option:: --buffer-size timespan
Overrides configuration parameter :confval:`ringBufferSize`.
.. option:: --before timespan
Overrides configuration parameter :confval:`leadTime`.
.. option:: --init-time timespan
Overrides configuration parameter :confval:`initTime`.
.. option:: --trigger-on arg
Overrides configuration parameter :confval:`thresholds.triggerOn`.
.. option:: --trigger-off arg
Overrides configuration parameter :confval:`thresholds.triggerOff`.
.. option:: --trigger-dead-time arg
Overrides configuration parameter :confval:`thresholds.deadTime`.
.. option:: --ampl-max-time-window arg
Overrides configuration parameter :confval:`thresholds.amplMaxTimeWindow`.
.. option:: --min-ampl-offset arg
Overrides configuration parameter :confval:`thresholds.minAmplOffset`.
.. option:: --gap-tolerance arg
Overrides configuration parameter :confval:`thresholds.maxGapLength`.
.. option:: --gap-interpolation arg
Overrides configuration parameter :confval:`gapInterpolation`.
.. option:: --any-stream arg
Overrides configuration parameter :confval:`useAllStreams`.
.. option:: --send-detections
Overrides configuration parameter :confval:`sendDetections`.
.. option:: --extra-comments
Overrides configuration parameter :confval:`extraPickComments`.
Output
------
.. option:: -f, --formatted
Use formatted XML output along with '\-\-ep'. Otherwise XML
is unformatted.

52
share/doc/seiscomp/html/_sources/apps/scbulletin.rst.txt
View File

@@ -12,13 +12,13 @@ scbulletin
Description
===========
scbulletin transforms the parameters of events or origins either to various formats.
Currently supported output formats are:
scbulletin transforms the parameters of events or origins to various bulletin
formats. Currently supported output formats are:
* autoloc1,
* autoloc3,
* fdsnws,
* kml.
* 1: autoloc1,
* 3: autoloc3,
* 4: fdsnws,
* 5: kml.
Input Modes
@@ -28,7 +28,7 @@ Two modes of parameter input are possible:
#. Dump mode: Fetch all necessary information from database directly. Either
choose one or more event or origin IDs. The database connection must be given
with :option:`-o`.
with :option:`-d`.
#. Input mode: Provide all event and origin information in XML (:term:`SCML`)
format from file or stdin. You may filter further by event or origin ID.
@@ -46,22 +46,24 @@ information.
Output Modes
============
The generated content is written to stdout or, with option :option:`-o` to a
file. Different output formats are available by command-line options:
The generated content is written to stdout or to a file with option :option:`-o`.
Different output formats are available by command-line options:
* ``-1`` for **autoloc1**: Print one bulletin per event.
* ``-3`` for **autoloc3**: Print one bulletin per event.
* ``-3 -x`` for **extended autoloc3**.
* ``-4`` or ``--fdsnws`` for FDSNWS event text: Print one line per event. Useful
for generating event catalogs. This option offers an alternative to generating
event catalogs by :ref:`fdsnws-event <sec-event>`.
* ``-5`` or ``--kml`` for KML/GIS file format. The output can be viewed, e.g.,
in *Google Earth*.
* :option:`-1` for **autoloc1**: Print one bulletin per event.
* :option:`-3` for **autoloc3**: Print one bulletin per event.
* :option:`-4` or :option:`--fdsnws` for FDSNWS event text: Print one line per
event. Useful for generating event catalogs. This option offers an alternative
to generating event catalogs compatible with :ref:`fdsnws-event <sec-event>`
CSV format defined by :cite:t:`fdsn`.
* :option:`-5` or :option:`--kml` for KML/GIS file format. The output can be
viewed, e.g., in *Google Earth*.
By default, the output precision of times or coordinates is optimized for events
at teleseismic or regional distances. Use the option :option:`-e` for
**enhanced** output at higher precision: All times and distances are in units
of milliseconds and meters, respectively.
**enhanced** output at higher precision. Then all times and distances are given
with precision of milliseconds and meters, respectively.
Combine options :option:`-3` or :option:`-4` with :option:`-x` for printing more
parameters in generated bulletins.
Examples
@@ -98,7 +100,8 @@ Examples
.. note::
When considering a single event XML file containing many events, the
bulletins of all events will be generated unless ``--first-only`` is used.
bulletins of all events will be generated unless :option:`--first-only` is
used.
.. _scbulletin_configuration:
@@ -332,6 +335,11 @@ Output
.. option:: -x, --extra
Use a specially detailed autoloc3 format. This options works
only in combination with the autoloc3\-flag.
Generate extra detailed output for specific output formats adding
\- 3\/autoloc3: IDs of preferred objects and creation information
\- 4\/FDSNWS event text: Additional columns
More information may be added in future versions.

60
share/doc/seiscomp/html/_sources/apps/sccnv.rst.txt
View File

@@ -6,17 +6,19 @@
sccnv
#####
**Converts data in different formats.**
**Converts data from/to different formats.**
Description
===========
sccnv reads input given in a supported format, converts the content to another
format and writes the output. Use the command-line option :confval:`format-list`
format and writes the output. Use the command-line option :option:`--format-list`
for a list of supported formats.
.. _sec-sccnv-formats:
Formats
=======
@@ -26,18 +28,22 @@ Different formats are supported for input and output files.
:widths: 10, 60, 10, 10
:header: Name, Description, Input, Output
:align: left
:delim: ;
arclink , `Arclink XML <https://www.seiscomp.de/seiscomp3/doc/applications/arclink-status-xml.html>`_ , X , X
bson , , X , X
bson-json , , , X
csv , comma-separated values , , X
hyp71sum2k , Hypo71 format , , X
ims10 , , , X
json , `JSON <https://www.json.org/>`_ format , X , X
qml1.2 , :term:`QuakeML` format , \* , X
qml1.2rt , :term:`QuakeML` real time (RT) format , \* , X
scdm0.51 , , X , X
trunk , SeisComP XML (:term:`SCML`) - :ref:`SCML API <api-datamodel-python>` , X , X
arclink ; `Arclink XML <https://www.seiscomp.de/seiscomp3/doc/applications/arclink-status-xml.html>`_ ; X ; X
binary ; :ref:`SeisComP data model <api-datamodel-python>` in binary format: low-weight and fast ; X ; X
bson ; ; X ; X
bson-json ; ; ; X
csv ; comma-separated values ; ; X
hyp71sum2k ; Hypo71 format ; ; X
ims10 ; ; ; X
json ; :cite:t:`json` format ; X ; X
qml1.2 ; :term:`QuakeML` format ; \* ; X
qml1.2rt ; :term:`QuakeML` real time (RT) format ; \* ; X
scdm0.51 ; ; X ; X
scml ; SeisComP XML (:term:`SCML`) - :ref:`SCML API <api-datamodel-python>` ; X ; X
trunk ; same as scml, classic way of stating this format ; X ; X
vbson ; ; X ; X
**\***: The conversion from files in QuakeML format is not supported by sccnv
but can be realized by system tools. Read section :ref:`sec-sccnv-quakeml` for
@@ -108,7 +114,7 @@ Examples
.. code-block:: sh
$ sccnv -i trunk:event.xml -o ims10:event.ims
$ sccnv -i scml:event.xml -o ims10:event.ims
* Convert QuakeML in version 1.2 to SCML in data schema version 0.12:
@@ -125,9 +131,9 @@ Command-Line Options
:program:`sccnv -i format:file -o format:file`
sccnv reads the input given in a supported format, converts the content
and writes the output in another format. Use the option `format\-list`
for a list of supported formats.
sccnv reads the input given in a supported format, converts the
content and writes the output in another format. Use the option
`format\-list` for a list of supported formats.
Generic
@@ -160,7 +166,11 @@ Formats
.. option:: --format-list
List all supported formats
List all supported formats.
.. option:: --list-formats
Same as \-\-format\-list.
Input
@@ -168,7 +178,9 @@ Input
.. option:: -i, --input arg
Input stream [format:][file], default: trunk:\-
Default: ``scml:-``
Input stream [format:][file].
Output
@@ -176,13 +188,17 @@ Output
.. option:: -o, --output arg
Output stream [format:][file], default trunk:\-
Default: ``scml:-``
Output stream [format:][file].
.. option:: -f, --formatted
Use formatted output
Use formatted output.
.. option:: --indent arg
Formatted line indent. Default: 2
Default: ``2``
Formatted line indent.

21
share/doc/seiscomp/html/_sources/apps/scdb.rst.txt
View File

@@ -258,18 +258,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.
@@ -279,8 +283,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
.. option:: --m, --mode arg
@@ -337,3 +346,15 @@ Import
Define the import XML file to be written to database.
Can be provided multiple times to import multiple files.
Operation
---------
.. option:: -x, --wipe arg
PublicObjects for which all child objects will be wiped out.
A PublicObject is defined as {type}[:{publicID}],
e.g. Origin:123.
If the colon and publicID is omitted then the publicID is
equal to the type, e.g. Inventory.

19
share/doc/seiscomp/html/_sources/apps/scdbstrip.rst.txt
View File

@@ -266,6 +266,7 @@ Generic
Overrides configuration parameter :confval:`firstNew`.
Verbosity
---------
@@ -373,14 +374,17 @@ Timespan
Overrides configuration parameter :confval:`database.cleanup.keep.days`.
.. option:: --hours arg
Overrides configuration parameter :confval:`database.cleanup.keep.hours`.
.. option:: --minutes arg
Overrides configuration parameter :confval:`database.cleanup.keep.minutes`.
.. option:: --datetime arg
Replaces the days:hours:minutes timespan definition by an
@@ -398,7 +402,20 @@ Timespan
Overrides configuration parameter :confval:`database.cleanup.invertMode`.
.. option:: --keep-events
.. option:: --keep-events events
IDs of events to keep in the database separated with comma.
.. option:: --keep-event-modes modes
Do not delete events where the evaluation mode of the
preferred origin is one of the passed modes. Modes are
given as a list with comma as separator.
.. option:: --keep-event-status status
Do not delete events where the evaluation status of the
preferred origin is one of the passed status. Status are
given as a list with comma as separator.

15
share/doc/seiscomp/html/_sources/apps/scdispatch.rst.txt
View File

@@ -310,18 +310,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.
@@ -331,8 +335,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -378,6 +387,10 @@ Dispatch
.. option:: -O, --operation arg
Default: ``merge``
Values: ``add,update,remove,merge,merge-without-remove``
Merge and merge\-without\-remove require a database
connection. Both will read the object corresponding to the
sent object from the database and calculate the differences.
@@ -399,6 +412,8 @@ Dispatch
.. option:: --routingtable arg
Default: ``Amplitude:AMPLITUDE,Event:EVENT,FocalMechanism:FOCMECH,Magnitude:MAGNITUDE, Origin:LOCATION,Pick:PICK,StationMagnitude:MAGNITUDE``
Specify routing table as comma separated list of object:group
pairs, e.g. \"Origin:LOCATION,Event:EVENT\". When an
object should be routed to a group and no table entry for

19
share/doc/seiscomp/html/_sources/apps/scesv.rst.txt
View File

@@ -548,18 +548,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.
@@ -569,8 +573,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -611,12 +620,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -632,6 +641,10 @@ Cities
.. option:: --city-xml arg
Type: *file*
Values: ``*.xml``
The path to the cities XML file. This overrides the default
paths. Compare with the global parameter \"citiesXML\".

382
share/doc/seiscomp/html/_sources/apps/scevent.rst.txt
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.

20
share/doc/seiscomp/html/_sources/apps/scevtlog.rst.txt
View File

@@ -56,10 +56,11 @@ scevtlog inherits :ref:`global options<global-configuration>`.
Type: *string*
Specify output event format \(default is autoloc3\). For completeness
it is recommended to switch to xml as storage format. The autoloc3
format can be easily reconstructed with scbulletin but not the other
way around.
Values: ``xml,autoloc1,autoloc3``
Event output format. For completeness it is recommended to stick
with the default 'xml' as it can be converted to 'autoloc1' and
'autoloc3' by scbulletin but not the other way around.
.. confval:: gzip
@@ -183,18 +184,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.
@@ -204,8 +209,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -244,7 +254,9 @@ Storage
Overrides configuration parameter :confval:`directory`.
.. option:: -f, --format arg
Overrides configuration parameter :confval:`format`.

50
share/doc/seiscomp/html/_sources/apps/scevtstreams.rst.txt
View File

@@ -6,21 +6,26 @@
scevtstreams
############
**Extract stream information with time windows from picks of an event.**
**Extract stream information and time windows from picks of an event or
solitary picks.**
Description
===========
scevtstreams reads all picks of an event and determines the time window between
the first pick and the last pick. In addition a symmetric or an asymmetric time
margin is added to this
time window. It writes the streams that are picked including the determined
scevtstreams reads all picks of an event or solitary picks determining the time
window between the first pick and the last pick.
In addition symmetric asymmetric time margins are added to this time window.
It writes the streams that are picked including the determined
time window for the event to stdout. This tool gives appropriate input
information for :ref:`scart`, :ref:`fdsnws` and :cite:t:`capstool` for
:cite:t:`caps` server (Common Acquisition Protocol Server by gempa GmbH) to dump
waveforms from archives based on event data.
Events with origins and picks can be read from database or XML file. Solitary
picks can only be read from XML file. The XML files can be generated using
:ref:`scxmldump`.
Output Format
=============
@@ -49,30 +54,43 @@ Examples
scevtstreams -E gfz2012abcd -d mysql://sysop:sysop@localhost/seiscomp
#. Get the asymmetric time windows for an event in an XML file. The time window
starts 120 s before the first pick and ends 500 s after the last pick:
#. Get the time windows for one specific event or all events in a XML file.
The time windows start 120 s before the first pick and ends 500 s after the
last pick:
.. code-block:: sh
scevtstreams -E gfz2012abcd -i event.xml -m 120,500
scevtstreams -i event.xml -E gfz2012abcd
scevtstreams -i event.xml
#. Create a playback of an event with a time window of 5 minutes data and
sort the records by end time:
#. Get the time windows from all picks in a XML file which does not contain
events or origins:
.. code-block:: sh
scevtstreams -i picks.xml
#. Combine with :ref:`scart` for creating a :term:`miniSEED` data file from one
event. The time window starts and ends 5 minutes before the first and after
the last pick, respectively.
The data is read from :term:`SDS` archive and sorted by end time:
.. code-block:: sh
scevtstreams -E gfz2012abcd -d mysql://sysop:sysop@localhost/seiscomp -m 300 |\
scart -dsvE --list - ~/seiscomp/acquisition/archive > gfz2012abcd-sorted.mseed
#. Download waveforms from Arclink and import into local archive. Include
#. Download waveforms from FDSN and import into local archive. Include
all stations from the contributing networks:
.. code-block:: sh
scevtstreams -E gfz2012abcd -d mysql://sysop:sysop@localhost/seiscomp -m 300 -R --all-stations |\
scart --list - ./my-archive
scart --list - -I fdsnws://geofon.gfz.de ./my-archive
#. Create lists compatible with :ref:`fdsnws` or `caps <https://docs.gempa.de/caps/current/apps/capstool.html>`_: ::
#. Create lists compatible with :ref:`fdsnws` POST format or :cite:t:`capstool`:
.. code-block:: sh
scevtstreams -E gfz2012abcd -i event.xml -m 120,500 --fdsnws
scevtstreams -E gfz2012abcd -i event.xml -m 120,500 --caps
@@ -230,8 +248,8 @@ Input
.. option:: -i, --input arg
Input XML file name. Reads event from the XML file instead of
database. Use '\-' to read from stdin.
Input XML file name. Reads event and picks from the XML file
instead of database. Use '\-' to read from stdin.
.. option:: -f, --format arg
@@ -249,7 +267,7 @@ Dump
.. option:: --net-sta arg
Filter read picks by network code or network and station
code. Format: NET or NET.STA
code. Format: NET or NET.STA .
.. option:: --nslc arg

43
share/doc/seiscomp/html/_sources/apps/scheli.rst.txt
View File

@@ -48,8 +48,8 @@ Examples
scheli --debug
* Let :program:`scheli` show data from the CX station PB01 for the previous 5 hours
overriding configuration by command-line paramaters:
* Let :program:`scheli` show data from the CX station PB01 for the previous
5 hours overriding configuration by command-line paramaters:
.. code-block:: sh
@@ -118,12 +118,14 @@ scheli inherits :ref:`global options<global-configuration>`.
Type: *list:string*
List of stream codes to be plotted \(net.sta.loc.cha\).
If not in capture mode only the first stream is shown.
List of stream codes to be plotted.
If not in capture mode, only the first stream is shown.
When using a list, the first entry is considered.
Use commas for separating streams.
Example: GR.MOX..BHZ
Format: NET.STA.LOC.CHA
Example: GR.CLL..BHZ,GR.MOX..BHZ
.. confval:: heli.filter
@@ -226,6 +228,8 @@ scheli inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``minmax,row``
Define the method to scale traces within rows. Possible
values are:
@@ -468,18 +472,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.
@@ -489,8 +497,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -532,12 +545,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -592,10 +605,14 @@ Data
.. option:: --gain arg
Unit: *counts/unit*
Gain applied to the data before plotting
.. option:: --amp-scaling arg
Default: ``minmax``
Lower bound of amplitude range per row. Possible values:
minmax: Scale all rows to configured minimum and maximum
@@ -633,6 +650,8 @@ Output
.. option:: --time-span arg
Unit: *s*
Configure the time\-span \(in secs\) per row. Unit: seconds.
.. option:: --aa arg
@@ -641,14 +660,20 @@ Output
.. option:: --xres arg
Unit: *dpi*
Output x resolution when generating images. Unit: dpi.
.. option:: --yres arg
Unit: *dpi*
Output y resolution when generating images. Unit: dpi.
.. option:: --dpi arg
Unit: *dpi*
Output dpi when generating postscript. Unit:dpi.
.. option:: -o arg
@@ -658,6 +683,8 @@ Output
.. option:: --interval arg
Unit: *s*
Snapshot interval \(less than 0 disables timed snapshots\).
Unit: seconds.

9
share/doc/seiscomp/html/_sources/apps/scimex.rst.txt
View File

@@ -417,18 +417,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.
@@ -438,8 +442,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

10
share/doc/seiscomp/html/_sources/apps/scimport.rst.txt
View File

@@ -479,18 +479,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.
@@ -500,8 +504,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -512,6 +521,7 @@ Import
Overrides configuration parameter :confval:`sink`.
.. option:: -i, --import
Switch to import mode \(default is relay\). Im import mode the

29
share/doc/seiscomp/html/_sources/apps/scinv.rst.txt
View File

@@ -97,13 +97,24 @@ existing subtrees into a final inventory before synchronization.
.. code-block:: sh
scinv merge net1.xml net2.xml -o inv.xml
scinv merge network1.xml network2.xml -o inventory.xml
.. note::
Merging inventory XML files is also supported by :ref:`scxmlmerge` but
without the full :ref:`consistency checks <scinv_check>`.
Along with :option:`--strip`, unreferenced data logger, sensors and responses
are removed resulting in small XML files.
.. code-block:: sh
scinv merge --strip network1.xml network2.xml -o inventory.xml
.. note::
Removing such unreferenced objects is also achieved by :ref:`invextr`.
.. _scinv_apply:
@@ -261,14 +272,16 @@ results.
:delim: ;
network ; start time after end time ; !;
; network without station ; W;
; empty start time ; ; handled by SeisComP inventory reader: network is ignored
; overlapping epochs ; C;
; network without station ; W;
; empty station ; W;
; empty code ; W;
station ; start time after end time ; !;
; empty or no start time ; W; station is ignored
; start time after end time ; !;
; overlapping epochs ; C;
; empty code ; W;
; empty latitude ; W;
; empty longitude ; W;
@@ -281,6 +294,7 @@ results.
; elevation far away from station ; W; :option:`--max-elevation-difference` and :confval:`check.maxElevationDifference` override default threshold (500 m)
; epoch outside network epochs ; C;
; epoch outside station epochs ; C;
; overlapping epochs ; C;
; empty or no start time ; W; sensorLocation is ignored
; empty latitude ; W;
; empty longitude ; W;
@@ -290,11 +304,11 @@ results.
; has no channel/stream ; W;
stream ; empty or no start time ; ; handled by SeisComP inventory reader: stream is ignored
; empty azimuth ; C;
; epoch outside sensorLocation ; C;
; epoch outside station ; C;
; epoch outside network ; C;
; start time after end time ; C;
; overlapping epochs ; C;
; missing gain value ; W; empty value is handled by SeisComP inventory reader
; gain value = 0 ; W;
; gain < 0 and dip > 0 ; W; may result in unexpected behavior, consider positive gain and negative dip
@@ -519,18 +533,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.
@@ -540,8 +558,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

9
share/doc/seiscomp/html/_sources/apps/scm.rst.txt
View File

@@ -355,18 +355,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.
@@ -376,8 +380,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

45
share/doc/seiscomp/html/_sources/apps/scmag.rst.txt
View File

@@ -298,16 +298,18 @@ scmag inherits :ref:`global options<global-configuration>`.
Type: *list:string*
The methods for computing the network magnitude
from station magnitudes. Exactly one method per
magnitude can be configured.
To define the averaging method per magnitude type append
the type after colon, e.g.:
Values: ``*default,*mean,*median,*trimmedMean(*),*trimmedMedian(*),*medianTrimmedMean(*)``
The methods for computing the network magnitude from station
magnitudes. Exactly one method per magnitude can be
configured. To define the averaging method per magnitude
type append the type after colon. Example:
\"magnitudes.average \= default, MLv:median\"
default: Compute the mean if less than 4 contributed
station magnitudes exist. Otherwise apply trimmedMean\(25\),
trimmed mean with 25%.
default: Compute the mean if less than 4 contributed station
magnitudes exist. Otherwise apply trimmedMean\(25\), trimmed
mean with 25%.
.. confval:: connection.sendInterval
@@ -402,7 +404,7 @@ scmag inherits :ref:`global options<global-configuration>`.
.. confval:: summaryMagnitude.coefficients.a
Default: ``0, Mw(mB):0.4, Mw(Mwp):0.4``
Default: ``0,Mw(mB):0.4,Mw(Mwp):0.4``
Type: *list:string*
@@ -413,7 +415,7 @@ scmag inherits :ref:`global options<global-configuration>`.
.. confval:: summaryMagnitude.coefficients.b
Default: ``1, MLv:2, Mw(mB):-1, Mw(Mwp):-1``
Default: ``1,MLv:2, Mw(mB):-1,Mw(Mwp):-1``
Type: *list:string*
@@ -534,18 +536,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.
@@ -555,8 +561,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -593,7 +604,10 @@ Input
.. option:: --ep file
Defines an event parameters XML file to be read and processed. This
Type: *string*
Defines an event parameters XML file to be read and
processed. Use '\-' to read from stdin. This
implies offline mode and only processes all origins contained
in that file. It computes station magnitudes for all picks associated
with an origin where amplitudes are available and the corresponding
@@ -631,3 +645,12 @@ Reprocess
Keep the original weights in combination with \-\-static.
Output
------
.. option:: -f, --formatted
Use formatted XML output along with '\-\-ep'. Otherwise XML
is unformatted.

24
share/doc/seiscomp/html/_sources/apps/scmapcut.rst.txt
View File

@@ -177,6 +177,8 @@ Cities
.. option:: --city-xml arg
Type: *string*
Path to the cities.xml file. If undefined, the data is
read from CONFIGDIR\@\/cities.xml or \@DATADIR\@\/cities.xml.
@@ -186,30 +188,52 @@ Options
.. option:: -r, --region arg
Unit: *degree*
Type: *string*
Cut region \([lat_dim]x[lon_dim]+lat0+lon0 or +lat0+lon+lat1+lon1\).
.. option:: -m, --margin arg
Unit: *degree*
Type: *string*
Margin in degrees around origin \(margin\|margin_latxmargin_lon\).
.. option:: -d, --dimension arg
Unit: *px*
Type: *string*
Output image dimension \(wxh\).
.. option:: -o, --output arg
Type: *string*
Output image, file name.
.. option:: --lat arg
Unit: *degree*
Type: *float*
Latitude of symbol.
.. option:: --long arg
Unit: *degree*
Longitude of symbol.
.. option:: --depth arg
Unit: *km*
Depth of event.
.. option:: --mag arg

13
share/doc/seiscomp/html/_sources/apps/scmaster.rst.txt
View File

@@ -419,6 +419,19 @@ scmaster inherits :ref:`global options<global-configuration>`.
consequences are.
.. confval:: queues.$name.processors.messages.dbstore.deleteTree
Default: ``true``
Type: *boolean*
Enables removing the entire object tree from
the database if a parent object is being deleted.
This will also decrease the numbers of notifiers
sent to scmaster. Depending on the database
backend, it can improve the performance.
.. confval:: http.filebase
Default: ``@DATADIR@/scmaster/http/``

15
share/doc/seiscomp/html/_sources/apps/scmm.rst.txt
View File

@@ -180,18 +180,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.
@@ -201,8 +205,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -243,12 +252,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg

55
share/doc/seiscomp/html/_sources/apps/scmsdemux.rst.txt Normal file
View File

@@ -0,0 +1,55 @@
.. highlight:: rst
.. _scmsdemux:
#########
scmsdemux
#########
**Demultiplex miniSEED record creating files per stream**
Description
===========
scmsdemux demultiplexes :term:`miniSEED` records found in the given source
writing them into separate new files. The source can be files or stdin. One
file per stream is generated. File names are derived from the stream code and
the begin time of the records.
Examples:
* Demultiplex the miniSEED records contained in :file:`data.mseed` and
additionally print the names of created files to stderr
.. code-block:: sh
scmsdemux -v data.mseed
* Demultiplex the miniSEED records received from stdin
.. code-block:: sh
scmssort -u -E data.mseed | scmsdemux -
Command-Line Options
====================
.. program:: scmsdemux
:program:`scmsdemux [OPTION] source`
Verbosity
---------
.. option:: -h, --help
Display this help message.
.. option:: -v, --verbose
Verbose mode.

19
share/doc/seiscomp/html/_sources/apps/scmv.rst.txt
View File

@@ -533,18 +533,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.
@@ -554,8 +558,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -596,12 +605,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -617,6 +626,10 @@ Cities
.. option:: --city-xml arg
Type: *file*
Values: ``*.xml``
The path to the cities XML file. This overrides the default
paths. Compare with the global parameter \"citiesXML\".

653
share/doc/seiscomp/html/_sources/apps/scmvx.rst.txt Normal file
View File

@@ -0,0 +1,653 @@
.. highlight:: rst
.. _scmvx:
#####
scmvx
#####
**Map view showing maps with stations and events. Issues related to
configuration of stations are indicated.**
Description
===========
scmvx visualizes the current information of earthquakes or earthquakes loaded
database as well as current station information including:
* trigger status,
* ground motion,
* station quality,
* station configuration issues.
All stations and events are visualized in a map. The map can be customized by
global :confval:`scheme.map` parameters and additional layers can be added as
outlined in the :ref:`GUI documenation <global_gui>`. scmvx provides multiple
:ref:`tabs <sec-scmvx-tabs>`:
* :ref:`Network <sec-scmvx-network-tab>`: Maps showing events and network
information including station configuration issues.
* :ref:`Ground motion <sec-scmvx-gm-tab>`: Map with events and stations. The
color of stations symbols represents recent ground motion calculated by scmvx
in a configurable time window.
* :ref:`Quality control <sec-scmvx-qc-tab>`: Map with events and stations. The
color of stations symbols represents recent waveform quality control
parameters calculated by :ref:`scqc`.
* :ref:`Events <sec-scmvx-events-tab>`: Event list updated in real time and
allowing to filter events and to load historic events from database.
.. _sec-scmvx-tabs:
Tabs
====
Section is upcoming.
.. _sec-scmvx-network-tab:
Network
-------
Section is upcoming.
.. _sec-scmvx-gm-tab:
Ground motion
-------------
Section is upcoming.
.. _sec-scmvx-qc-tab:
Quality control
---------------
Section is upcoming.
.. _sec-scmvx-events-tab:
Events
------
Events are shown as they arrive in real time and may be interactively loaded
from database.
During startup events from within a period of time are loaded and shown
according the configuration of :confval:`readEventsNotOlderThan`.
More events are added in real time as they arrive.
Historic events can be loaded from database for time spans and other filter
criteria.
The loaded events can sorted interactively by clicking on the table header.
Events out of scope can be hidden based on region, event type of agency ID.
In contrast to other event lists, e.g. in :ref:`scolv` or :ref:`scesv`, this
event list only gives access to parameter of the preferred but no other origins
of events.
.. _fig-scmvx-events-tab:
.. figure:: media/scmvx-events-tab.png
:width: 16cm
:align: center
Events tab
Hotkeys
-------
.. csv-table::
:header: Hotkey, Description
:widths: 30,70
:delim: ;
C; Center map around latest event upon event update
G; Show map base layer in gray scale
N; Reset view to default
:kbd:`F1` ;Open SeisComP documentation in default browser
:kbd:`Shift + F1` ;Open scmvx documentation in default browser
:kbd:`F2` ;Open dialog for connecting to database and messaging
:kbd:`F6` ;Toggle latest event information on map
:kbd:`F7` ;Toggle legend
:kbd:`F8` ;Toggle station issues in Network tab
:kbd:`F9` ;Toggle station annotation
:kbd:`F10` ;Switch to event list (Events tab)
:kbd:`F11` ;Toggle full screen mode
:kbd:`CTRL + F` ;Search station
:kbd:`CTRL + O` ;Open event parameter XML file
:kbd:`CTRL + Q` ;Quit scmvx
:kbd:`Shift + Arrows` ;Move focus of map
:kbd:`+` ;Zoom in in map
:kbd:`-` ;Zoom out in map
Mouse wheel ;Zoom in or out in map
Mouse double click ;Center map
Right mouse button ;Open context menu
Use Cases
=========
Get station information, detail issues
--------------------------------------
#. Navigate to the Network tab
#. Position the mouse above a triangle representing a station. The selected
station is highlighted. Zoom in if events are overlapping.
#. Click your left mouse button for opening the station info widget.
Data and potential configuration issues are shown.
Search for and show an event
----------------------------
#. Navigate to the Events tab load events from database in a relevant time range.
You may narrow down the database search through the filter button. After
events are loaded the list may be limited by hiding irrelevant events and you
may change the sorting of the event table by clicking on the header.
#. Identify the event and double-click on the event line to load the parameters.
You will immediately switch to a map centered around the selected event.
Get event information
---------------------
#. Position the mouse above a circle representing the location of an event.
Zoom in if events are overlapping.
#. Click the left mouse button for opening the event object inspector.
Set preliminary origin
----------------------
*Upcoming feature, not yet supported*
#. Position the mouse in the map
#. Press the middle mouse button
#. Set date & time and latitude, longitude & depth
#. Press "Create" to open the origin in another GUI, e.g., scolv which must
be running already.
Search station/network
----------------------
#. Press :kbd:`CTRL + F` to open the search window.
#. Type any string from a station and/or network name in the input field or just
select a station from the list.
#. Double click in a station in the list to center the map at this location.
Command-Line Examples
=====================
* Real-time view of events and stations on a local server
.. code-block:: properties
scmvx -H localhost -I slink://localhost --debug
* Offline view of event parameters given in an XML file. Inventory is read from
database.
.. code-block:: properties
scmvx -d localhost -i events.xml --debug
.. _scmvx_configuration:
Module Configuration
====================
| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/scmvx.cfg`
| :file:`etc/global.cfg`
| :file:`etc/scmvx.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/scmvx.cfg`
scmvx inherits :ref:`global options<global-configuration>`.
.. confval:: displaymode
Type: *string*
Values: ``groundmotion,qualitycontrol``
Set one of the available display modes used during startup:
groundmotion or qualitycontrol. When empty, the Network tab is
shown.
.. confval:: readEventsNotOlderThan
Default: ``86400``
Type: *double*
Unit: *s*
Sets the time span before current time to read events initially
from database.
.. confval:: centerOrigins
Default: ``false``
Type: *boolean*
If a new origin\/event is set\/selected, this option defines if
the map is centered or not at the origin location.
.. confval:: annotations
Default: ``false``
Type: *boolean*
Enables\/disabled drawing of station annotations at startup.
.. confval:: annotationsWithChannels
Default: ``true``
Type: *boolean*
Enable\/disable drawing of station annotations with
location\/channel codes as NET.STA.LOC.CHA.
.. confval:: showUnboundStations
Default: ``true``
Type: *boolean*
Enable\/disable drawing of stations which are not bound with global bindings.
.. confval:: mapLegendPosition
Default: ``topleft``
Type: *string*
Values: ``topleft,topright,bottomright,bottomleft``
The legend location for station symbols \(network, QC, ground motion\).
.. confval:: eventLegendPosition
Default: ``bottomleft``
Type: *string*
Values: ``topleft,topright,bottomright,bottomleft``
The legend location for event symbols.
.. confval:: stations.amplitudeTimeSpan
Default: ``10``
Type: *double*
Unit: *s*
*No description available*
.. confval:: stations.groundMotionRecordLifeSpan
Default: ``600``
Type: *double*
Unit: *s*
Time to keep waveform data in memory
.. confval:: stations.triggerTimeout
Default: ``60``
Type: *double*
Unit: *s*
*No description available*
.. confval:: stations.groundMotionFilter
Default: ``ITAPER(60)>>BW_HP(4,0.5)``
Type: *string*
Sets the filter applied to determine ground motion.
.. note::
**display.\***
*The initial rectangular region for the map. The eventual region*
*is also scaled to the dimension of the opened map widget.*
.. confval:: display.latmin
Default: ``-90.0``
Type: *double*
Unit: *deg*
Range: ``-90:90``
Minimum latitude in degrees.
.. confval:: display.lonmin
Default: ``-180.0``
Type: *double*
Unit: *deg*
Range: ``-360:360``
Minimum longitude in degrees.
.. confval:: display.latmax
Default: ``90.0``
Type: *double*
Unit: *deg*
Range: ``-90:90``
Maximum latitude in degrees.
.. confval:: display.lonmax
Default: ``180.0``
Type: *double*
Unit: *deg*
Range: ``-360:360``
Maximum longitude in degrees.
Command-Line Options
====================
.. program:: scmvx
:program:`scmvx [options]`
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, eg. \-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:: --log-file arg
Use alternative log file.
.. option:: --print-component arg
For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.
.. option:: --trace
Execute in trace mode.
Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1
\-\-print\-context\=1 .
Generic
-------
.. option:: -h, --help
Show help message.
.. option:: -V, --version
Show version information.
.. option:: --config-file arg
Use alternative configuration file. When this option is
used the loading of all stages is disabled. Only the
given configuration file is parsed and used. To use
another name for the configuration create a symbolic
link of the application or copy it. Example:
scautopick \-> scautopick2.
.. option:: --plugins arg
Load given plugins.
.. option:: --auto-shutdown arg
Enable\/disable self\-shutdown because a master module shutdown.
This only works when messaging is enabled and the master
module sends a shutdown message \(enabled with \-\-start\-stop\-msg
for the master module\).
.. option:: --shutdown-master-module arg
Set the name of the master\-module used for auto\-shutdown.
This is the application name of the module actually
started. If symlinks are used, then it is the name of
the symlinked application.
.. option:: --shutdown-master-username arg
Set the name of the master\-username of the messaging
used for auto\-shutdown. If \"shutdown\-master\-module\" is
given as well, this parameter is ignored.
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:: --content-type arg
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
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 .
.. option:: --db-disable
Do not use the database at all
Records
-------
.. option:: --record-driver-list
List all supported record stream drivers.
.. option:: -I, --record-url arg
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
Specify a file as record source.
.. option:: --record-type arg
Specify a type for the records being read.
Cities
------
.. option:: --city-xml arg
Type: *file*
Values: ``*.xml``
The path to the cities XML file. This overrides the default
paths. Compare with the global parameter \"citiesXML\".
User interface
--------------
.. option:: -F, --full-screen
Start the application filling the entire screen.
This only works with GUI applications.
.. option:: -N, --non-interactive
Use non\-interactive presentation mode. This only works with
GUI applications.
MapviewX
--------
.. option:: --display-mode arg
Overrides configuration parameter :confval:`displaymode`.
.. option:: -i, --input-file file
Load events in given XML file during startup and switch to
offline mode.
.. option:: --offline
Do not connect to a messaging server and do not subscribe
channel data.
.. option:: --with-legend
Show the map legends.

372
share/doc/seiscomp/html/_sources/apps/scolv.rst.txt
View File

@@ -2132,10 +2132,13 @@ scolv inherits :ref:`global options<global-configuration>`.
Type: *string*
Sets the default magnitude aggregation method. It can be either \"mean\",
\"trimmed mean\" or \"median\". If not set, the default
behavior is used which computes the mean if less than 4 stations are available,
trimmed mean otherwise.
Values: ``mean,trimmedMean,median,medianTrimmedMean``
Sets the default magnitude aggregation method.
If not set, the default behavior is used which computes the
mean if less than 4 stations are available, trimmed mean otherwise.
Neither of the above values can take an additional parameter.
The default parameter values \(if supported\) will be used.
.. confval:: olv.computeMagnitudesAfterRelocate
@@ -2223,6 +2226,16 @@ scolv inherits :ref:`global options<global-configuration>`.
The default value for adding unassociated stations in the picker.
.. confval:: olv.loadAdditionalStations
Default: ``false``
Type: *boolean*
If enabled then all station within the configured distance will
be loaded if a new origin is loaded.
.. confval:: olv.hideStationsWithoutData
Default: ``false``
@@ -2272,6 +2285,14 @@ scolv inherits :ref:`global options<global-configuration>`.
when a new event was received.
.. confval:: olv.originAgencyIDs
Type: *list:string*
Define a list of agencyIDs which can be used as override
for the origin agencyID when committing with options.
.. confval:: olv.originComments
Type: *list:string*
@@ -2372,6 +2393,63 @@ scolv inherits :ref:`global options<global-configuration>`.
from Origin.methodID and the profile from Origin.earthModelID.
.. note::
**olv.import.\***
*Set default options for the "Import picks" dialog.*
.. confval:: olv.import.mode
Default: ``latest``
Type: *string*
Values: ``latest,latest-automatic,phases,all``
Defines the default mode of import picks. For more information
see the \"Import picks\" dialog.
.. confval:: olv.import.acceptedPhases
Type: *list:string*
Defines a list of accepted or denied phases when importing picks.
This list will be used to populate the corresponding input
field in the \"Import picks\" dialog.
A phase which is prepended with a minus, e.g. \"\-P\",
will be denied.
.. confval:: olv.import.options.allAgencies
Default: ``false``
Type: *boolean*
Configures the default for \"Import picks from all agencies ...\".
.. confval:: olv.import.options.allPhases
Default: ``true``
Type: *boolean*
Configures the default for \"Import all phases ...\".
.. confval:: olv.import.options.preferTargetPhases
Default: ``true``
Type: *boolean*
Configures the default for \"Prefer phases of target ...\".
.. confval:: olv.commit.forceEventAssociation
Default: ``false``
@@ -2621,6 +2699,102 @@ scolv inherits :ref:`global options<global-configuration>`.
Add a summary of the actions to the button's tooltip.
.. note::
**olv.commandMenuAction.\***
*Configuration of custom commands shown in a menu when pressing*
*the Run button next to the custom script buttons. Actions*
*defined here will appear in order of listing. A dash may be*
*use to insert a separator.*
.. note::
**olv.commandMenuAction.$name.\***
*Definition of a command menu action.*
$name is a placeholder for the name to be used.
.. confval:: olv.commandMenuAction.$name.enable
Default: ``true``
Type: *boolean*
Controls whether this action will be available.
.. confval:: olv.commandMenuAction.$name.command
Type: *file*
Command to be executed. Similar to the custom script
buttons the command is launched with the current
origin ID as first argument and the eventID as
second argument if available. Optionally the entire
origin may be written to stdin if an exporter is
defined.
.. confval:: olv.commandMenuAction.$name.exporter
Type: *string*
Values: ``scml,json,csv,binary``
Name of the SeisComP exporter used to serialize
the current origin when writing it to stdin of
the specified command. If empty no data will be
send to stdin. See 'sccnv \-\-list\-formats' for a
list of available options.
Note: Some of the exporters are implemented
as plugins which need to be loaded before they
can be used.
.. confval:: olv.commandMenuAction.$name.showProcess
Default: ``false``
Type: *boolean*
Automatically open process manager for progress
monitoring. The process manager may also be started
manually via the View menu bar entry or via an icon
at the right of the status bar.
.. confval:: olv.commandMenuAction.$name.text
Type: *string*
Name of the action. Use in the launch menu and in
the process manager.
.. confval:: olv.commandMenuAction.$name.icon
Type: *file*
Path to an icon to show for this action.
.. confval:: olv.commandMenuAction.$name.keySequence
Type: *file*
Keyboard shortcut to run this action without
the need to open the menu. E.g., 'Ctrl+Alt+A'
.. confval:: olv.commandMenuAction.$name.toolTip
Type: *file*
Tool tip for this action.
.. note::
**olv.magnitudeComments.\***
*The container for all magnitude comment profiles.*
@@ -2725,7 +2899,7 @@ scolv inherits :ref:`global options<global-configuration>`.
Type: *int*
Limit the data acquisituion to the given number of
Limit the data acquisition to the given number of
the nearest stations. Requires to activate
\"picker.limitStationAcquisition\".
@@ -2851,6 +3025,28 @@ scolv inherits :ref:`global options<global-configuration>`.
side of the trace window.
.. confval:: picker.rotation
Default: ``123``
Type: *string*
Values: ``123,ZNE,ZRT,LQT,ZH(L2)``
The initially applied rotation component waveform rotation.
.. confval:: picker.unit
Default: ``Sensor``
Type: *string*
Values: ``Sensor,Acceleration,Velocity,Displacement``
The unit the waveform data is converted to initially.
.. confval:: picker.repickerStart
Type: *double*
@@ -2877,6 +3073,19 @@ scolv inherits :ref:`global options<global-configuration>`.
\"name1;filter\-definition1\", \"name2;filter\-definition2\"
.. confval:: picker.limitFilterToZoomTrace
Default: ``false``
Type: *boolean*
Whether to apply the current filter only to the zoom trace or
all traces. If enabled then the current filter will only be
applied to another trace if it becomes the current trace. This
is mainly for performance reasons as filtering hundreds or
thousands of channels can take much time.
.. confval:: picker.velocityChannelCodes
Type: *list:string*
@@ -2942,6 +3151,20 @@ scolv inherits :ref:`global options<global-configuration>`.
component will stay the same. It must be changed explicitely.
.. confval:: picker.showAmpLevel
Default: ``false``
Type: *boolean*
If enabled then the picker will show in the upper right corner of
the zoomtrace an amplitude measure ranging from 0 to 100 and mapping
the current amplitude at the cursor to this range where 0 is the bottom
of the widget and 100 the top of the widget. Screen readers should
fetch this value change and read them. This is especially important
to support visually impaired users.
.. note::
**picker.auxiliary.\***
*Define the notion and behaviour of auxiliary channels.*
@@ -2958,6 +3181,9 @@ scolv inherits :ref:`global options<global-configuration>`.
A list of wildcard patterns to identify auxiliary
channels. A pattern is simply checked against a stream
ID, the concatenation of NSLC separated by a period.
This is an obsolete and deprecated setting. Please use
profiles.
.. confval:: picker.auxiliary.minimumDistance
@@ -2972,6 +3198,9 @@ scolv inherits :ref:`global options<global-configuration>`.
unassociated auxiliary channel. Loading a
channel \/ station explicitely \(F3\) will not respect
this setting.
This is an obsolete and deprecated setting. Please use
profiles.
.. confval:: picker.auxiliary.maximumDistance
@@ -2986,6 +3215,68 @@ scolv inherits :ref:`global options<global-configuration>`.
unassociated auxiliary channel. Loading a
channel \/ station explicitely \(F3\) will not respect
this setting.
This is an obsolete and deprecated setting. Please use
profiles.
.. confval:: picker.auxiliary.profiles
Type: *list:string*
A list of auxiliary channel profiles which are enabled.
.. note::
**picker.auxiliary.profiles.$name.\***
$name is a placeholder for the name to be used and needs to be added to :confval:`picker.auxiliary.profiles` to become active.
.. code-block:: sh
picker.auxiliary.profiles = a,b
picker.auxiliary.profiles.a.value1 = ...
picker.auxiliary.profiles.b.value1 = ...
# c is not active because it has not been added
# to the list of picker.auxiliary.profiles
picker.auxiliary.profiles.c.value1 = ...
.. confval:: picker.auxiliary.profiles.$name.channels
Type: *list:string*
A list of wildcard patterns to identify auxiliary
channels. A pattern is simply checked against a stream
ID, the concatenation of NSLC separated by a period.
.. confval:: picker.auxiliary.profiles.$name.minimumDistance
Default: ``0``
Type: *double*
Unit: *deg*
The minimum distance in degrees from origin to load an
unassociated auxiliary channel. Loading a
channel \/ station explicitely \(F3\) will not respect
this setting.
.. confval:: picker.auxiliary.profiles.$name.maximumDistance
Default: ``1000``
Type: *double*
Unit: *deg*
The maximum distance in degrees from origin to load an
unassociated auxiliary channel. Loading a
channel \/ station explicitely \(F3\) will not respect
this setting.
.. note::
@@ -3147,6 +3438,58 @@ scolv inherits :ref:`global options<global-configuration>`.
amplitude time window.
.. confval:: amplitudePicker.defaultNoiseBegin
Default: ``-30``
Type: *double*
Unit: *s*
In case the amplitude time window cannot be computed due
to errors, e.g. computing travel times, this default noise
window start time will be used instead.
.. confval:: amplitudePicker.defaultNoiseEnd
Default: ``0``
Type: *double*
Unit: *s*
In case the amplitude time window cannot be computed due
to errors, e.g. computing travel times, this default noise
window end time will be used instead.
.. confval:: amplitudePicker.defaultSignalBegin
Default: ``0``
Type: *double*
Unit: *s*
In case the amplitude time window cannot be computed due
to errors, e.g. computing travel times, this default signal
window start time will be used instead.
.. confval:: amplitudePicker.defaultSignalEnd
Default: ``30``
Type: *double*
Unit: *s*
In case the amplitude time window cannot be computed due
to errors, e.g. computing travel times, this default signal
window end time will be used instead.
.. confval:: amplitudePicker.filters
Type: *list:string*
@@ -3341,18 +3684,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.
@@ -3362,8 +3709,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -3404,12 +3756,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -3425,6 +3777,10 @@ Cities
.. option:: --city-xml arg
Type: *file*
Values: ``*.xml``
The path to the cities XML file. This overrides the default
paths. Compare with the global parameter \"citiesXML\".

15
share/doc/seiscomp/html/_sources/apps/scqc.rst.txt
View File

@@ -1951,18 +1951,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.
@@ -1972,8 +1976,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -2014,12 +2023,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg

250
share/doc/seiscomp/html/_sources/apps/scqcv.rst.txt
View File

@@ -383,13 +383,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: default.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**default.range.\***
*Range parameters overriding parameters from the general*
@@ -452,13 +445,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: default.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**availability.\***
*Parameters controlling the display of the QC parameter*
@@ -513,13 +499,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: availability.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**availability.range.\***
*Range parameters overriding parameters from the general*
@@ -582,13 +561,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: availability.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**delay.\***
*Parameters controlling the display of the QC parameter 'delay'*
@@ -642,13 +614,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: delay.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**delay.range.\***
*Range parameters overriding parameters from the general*
@@ -711,13 +676,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: delay.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**gap.\***
*Parameters controlling the display of the QC parameter*
@@ -772,13 +730,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: gap.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**gap.range.\***
*Range parameters overriding parameters from the general*
@@ -841,13 +792,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: gap.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**gapLength.\***
*Parameters controlling the display of the QC parameter*
@@ -902,13 +846,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: gapLength.action
Type: *string*
Possible values: enableStream, disableStream.
.. note::
**gapLength.range.\***
*Range parameters overriding parameters from the general*
@@ -971,13 +908,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: gapLength.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**gapInterval.\***
*Parameters controlling the display of the QC parameter 'gaps interval'*
@@ -1031,13 +961,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: gapInterval.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**gapInterval.range.\***
*Range parameters overriding parameters from the general*
@@ -1100,13 +1023,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: gapInterval.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**latency.\***
*Parameters controlling the display of the QC parameter 'latency'*
@@ -1160,13 +1076,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: latency.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**latency.range.\***
*Range parameters overriding parameters from the general*
@@ -1229,13 +1138,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: latency.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**offset.\***
*Parameters controlling the display of the QC parameter 'offset'*
@@ -1291,13 +1193,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: offset.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**offset.range.\***
*Range parameters overriding parameters from the general*
@@ -1360,13 +1255,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: offset.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**overlap.\***
*Parameters controlling the display of the QC parameter 'overlaps count'*
@@ -1420,13 +1308,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: overlap.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**overlap.range.\***
*Range parameters overriding parameters from the general*
@@ -1489,13 +1370,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: overlap.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**overlapInterval.\***
*Parameters controlling the display of the QC parameter 'overlaps interval'*
@@ -1549,13 +1423,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: overlapInterval.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**overlapInterval.range.\***
*Range parameters overriding parameters from the general*
@@ -1618,13 +1485,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: overlapInterval.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**overlapLength.\***
*Parameters controlling the display of the QC parameter*
@@ -1679,13 +1539,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: overlapLength.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**overlapLength.range.\***
*Range parameters overriding parameters from the general*
@@ -1748,13 +1601,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: overlapLength.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**rms.\***
*Parameters controlling the display of the QC parameter 'rms'*
@@ -1808,13 +1654,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: rms.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**rms.range.\***
*Range parameters overriding parameters from the general*
@@ -1877,13 +1716,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: rms.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**spike.\***
*Parameters controlling the display of the QC parameter*
@@ -1938,13 +1770,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: spike.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**spike.range.\***
*Range parameters overriding parameters from the general*
@@ -2007,13 +1832,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: spike.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**spikeAmplitude.\***
*Parameters controlling the display of the QC parameter*
@@ -2068,13 +1886,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: spikeAmplitude.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**spikeAmplitude.range.\***
*Range parameters overriding parameters from the general*
@@ -2137,13 +1948,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: spikeAmplitude.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**spikeInterval.\***
*Parameters controlling the display of the QC parameter*
@@ -2198,13 +2002,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: spikeInterval.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**spikeInterval.range.\***
*Range parameters overriding parameters from the general*
@@ -2267,13 +2064,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: spikeInterval.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**timing.\***
*Parameters controlling the display of the QC parameter*
@@ -2328,13 +2118,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
Activate to display absolute values \(modulus\).
.. confval:: timing.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**timing.range.\***
*Range parameters overriding parameters from the general*
@@ -2397,13 +2180,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: timing.range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**range.\***
*Range parameters defining default values which can be overridden*
@@ -2568,13 +2344,6 @@ scqcv inherits :ref:`global options<global-configuration>`.
A color defined by the color definitions below.
.. confval:: range.$name.action
Type: *string*
Possible values: enableStream, disableStream
.. note::
**color.\***
*Color definitions. More colors can be added by adjusting*
@@ -2842,18 +2611,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.
@@ -2863,8 +2636,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -2905,12 +2683,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -2926,6 +2704,10 @@ Cities
.. option:: --city-xml arg
Type: *file*
Values: ``*.xml``
The path to the cities XML file. This overrides the default
paths. Compare with the global parameter \"citiesXML\".

142
share/doc/seiscomp/html/_sources/apps/screloc.rst.txt
View File

@@ -112,27 +112,39 @@ The following example configuration shows a setup of screloc for
Examples
========
* Run screloc to with a specific velocity model given in a profile by :ref:`NonLinLoc <global_nonlinloc>`.
Use a specific userID and authorID for uniquely recognizing the relocation.
Changing the priority in :ref:`scevent` before running the example, e.g. to
TIME_AUTOMATIC, sets the latest origin (which will be created by screloc) to preferred.
* Relocate all origins given in an :term:`SCML` file according to the
configuration of :program:`screloc`. Write all output to unformatted SCML.
.. code-block:: sh
# set specific velocity profile defined for NonLinLoc
profile=<your_profile>
# set userID
userID="<your_user>"
# set authorID
authorID="<screloc>"
screloc -d localhost --ep origins.xml > origins_screloc.xml
for i in `scevtls -d mysql://sysop:sysop@localhost/seiscomp --begin '2015-01-01 00:00:00' --end '2015-02-01 00:00:00'`; do
* Relocate the previously preferred origins of all events (:ref:`scevtls`)
within some period of time using a specific :ref:`locator <concepts_locators>`
and locator profile.
Use some userID and authorID for uniquely recognizing the relocation.
Configuring the ref:`scevent` parameter :confval:`eventAssociation.priorities`
to TIME_AUTOMATIC before running the example will prefer the latest origin
(which will be created by screloc) for the event the new origin is associated
to. The new origins are automatically sent to the messaging.
orgID=`echo "select preferredOriginID from Event,PublicObject where Event._oid=PublicObject._oid and PublicObject.publicID='$i'" |\
mysql -u sysop -p sysop -D seiscomp -h localhost -N`
.. code-block:: sh
screloc -O $orgID -d localhost --locator NonLinLoc --profile $profile -u $userID --debug --author=$authorID
#!/bin/bash
# locator type
locator=[your_locator]
# locator profile
profile=[your_profile]
# set some userID
userID=[your_user]
# set some authorID
authorID=[screloc]
IFS=',' read -ra events <<< `scevtls -d localhost -p -D , --begin 2025-01-01 --end 2025-02-01`
for event in "${events[@]}"; do
preferredOrigin=$(echo $event | awk '{print $2}')
screloc -d localhost -O $preferredOrigin --locator $locator --profile $profile -u $userID --author=$authorID
done
@@ -253,6 +265,28 @@ screloc inherits :ref:`global options<global-configuration>`.
If not defined, a new publicID will be generated automatically.
.. note::
**picks.\***
*Parameters specific to picks.*
.. confval:: picks.streamsSetUnused
Type: *list:string*
List of streams from which picks are set to unsed by their
referencing arrivals before locating. The concerned arrivals
are kept but the picks will not be used for locating.
Streams take the format NET.STA.LOC.CHA. Wildcards \* and ?
are supported.
Example:
GE.MOX.\*.HH? : All arrivals on any HH stream of station MOX
will be kept but not used for locating.
Command-Line Options
====================
@@ -361,18 +395,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.
@@ -382,8 +420,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -418,36 +461,56 @@ Database
Mode
----
.. option:: --dump
Dump processed origins as XML to stdout. Use in combination
with \-O.
.. option:: --test
Test mode, do not send any message
Test mode, do not send any message.
Input
-----
.. option:: -O, --origin-id arg
Reprocess the origin and send a message unless test mode is activated
.. option:: --locator arg
The locator type to use
Overrides configuration parameter :confval:`reloc.locator`.
.. option:: --use-weight arg
Use current picks weight
.. option:: --profile arg
.. option:: --evaluation-mode arg
Overrides configuration parameter :confval:`reloc.profile`.
set origin evaluation mode: \"AUTOMATIC\" or \"MANUAL\"
.. option:: --ep file
.. option:: --ep arg
Defines an event parameters XML file to be read and processed. This
implies offline mode and only processes all origins contained
in that file. Each relocated origin is appended to the list
of origins unless \-\-replace is given.
Event parameters XML file for offline processing of all
contained origins. This option should not be mixed with
\-\-dump.
.. option:: -O, --origin-id arg
Reprocess the origin and send a message unless test mode is
activated.
.. option:: --use-weight
Overrides configuration parameter :confval:`reloc.useWeight`.
.. option:: --streams-set-unused arg
Overrides configuration parameter :confval:`picks.streamsSetUnused`.
Type: *list:string*
List of streams from which picks are set to unsed by their
referencing arrivals before locating. The concerned arrivals
are kept but the picks will not be used for locating.
Streams take the format NET.STA.LOC.CHA. Wildcards \* and ?
are supported.
.. option:: --replace
@@ -457,6 +520,23 @@ Input
NonLinLoc origins out. All other objects are passed through.
Output
------
.. option:: --evaluation-mode
Evaluation mode of the new origin \(AUTOMATIC or MANUAL\).
.. option:: -f, --formatted
Use formatted XML output. Otherwise XML is unformatted.
.. option:: --origin-id-suffix
Create origin ID from that of the input origin plus the
specfied suffix.
Profiling
---------
@@ -466,5 +546,7 @@ Profiling
.. option:: --repeated-relocations arg
improve measurement of relocation time by running each relocation multiple times. Specify the number of relocations, e.g. 100.
Improve measurement of relocation time by running each
relocation multiple times. Specify the number of relocations,
e.g. 100.

17
share/doc/seiscomp/html/_sources/apps/screpick.rst.txt
View File

@@ -180,12 +180,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -202,7 +202,7 @@ Input
.. option:: --ep file
Name of input XML file \(SCML\) with all picks for offline
processing.
processing. Use '\-' to read from stdin.
Picker
@@ -217,3 +217,12 @@ Picker
Accept any pick regardless of its phase hint.
Output
------
.. option:: -f, --formatted
Use formatted XML output along with '\-\-ep'. Otherwise XML
is unformatted.

128
share/doc/seiscomp/html/_sources/apps/scrttv.rst.txt
View File

@@ -80,7 +80,7 @@ Among the configurable parameters are:
* trace properties and trace background colors,
* font and general GUI parameters.
More parameters are available on the command-line:
More options are available on the command-line:
.. code-block:: sh
@@ -493,6 +493,52 @@ will not store the origin in the database and works the same way as creating
:ref:`artificial origins <scrttv-artificial-origins>`.
.. _scrttv-applications:
Applications
============
#. View waveforms with default settings printing debug information
.. code-block:: sh
scrttv --debug
#. View 3C data from default recordstream 3 hours before midnight. All available
picks are displayed.
.. code-block:: sh
scrttv --buffer-size 10800 --end-time 2022-06-01 --map-picks
#. View data from a miniSEED file in offline mode without messaging
.. code-block:: sh
scrttv file.mseed
#. View all HH streams from stations CX.PB01 and CX.PB02 without messaging and
inventory
.. code-block:: sh
scrttv --offline --no-inventory --channels CX.PB01.*.HH? --channels CX.PB02.*.HH?
#. View the miniSEED data from all file ending with .mseed which are read from
stdin
.. code-block:: sh
cat *.mseed | scrttv -
#. View miniSEED data played back from archive at normal speed as in real time
using :ref:`scart`
.. code-block:: sh
scart -dmv -t 2026-05-01~2026-05-02 /archive | scrttv -I - --offline --no-inventory
.. _scrttv-hot-keys:
Hotkeys
@@ -635,7 +681,7 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. confval:: filters
Default: ``"RMHP(2)>>ITAPER(5)>>BW(3,0.5,8.0)","RMHP(2)>>ITAPER(5)>>BW_HP(3, 3)"``
Default: ``"BW 0.5 - 8.0 Hz;RMHP(2)>>ITAPER(5)>>BW(3, 0.5, 8.0)","HP 3.0 Hz;RMHP(2)>>ITAPER(5)>>BW_HP(3, 3)"``
Type: *list:string*
@@ -770,7 +816,7 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. confval:: streams.rows
Type: *integer*
Type: *int*
Number of rows to show at once in one windows. If more traces
than rows are loaded, the are accessible by a scroll bar.
@@ -804,8 +850,9 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *string*
The sort mode applied initially. Allowed values
are: config, distance, station, network, group.
Values: ``config,distance,station,network,group``
The mode applied initially for sorting traces.
.. confval:: streams.sort.latitude
@@ -928,7 +975,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. note::
**streams.group.$name.pen.\***
*Define the trace pen of the group.*
*Define the trace pen of the group. Read the SeisComP*
*GUI documenation for full details.*
@@ -967,13 +1015,13 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. confval:: streams.group.$name.pen.style
Default: ``SolidLine``
Default: ``solidline``
Type: *string*
The style of the pen. Supported values are: NoPen,
SolidLine, DashLine, DotLine, DashDotLine,
DashDotDotLine.
Values: ``nopen,solidline,dashline,dotline,dashdotline,dashdotdotline``
The line style of the pen.
.. confval:: streams.group.$name.pen.width
@@ -984,7 +1032,7 @@ scrttv inherits :ref:`global options<global-configuration>`.
Unit: *px*
The width of the pen.
The line width of the pen.
.. note::
@@ -1102,6 +1150,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``nopen,solidline,dashline,dotline,dashdotline,dashdotdotline``
@@ -1116,7 +1166,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. note::
**streams.profile.$name.minimum.brush.\***
*Properties of the area below the minimum.*
*Properties of the area below the minimum. Read*
*the SeisComP GUI documenation for full details.*
@@ -1126,6 +1177,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagross``
@@ -1155,7 +1208,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. note::
**streams.profile.$name.maximum.pen.\***
*Line properties.*
*Line properties. Read the SeisComP GUI*
*documenation for full details.*
@@ -1174,6 +1228,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``nopen,solidline,dashline,dotline,dashdotline,dashdotdotline``
@@ -1188,7 +1244,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
.. note::
**streams.profile.$name.maximum.brush.\***
*Properties of the area above the maximum.*
*Properties of the area above the maximum. Read*
*the SeisComP GUI documenation for full details.*
@@ -1198,6 +1255,8 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *string*
Values: ``solid,dense1,dense2,dense3,dense4,dense5,dense6,dense7,nobrush,horizontal,vertical,cross,bdiag,fdiag,diagross``
@@ -1274,8 +1333,9 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *string*
Which amplitude normalization mode to use: \"fixed\",
\"frequency\" or \"time\".
Values: ``fixed,frequency,time``
The amplitude normalization mode to use.
.. confval:: spectrogram.axis
@@ -1284,7 +1344,7 @@ scrttv inherits :ref:`global options<global-configuration>`.
Type: *boolean*
Whether to show the frequency axis.
Show the frequency axis.
.. confval:: spectrogram.minimumAmplitude
@@ -1474,18 +1534,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.
@@ -1495,8 +1559,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -1537,12 +1606,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg
@@ -1568,6 +1637,7 @@ Mode
Overrides configuration parameter :confval:`filter`.
.. option:: --offline
Do not connect to a messaging server and do not use the
@@ -1589,10 +1659,12 @@ Mode
Overrides configuration parameter :confval:`bufferSize`.
.. option:: --max-delay arg
Overrides configuration parameter :confval:`maxDelay`.
.. option:: --start-at-now
Subscribe to data starting at now rather than now \- bufferSize
@@ -1607,16 +1679,20 @@ Mode
Overrides configuration parameter :confval:`mapPicks`.
.. option:: --3c
Overrides configuration parameter :confval:`3c`.
.. option:: --channels
Channel\(s\) to display. The channel code may contain wildcards
at any position but the support of wildcards depends on
RecordStream. Repeat the option for multiple
channel groups. Examples:
Channel\(s\) to display. The corresponding rows are only shown
when data for the considered time window is available.
The channel code may contain wildcards at any position but
the support of wildcards depends on RecordStream.
Repeat the option for multiple channel groups. Examples:
default : all streams configured by global bindings.
@@ -1628,6 +1704,10 @@ Cities
.. option:: --city-xml arg
Type: *file*
Values: ``*.xml``
The path to the cities XML file. This overrides the default
paths. Compare with the global parameter \"citiesXML\".

6
share/doc/seiscomp/html/_sources/apps/scsendjournal.rst.txt
View File

@@ -211,18 +211,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.
@@ -230,6 +234,8 @@ Messaging
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

6
share/doc/seiscomp/html/_sources/apps/scsendorigin.rst.txt
View File

@@ -120,18 +120,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.
@@ -139,6 +143,8 @@ Messaging
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

208
share/doc/seiscomp/html/_sources/apps/scsmdump.rst.txt Normal file
View File

@@ -0,0 +1,208 @@
.. highlight:: rst
.. _scsmdump:
########
scsmdump
########
**Strong motion parameters database dump.**
Description
===========
scsmdump ...
.. _scsmdump_configuration:
Module Configuration
====================
| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/scsmdump.cfg`
| :file:`etc/global.cfg`
| :file:`etc/scsmdump.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/scsmdump.cfg`
scsmdump inherits :ref:`global options<global-configuration>`.
Command-Line Options
====================
.. program:: scsmdump
Generic
-------
.. option:: -h, --help
Show help message.
.. option:: -V, --version
Show version information.
.. option:: --config-file arg
Use alternative configuration file. When this option is
used the loading of all stages is disabled. Only the
given configuration file is parsed and used. To use
another name for the configuration create a symbolic
link of the application or copy it. Example:
scautopick \-> scautopick2.
.. option:: --plugins arg
Load given plugins.
.. option:: -D, --daemon
Run as daemon. This means the application will fork itself
and doesn't need to be started with \&.
.. option:: --auto-shutdown arg
Enable\/disable self\-shutdown because a master module shutdown.
This only works when messaging is enabled and the master
module sends a shutdown message \(enabled with \-\-start\-stop\-msg
for the master module\).
.. option:: --shutdown-master-module arg
Set the name of the master\-module used for auto\-shutdown.
This is the application name of the module actually
started. If symlinks are used, then it is the name of
the symlinked application.
.. option:: --shutdown-master-username arg
Set the name of the master\-username of the messaging
used for auto\-shutdown. If \"shutdown\-master\-module\" is
given as well, this parameter is ignored.
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, eg. \-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:: --log-file arg
Use alternative log file.
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 .
.. option:: --db-disable
Do not use the database at all
Input
-----
.. option:: -O, --origin originID
Origin public ID\(s\) to dump. Multiple origins may be specified
as a comma\-separated list. Use \"\-\" for reading from stdin.
.. option:: -E, --event eventID
Event public ID\(s\) to dump. Multiple events may be specified
as a comma\-separated list. Use \"\-\" for reading from stdin.
Dump
----
.. option:: -r, --with-event-records
Include event record references. This option is necessary in order to export the records itself.
.. option:: -S, --with-records
Include records referred to from event records. This option depends on \-\-with\-event\-records.
.. option:: -R, --with-ruptures
Include ruptures.
.. option:: -p, --preferred-only
When dumping events, only the preferred origin will be dumped.
Output
------
.. option:: -f, --formatted
Use formatted XML output.
.. option:: -o, --output file
Name of output file. If not given or '\-', output
is sent to stdout.

9
share/doc/seiscomp/html/_sources/apps/scsohlog.rst.txt
View File

@@ -192,18 +192,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.
@@ -213,8 +217,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

23
share/doc/seiscomp/html/_sources/apps/scvoice.rst.txt
View File

@@ -179,7 +179,7 @@ scvoice inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.amplitude
Type: *string*
Type: *file*
Specify the script to be called if an amplitude
arrives, network\-, stationcode and amplitude are passed
@@ -188,7 +188,7 @@ scvoice inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.alert
Type: *string*
Type: *file*
Specify the script to be called if a preliminary
origin arrives, latitude and longitude are passed as
@@ -197,7 +197,7 @@ scvoice inherits :ref:`global options<global-configuration>`.
.. confval:: scripts.event
Type: *string*
Type: *file*
Specify the script to be called when an event has been
declared; the message string, a flag \(1\=new event,
@@ -269,6 +269,7 @@ Generic
Overrides configuration parameter :confval:`firstNew`.
Verbosity
---------
@@ -320,18 +321,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.
@@ -341,8 +346,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -379,21 +389,26 @@ Alert
.. option:: --amp-type arg
Default: ``snr``
Specify the amplitude type to listen to.
.. option:: --amp-script arg
Overrides configuration parameter :confval:`scripts.amplitude`.
.. option:: --alert-script arg
Overrides configuration parameter :confval:`scripts.alert`.
.. option:: --event-script arg
Overrides configuration parameter :confval:`scripts.event`.
Cities
------
@@ -401,11 +416,13 @@ Cities
Overrides configuration parameter :confval:`poi.maxDist`.
.. option:: --min-population arg
Overrides configuration parameter :confval:`poi.minPopulation`.
Debug
-----

20
share/doc/seiscomp/html/_sources/apps/scwfas.rst.txt
View File

@@ -21,12 +21,6 @@ SDS archive via different protocols. Currently there are two implementations:
* dataselect/1/version
* dataselect/1/application.wadl
* Arclink (deprecated)
This application is meant to share data with trusted computers in a fast and
efficient way. It does not require inventory information and supports wildcards
on each level.
All data are forwarded unrestricted. There are no options to add restriction
checks or user authentication.
@@ -67,17 +61,6 @@ scwfas inherits :ref:`global options<global-configuration>`.
as input to setSource\(\).
.. confval:: arclink.port
Default: ``-1``
Type: *int*
The server port for Arclink connections. \-1
deactivates the Arclink server. The standard Arclink port is
18001.
.. confval:: fdsnws.port
Default: ``8080``
@@ -213,11 +196,14 @@ Server
Overrides configuration parameter :confval:`arclink.port`.
.. option:: --fdsnws-port int
Overrides configuration parameter :confval:`fdsnws.port`.
.. option:: --fdsnws-baseurl string
Overrides configuration parameter :confval:`fdsnws.baseURL`.

15
share/doc/seiscomp/html/_sources/apps/scwfparam.rst.txt
View File

@@ -1241,18 +1241,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.
@@ -1262,8 +1266,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
.. option:: --test
@@ -1308,12 +1317,12 @@ Records
.. option:: -I, --record-url arg
The recordstream source URL, format:
The RecordStream source URL. Format:
[service:\/\/]location[#type].
\"service\" is the name of the recordstream driver
\"service\" is the name of the RecordStream driver
which can be queried with \"\-\-record\-driver\-list\".
If \"service\" is not given, \"file:\/\/\" is
used.
used and simply the name of a miniSEED file can be given.
.. option:: --record-file arg

193
share/doc/seiscomp/html/_sources/apps/scxmldump.rst.txt
View File

@@ -6,28 +6,36 @@
scxmldump
#########
**Dump database objects to XML files.**
**Dump objects from database or messaging to XML.**
Description
===========
scxmldump reads various parameters from a SeisComP database:
scxmldump reads SeisComP objects from database or messaging and writes them
in SeisComP XML (:term:`SCML`) to stdout or into a file (:option:`-o`).
* Availability,
* Config (bindings parameters),
* Event parameters,
* Inventory,
* Journal,
* Routing.
* Dumping from a SeisComP database supports various
:ref:`objects <api-datamodel-python>`:
The parameters are sent to stdout or written into an XML (:term:`SCML`) file.
* Availability,
* Config (bindings parameters),
* Event parameters,
* Inventory,
* Journal,
* Routing.
* Dumping from a SeisComP messaging (:option:`--listen`) considers only event
parameters.
.. note::
Waveform quality control (QC) parameters can be read from databases using
:ref:`scqcquery`.
* Furthermore any object carrying a publicID can be retrieved from the database
including its hierarchie or not. See :ref:`scxmldump-public-objects`.
Event parameters
----------------
@@ -36,7 +44,7 @@ To get event, origin or pick information from the database without using SQL
commands is an important task for the user. :ref:`scxmldump` queries the
database and transforms that information into XML. Events and origins can be
treated further by :ref:`scbulletin` for generating bulletins or conversion
into KML.
into other formats including KML.
Many processing modules, e.g., :ref:`scevent` support the on-demand processing
of dumped event parameters by the command-line option :option:`--ep`.
@@ -51,6 +59,39 @@ and sending to a SeisComP messaging is provided by :ref:`scdispatch`.
tools like :ref:`scolv` or used database queries assisted by :ref:`scquery`.
.. _scxmldump-public-objects:
PublicObjects
-------------
The option :option:`--public-id` defines a list of publicIDs to be retrieved
from the database. As the data model is extendable via plugins and custom code,
scxmldump cannot know all of those object types and how to retrieve them
from the database. If a publicID belongs to a type for which the code resides
in another library or plugin, then scxmldump must load this plugin or library
in order to find the correct database tables. For example, if a strong motion
object should be dumped, then the plugin dmsm must be loaded into scxmldump.
.. code-block:: sh
scxmldump -d localhost --plugins dbmysql,dmsm --public-id StrongMotionOrigin/123456
This command would only export the StrongMotionOrigin itself without all
child objects. Option :option:`--with-childs` must be passed to export the
full hierarchy:
.. code-block:: sh
scxmldump -d localhost --plugins dbmysql,dmsm --public-id StrongMotionOrigin/123456 --with-childs
If the extension code resides in a library then LD_PRELOAD can be used to inject
the code into scxmldump:
.. code-block:: sh
LD_PRELOAD=/home/sysop/seiscomp/lib/libseiscomp_datamodel_sm.so scxmldump -d localhost --public-id StrongMotionOrigin/123456 --with-childs
Format conversion
-----------------
@@ -62,58 +103,62 @@ An XSD schema of the XML output can be found under
Examples
--------
Dump inventory
* Dump inventory
.. code-block:: sh
.. code-block:: sh
scxmldump -fI -o inventory.xml -d mysql://sysop:sysop@localhost/seiscomp
scxmldump -d mysql://sysop:sysop@localhost/seiscomp -fI -o inventory.xml
Dump config (bindings parameters)
* Dump config (bindings parameters)
.. code-block:: sh
.. code-block:: sh
scxmldump -fC -o config.xml -d mysql://sysop:sysop@localhost/seiscomp
scxmldump -d localhost -fC -o config.xml
Dump full event data incl. the relevant journal entries
* Dump full event data including the relevant journal entries
.. code-block:: sh
.. code-block:: sh
scxmldump -fPAMFJ -E test2012abcd -o test2012abcd.xml \
-d mysql://sysop:sysop@localhost/seiscomp
scxmldump -d localhost -fPAMFJ -E test2012abcd -o test2012abcd.xml
* Dump full event data. Event IDs are provided by :ref:`scevtls` and received
from stdin
Dump summary event data
.. code-block:: sh
.. code-block:: sh
scevtls -d localhost --begin 2025-01-01 |\
scxmldump -d localhost -fPAMF -E - -o events.xml
scxmldump -fap -E test2012abcd -o test2012abcd.xml \
-d mysql://sysop:sysop@localhost/seiscomp
* Dump summary event data
.. code-block:: sh
Create bulletin from an event
scxmldump -d localhost -fap -E test2012abcd -o test2012abcd.xml
.. code-block:: sh
* Create bulletin from an event using :ref:`scbulletin`
scxmldump -fPAMF -E test2012abcd
-d mysql://sysop:sysop@localhost/seiscomp | \
scbulletin
.. code-block:: sh
scxmldump -d localhost -fPAMF -E test2012abcd | scbulletin
Copy event parameters to another database
* Copy event parameters to another database
.. code-block:: sh
.. code-block:: sh
scxmldump -fPAMF -E test2012abcd \
-d mysql://sysop:sysop@localhost/seiscomp | \
scdb -i - -d mysql://sysop:sysop@archive-db/seiscomp
scxmldump -d localhost -fPAMF -E test2012abcd |\
scdb -i - -d mysql://sysop:sysop@archive-db/seiscomp
* Dump the entire journal:
Export the entire journal:
.. code-block:: sh
.. code-block:: sh
scxmldump -d localhost -fJ -o journal.xml
scxmldump -fJ -o journal.xml \
-d mysql://sysop:sysop@localhost/seiscomp
* Dump events received from messaging on local computer:
.. code-block:: sh
scxmldump -H localhost/production --listen
.. _scxmldump_configuration:
@@ -242,18 +287,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.
@@ -263,8 +312,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.
@@ -300,11 +354,6 @@ Database
Dump
----
.. option:: --listen
Enable server mode which listens to the message server for
incoming events and dumps each received add\/update.
.. option:: -I, --inventory
Dump the inventory.
@@ -315,7 +364,7 @@ Dump
.. option:: --stations sta-list
If inventory is exported, filter the stations to export.
If inventory is dumped, filter the stations to dump.
Wildcards are supported. Format of each item: net[.{sta\|\*}].
.. option:: -C, --config
@@ -337,22 +386,25 @@ Dump
.. option:: --with-segments
Dump individual data segments.
Dump individual data segments. Requires
\"\-\-availability\".
.. option:: --pick ID
.. option:: --listen
Pick public ID\(s\) to dump. Multiple IDs may be specified
as a comma\-separated list.
.. option:: -O, --origin ID
Origin public ID\(s\) to dump. Multiple origins may be specified
as a comma\-separated list.
Listen to the message server for incoming events. Otherwise
scxmldump reads from database.
.. option:: -E, --event ID
Event public ID\(s\) to dump. Multiple events may be specified
as a comma\-separated list.
as a comma\-separated list. Use \"\-\" for reading the IDs as
individual lines from stdin.
.. option:: -O, --origin ID
Origin public ID\(s\) to dump. Multiple origins may be specified
as a comma\-separated list. Use \"\-\" for reading the IDs as
individual lines from stdin
.. option:: -P, --with-picks
@@ -372,24 +424,47 @@ Dump
.. option:: -a, --ignore-arrivals
Do not dump arrivals part of origins.
Do not dump arrivals of origins.
.. option:: --ignore-magnitudes
Do not export \(network\) magnitudes of origins. This
Do not dump \(network\) magnitudes of origins. This
option is most useful in combination with \-O to only
export the location information.
dump the location information.
.. option:: -p, --preferred-only
When exporting events only the preferred origin, the preferred
When dumping events only the preferred origin, the preferred
magnitude and the preferred focal mechanism will be dumped.
.. option:: -m, --all-magnitudes
If only the preferred origin is exported, all magnitudes for
If only the preferred origin is dumped, all magnitudes for
this origin will be dumped.
.. option:: --pick ID
ID\(s\) of pick\(s\) to dump. Use '\-' to read the IDs as
individual lines from stdin.
.. option:: --public-id ID
ID\(s\) of any object\(s\) to dump. Use '\-' to read the IDs as
individual lines from stdin. No parent objects are dumped.
.. option:: --with-childs
Dump also all child objects of dumped objects. Valid only in
combination with \-\-public\-id.
.. option:: --with-root
Whether to add the container of exported PublicObjects or
not. Objects which are not a direct child of
EventParameters, Inventory and so on, also referred to as
top\-level objects, will not be exported.
Valid in combination with \-\-public\-id.
Output
------

56
share/doc/seiscomp/html/_sources/apps/seedlink.rst.txt
View File

@@ -12,8 +12,9 @@ seedlink
Description
===========
SeedLink is a real-time data acquisition protocol and a client-server software
that implements this protocol. The SeedLink protocol is based on TCP. All
SeedLink serves miniSEED data to clients in real times. It is a real-time data
acquisition protocol and a client-server software that implements this protocol.
The SeedLink protocol is based on TCP. All
connections are initiated by the client. During handshaking phase the client can
subscribe to specific stations and streams using simple commands in ASCII coding.
When handshaking is completed, a stream of SeedLink "packets" consisting of a
@@ -26,30 +27,42 @@ manufacturers have implemented SeedLink in their digitizer firmware. All
implementations are generally compatible, but not all of them support the full
SeedLink protocol. On the other hand IRIS DMC implements some extensions which
are not supported by other servers. In the following we use "SeedLink" to denote
the SeedLink implementation used in SeisComP. The data source of a SeedLink
server can be anything which is supported by a SeedLink plugin - a small program
the SeedLink implementation used in SeisComP.
The data source of a SeedLink server can be anything which is supported by a
:ref:`SeedLink plugin <seedlink-sources>` - a small program
that sends data to the SeedLink server. Plugins are controlled by the SeedLink
server, e.g., a plugin is automatically restarted if it crashes or a timeout
occurs. Data supplied by a plugin can be a form of miniSEED packets or just
raw integer samples with accompanying timing information. In the latter case,
the SeedLink server uses an inegrated "Stream Processor" to create the desired
the SeedLink server uses an integrated "Stream Processor" to create the desired
data streams and assemble miniSEED packets.
.. note::
SeedLink supports by default miniSEED records with a size of 512 bytes which
is hardcoded. For serving records with other sizes, e.g., 4096 bytes,
SeedLink must be recompiled with a modified variable *MSEED-RECLEN* located
in :file:`seedlink/apps/seedlink/iosystem.h` of the SeedLink repository.
.. _seedlink-sources:
Supported data sources
----------------------
The table below lists digitizers and data acquisition systems that are supported by
SeedLink plugins. More plugins (Kinemetrics K2, Lennartz MARS-88, Lennartz PCM
5800, etc.) have been implemented by various users, but are not (yet) included
in the package. The included C language plugin interface is described in
section 5.1.1.5. Antelope, Earthworm and NAQS can also import data from
SeisComP. In SeisComP the class :ref:`RecordStream <global_recordstream>` is implemented that supports both
The table below lists digitizers and data acquisition systems and the SeedLink
plugins supporting these system. More plugins (Kinemetrics K2, Lennartz MARS-88,
Lennartz PCM 5800, etc.) have been implemented by various users, but are not
(yet) included in the package. The included C language plugin interface is
described in section 5.1.1.5. Antelope, Earthworm and NAQS can also import data
from SeisComP. In SeisComP the class :ref:`RecordStream <global_recordstream>`
is implemented that supports both
SeedLink and ArcLink sources; this class is used by all SeisComP modules that
work with waveform data. On a lower level, SeedLink clients can be implemented
using the :cite:t:`libslink` software library or its Java counterpart, JSeedLink. Libslink
supports Linux/UNIX, Windows and MacOS X platforms, and comes with an exhaustive
documentation in form of UNIX manual pages.
using the :cite:t:`libslink` software library or its Java counterpart,
JSeedLink. Libslink supports Linux/UNIX, Windows and MacOS X platforms, and
comes with an exhaustive documentation in form of UNIX manual pages.
.. csv-table::
:widths: 2 3 5
@@ -67,15 +80,16 @@ documentation in form of UNIX manual pages.
:ref:`seedlink-sources-ewexport_pasv-label`, Earthworm passive export server (TCP/IP), Chad Trabant (IRIS)
:ref:`seedlink-sources-fs_mseed-label` , miniSEED file plugin, GFZ
:ref:`seedlink-sources-gdrt-label` , GDRT server, GFZ
:ref:`seedlink-sources-gmeteo-label` , GFZ meteo protocol, GFZ
:ref:`seedlink-sources-hrd24-label` , Nanometrics HRD24, GFZ; Recai Yalgin
:ref:`seedlink-sources-liss-label` , LISS, Chad Trabant (IRIS)
:ref:`seedlink-sources-m24-label` * , Lennartz M24, Lennartz Electronic GmbH
:ref:`seedlink-sources-maram-label` , maRam Weatherstation V1, GFZ
:ref:`seedlink-sources-minilogger-label` , SEP064 USB Seismometer Interface, GFZ; Anthony Lomax
:ref:`seedlink-sources-mseedfifo-label` , Generic, GFZ
:ref:`seedlink-sources-mseedscan-label` , Transfers miniSEED files from a directory, Chad Trabant (IRIS)
:ref:`seedlink-sources-mk6-label` * , MK6, Jan Wiszniowski (IGPAS)
:ref:`seedlink-sources-mppt-label` * , SunSaver MPPT via Modbus TCP/IP, GFZ
:ref:`seedlink-sources-mseedfifo-label` , Generic, GFZ
:ref:`seedlink-sources-mseedscan-label` , Transfers miniSEED files from a directory, Chad Trabant (IRIS)
:ref:`seedlink-sources-mws-label` , Reinhardt MWS5/MWS9 Weather Station, GFZ
:ref:`seedlink-sources-naqs-label` , NAQS, "Chad Trabant (IRIS); based on sample code from Nanometrics, Inc."
:ref:`seedlink-sources-nmxp-label` * , NAQS, Matteo Quintiliani (INGV)
@@ -269,10 +283,10 @@ In these files the following public functions are defined:
is used to send a raw packet (array of 32-bit integer samples) to SeedLink. The parameters are:
station
station ID, must match one of the defined stations in seedlink.ini. (Up to 10 characters.)
station ID, must match one of the defined stations in :file:`seedlink.ini`. (Up to 10 characters.)
channel
channel ID, referenced by the "input" element in streams.xml. (Up to 10 characters.)
channel ID, referenced by the "input" element in :file:`streams.xml`. (Up to 10 characters.)
pt
time of the first sample in the array. If NULL then time is calculated relative to the previous send_raw3() call. struct ptime is defined in :file:`plugin.h`.
@@ -281,7 +295,7 @@ usec_correction
time correction in microseconds to be written in the SEED data header. Can be useful if the digitizer is not phase locked to GPS.
timing_quality
timing quality in percent (0-100). The number is directly written into miniSEED header (blockette 1001). Semantics is implementation-defined. Usually 100 means that GPS is in lock and 0 means there never was a GPS lock, so the timing is completely unreliable. When GPS goes out of lock, the value can slowly decrease reflecting a possible timedrift.
timing quality in percent (0-100). The number is directly written into miniSEED header (blockette 1001). Semantics is implementation-defined. Usually 100 means that GPS is in lock and 0 means there never was a GPS lock, so the timing is completely unreliable. When GPS goes out of lock, the value can slowly decrease reflecting a possible time drift.
dataptr
Array of signed 32-bit samples.
@@ -481,7 +495,7 @@ Module Configuration
.. note::
seedlink is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
seedlink is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
| :file:`etc/defaults/seedlink.cfg`
@@ -1132,7 +1146,7 @@ Seedlink server (TCP/IP)
.. confval:: sources.chain.address
Default: ``geofon.gfz-potsdam.de``
Default: ``geofon.gfz.de``
Type: *string*

12
share/doc/seiscomp/html/_sources/apps/seiscomp.rst.txt
View File

@@ -159,7 +159,7 @@ categories. Examples:
.. _sec_seiscomp_enable:
Enable/disable [*]_
Enable/disable [1]_
-------------------
Enabled modules will be started to run as a background daemon module.
@@ -174,7 +174,7 @@ You may enable or disable one or multiple modules. Examples:
.. _sec_seiscomp_start:
Start/stop/restart/reload [*]_
Start/stop/restart/reload [1]_
------------------------------
Start all enabled modules:
@@ -214,7 +214,7 @@ modules and parameters.
.. _sec_seiscomp_check:
Check [*]_
Check [1]_
----------
When modules stop unexpectedly, they are not stopped in a clean way. Such
@@ -256,7 +256,7 @@ Examples:
.. _sec_seiscomp_status:
Status [*]_
Status [1]_
-----------
List the status of all, enabled, disabled, started, or specific modules.
@@ -320,7 +320,7 @@ interactively.
.. _sec_seiscomp_update:
Update configuration [*]_
Update configuration [1]_
-------------------------
The command :command:`update-config` allows reading bindings configurations from
@@ -431,7 +431,7 @@ seiscomp shell:
.. note::
.. [*] With this command, the flag :option:`--invert` can be used
.. [1] With this command, the flag :option:`--invert` can be used
in order to invert the application to the specific modules. You may provide
one or more module names. A major application is to
restart most |scname| modules after a change in global bindings. However,

9
share/doc/seiscomp/html/_sources/apps/sh2proc.rst.txt
View File

@@ -311,18 +311,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.
@@ -332,8 +336,13 @@ Messaging
Overrides configuration parameter :confval:`connection.contentType`.
Default: ``binary``
.. option:: --start-stop-msg arg
Default: ``0``
Set sending of a start and a stop message.

2
share/doc/seiscomp/html/_sources/apps/slarchive.rst.txt
View File

@@ -131,7 +131,7 @@ Module Configuration
.. note::
slarchive is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
slarchive is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
| :file:`etc/defaults/slarchive.cfg`

6
share/doc/seiscomp/html/_sources/apps/slinktool.rst.txt
View File

@@ -257,6 +257,10 @@ General program options
.. option:: -nd delay
Default: ``30``
Unit: *s*
The network reconnect delay for the connection to the SeedLink server.
If the connection breaks for any reason this will govern how soon a reconnection should
be attempted.
@@ -270,6 +274,8 @@ General program options
.. option:: -k interval
Unit: *s*
Interval at which keepalive \(heartbeat\) packets are sent to the server.
Keepalive packets are only sent if nothing is received within the interval.

2
share/doc/seiscomp/html/_sources/apps/slmon.rst.txt
View File

@@ -81,7 +81,7 @@ Module Configuration
.. note::
slmon is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
slmon is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
| :file:`etc/defaults/slmon.cfg`

148
share/doc/seiscomp/html/_sources/apps/slmon2.rst.txt Normal file
View File

@@ -0,0 +1,148 @@
.. highlight:: rst
.. _slmon2:
######
slmon2
######
**SeedLink monitor creating web pages**
.. _slmon2_configuration:
Module Configuration
====================
.. note::
slmon2 is a :term:`standalone module` and does not inherit :ref:`global options <global-configuration>`.
| :file:`etc/defaults/slmon2.cfg`
| :file:`etc/slmon2.cfg`
| :file:`~/.seiscomp/slmon2.cfg`
.. confval:: title
Default: ``"SeedLink Monitor"``
Type: *string*
Title of the web page used as heading.
.. confval:: refresh
Default: ``180``
Type: *double*
Unit: *s*
Refresh interval of the generated web page used by the browser.
The interval should be similar to the interval for starting slmon.
If empty, the web page must be manually refreshed from within
the browser.
.. confval:: address
Default: ``127.0.0.1``
Type: *string*
Host of the Seedlink server to connect to. If the acquisition
is running on one system nothing needs to be changed.
.. confval:: port
Default: ``18000``
Type: *int*
The port of the Seedlink server to connect to. If the acquisition
is running on one system this port must match the configured
local Seedlink port.
.. confval:: email
Type: *string*
e\-mail address added to web pages.
.. confval:: wwwdir
Default: ``@ROOTDIR@/var/run/@NAME@``
Type: *string*
Output directory of the web pages.
.. confval:: icon
Default: ``http://www.gfz-potsdam.de/favicon.ico``
Type: *string*
Favicon URL of the web pages. Not mandatory.
.. confval:: linkname
Default: ``GEOFON``
Type: *string*
Name of Link shown in footer of web pages.
.. confval:: linkurl
Default: ``http://www.gfz-potsdam.de/geofon/``
Type: *string*
URL referred to by linkname in footer of web pages.
.. confval:: liveurl
Default: ``http://geofon.gfz-potsdam.de/waveform/liveseis.php?station=%s``
Type: *string*
URL to live seismograms. %s will be replaced by station name.
Not mandatory.
.. confval:: fdsnws_url
Default: ``http://localhost:8080/fdsnws/``
Type: *string*
FDSNWS base URL. Used to get station coordinates.
Bindings Parameters
===================
.. confval:: group
Default: ``local``
Type: *string*
Defines the group of the station that is monitored.