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.

228
share/doc/seiscomp/html/_sources/base/CHANGELOG.md.txt
View File

@ -2,68 +2,187 @@
All notable changes to SeisComP are documented here.
## 6.9.0
## x.y.z
```SC_API_VERSION 16.4.0```
```SC_API_VERSION 17.0.0```
- fdsnxml2inv
- Fix samplerate conversion from double to fraction.
- scmv
- Fix crash if origin depth is not set.
- fdsnws
- Fix data availability sort for Python >= 3.13.
- Fix conditional station requests. Requests involving the
If-Modified-Since header failed since Twisted
version 24.7. The http.stringToDatetime() now requires a
byte string.
With this version we add support for Qt 6 of all GUI applications. Binary distributions
will build against the Qt version which is available by default in the respective
Linux distribution, either Qt 5 or Qt 6.
The database schema changes from version 0.13.2 to 0.14. This basically incorporates
the addition of a new object `Catalog` as part of the EventParameters datamodel and
changes indexes from object `QCLog`. Both objects are not yet used in SeisComP and
they are added as basis for new features. The database schema applies changes in its
datatypes: BLOBS will be converted to LONGTEXT (MySQL) or TEXT (PostgreSQL, SQLite3).
The database migration to schema version 0.14 can be a long lasting operation so
please schedule a downtime of your system accordingly.
Furthermore the foreign key constraints from a concrete type table like Origin to
the Object table is removed. This constraint was never required by SeisComP itself
as it takes care of correct removal of all derived table rows but it introduces a
performance penalty when deleting objects. Dropping the constraint might affect
custom database script which rely on it. Please be aware of that change.
- seiscomp
- Fix module count with `seiscomp status`
- documentation
- Consider new parameters `values` and `range` in description of
configuration and command-line parameters which will be highlighted in
documentation and exposed in scconfig.
- trunk
- Fix LOCSAT station correction file lookup if `SEISCOMP_LOCSAT_TABLE_DIR`
environment variable is being used.
- Decode tokens when parsing a URL.
- scevent
- Provide optional REST API to return the target event an origin would be
associated to.
## 6.8.4
- scevent
- Read `eventAssociation.minimumScore` from configuration.
## 6.8.3
- caps_plugin
- Exit if pipe to `seedlink` is broken.
- trunk
- Fix crash with empty filter parameter list and newer
C++ compiler versions.
- Do not call combined:// real-time recordstream with zero
requests.
## 6.8.2
- ITAPER(): Support time spans with double precision, update filter
documentation.
- Application CLI option `-q, --quiet` took an argument which was not
correct. It has been converted to a switch without argument.
- Add `minPeriod` and `maxPeriod` to amplitude type configuration. Both
are checked against the measured period to skip emitting amplitudes which
are outside the allowed period range.
- Support amplitude data conversion without `enableResponses = true`,
e.g. when computing amplitudes on acceleration data. This implicitly
includes support for amplitude updates for such data.
- Add locrouter plugin, see
https://github.com/SeisComP/common/blob/master/plugins/locator/router/descriptions/global_locrouter.rst.
- Speed up trace rendering for large number of records.
- Add support for reading GeoJSON and BNA in fep directory
- Add support for reading fep file in spatial/vector
- Add GeoJSON write support
- Log each SQLite3 statement to debug if "debug" option is passed to URL.
- Support SI units in amplitude and magnitude configuration for `minDist`, `maxDist`,
`minDepth` and `maxDepth`.
```
amplitudes.MLv.maxDist = 8deg
amplitudes.MLv.maxDepth = 80km
```
- Add Catalog support to datamodel.
- magnitudes
- MLc:
- Add correction terms `c6` und `H` for considering vertical distance.
- Consider source depth instead of vertical distance between station
and origin for computing h.
- Add correction terms `c7` and `c8` for exponential decay.
- Update documentation with new style.
- ql2sc
- Add FocalMechanismReference to event for the preferred focal mechanism to
force association.
- GUI
- Add Qt6 support
- EventLists support passing the IDs of events in selected rows to an
external script which can be configured with `eventlist.scripts.export`.
- Add CSV table header information when exporting from the event list.
- Hypocentral instead of epicentral distances may be shown if configured
with `scheme.distanceHypocentral`.
- Allow map zooming with shift + left mouse + dragging.
- Fix segmentation fault if the magnitude table should be sorted and
station magnitudes could not be found in the database or memory.
- Save map measurements as GeoJSON
- Add support for built-in FontAwesome icons as map symbols.
- Print map symbols in map legends.
- scesv
- Support station annotations (shift+F9).
- scolv
- Attempt to fix a crash that is indicated by the terminal output:
- Focal mechanisms show the station distribution on the map if station
display is enabled (F9).
- Add LQT rotation to picker.
- Fix bug in picker when hidden unassociated picks become visible again after
transferring a solution to the locator window.
- If `olv.locator.presetFromOrigin = true` then the locator will be selected
according to the methodID and earthModelID. If that is not found then
the default locator will be set again rather than keeping the last selection.
- Set OriginLocatorView depth type to "depth type set by locator" when
presetFromOrigin is true and the depth type is unset, resetting the state of
the origin set before.
- Add tooltip with attribute content to method and earthModel label to
allow inspecting long strings which do not fit into the label itself.
- Add more flexible "Add station" dialog in picker which allows to filter
identifiers, network and station types and sensor units.
- Add more option to control initial picker behaviour.
```
QThread: Destroyed while thread is still running
picker.rotation = ZRT
picker.unit = Velocity
picker.limitFilterToZoomTrace = true
olv.loadAdditionalStations = true
```
## 6.8.1
- scconfig
- Allow parenthesis as profile names, e.g. for amplitude
profiles.
## 6.8.0
- NonLinLoc locator plugin
- Allow `SAVE_NLLOC_EXPECTATION` in NLL configuration
files.
- Increase precision to milliseconds for the following picker configuration values:
- `picker.preOffset`
- `picker.postOffset`
- `picker.minimumTimeWindow`
- Add `picker.auxiliary.profile` which supports multiple profiles to define
and check for auxiliary channels.
- Add controls to explicitly load auxiliary profiles
- Add controls to toggle visibility of auxiliary profiles
- Add spectrogram settings like in `scrttv` in a dockable widget (ctrl+shift+s) and
remove the very basic spectrogram settings from the toolbar.
- Add optional allow-/denylist for phases to be imported to ImportPicks dialog.
- Add default configuration options for "Import picks" dialog.
- scmv
- Handle unset origin.depth and do not crash.
- fdsnxml2inv
- Set default start date to 1902-01-01 rather than 1980-01-01 if a start
date is not specified for the StationXML node.
- Use best precision when showing number differences in warnings.
- scamp
- Add command-line option `--formatted` for generating formatted XML along
with `--ep`.
- scautoloc
- Add command-line option `--formatted` for generating formatted XML along
with `--ep`.
- scautopick
- Add command-line option `--formatted` for generating formatted XML along
with `--ep`.
- scdb
- Add option `-x` to wipe out all child objects of a public object from
database. This option might make the most sense on `Inventory`,
`EventParameters` or `Config`.
```
$ scdb -d localhost -x Inventory
```
- scevent
- Add command-line option `--formatted` for generating formatted XML along
with `--ep`.
- Add command-line option `--reprocess` for ignoring event objects in
input along with `--ep`.
- Add `eventAssociation.enablePreferredFMSelection` option to control
whether the preferred focalmechanism should be assigned automatically
or not.
- scmag
- Add command-line option `--formatted` for generating formatted XML along
with `--ep`.
- Fix segmentation fault when processing arrivals without distance.
- screpick
- Add command-line option `--formatted` for generating formatted XML along
with `--ep`.
- scdumpobject
- Tool removed entirely. The functionality has been added to scxmldump.
- scxmldump
- Add `--public-id` and `--with-childs` to export an object by its publicID
from the database. This will even work with database extensions by
loading the corresponding plugins such as `dmsm`.
- scwfparam
- Add support for custom list of periods.
- LocSAT
- Fix bug when a function with only one sample is
interpolated. That usually lead to location
errors such as "SVD routine can't decompose matrix".
- Rewrite old old code to support reentrant processing and dynamic station
count.
- Improve performance.
- Add PKiKP and PKIKP phases.
- Update PKKP table.
- Support custom phase list via [model].ph file.
- NLL
- Allow the use of SAVE_NLLOC_EXPECTATION.
- iLoc
- When reading a local velocity model file, If CONRAD is not specified,
the index of the Conrad discontinuity was not set properly, therefore iLoc
assumed the very first depth as the Conrad thus preventing the calculation
of Pg/Sg phases. The calculation of travel times from a local velocity model
was restricted to up to 6 degree distance.
The Conrad discontinuity is no longer set to the surface when CONRAD is not
specified in the local velocity model. Travel-time calculations from local
velocity models now extended to 10 degrees.
- Add `iLoc.usePickUncertainties` and `iLoc.defaultTimeError` to description.
- doc
- Replace Sphinx m2r2 with sphinx_mdinclude
- diskmon
- Fix stopped modules counter for diskmon.
## 6.7.9
@ -244,6 +363,9 @@ will be tackled in future updates.
- Allow to disable SQLite3 disc syncrhronization to decrease time needed to
save data in an SQLite3 database: `sqlite3:///path/to/file?sync=false`.
- Add support for all synchronous flags of SQLite3 (`sync=[normal|full|extra]`).
- Add option `amplitudes.[type].considerUnusedArrivals` which if enabled
considers stations with unused (disabled) arrivals for amplitude and
implicitly magnitude computations. Affects scamp, scmag and scolv.
- scolv
- Replace operator comment input control with a text edit control which
allows new lines. Furthermore the restriction of 160 characters has been

6
share/doc/seiscomp/html/_sources/base/api-python-client.rst.txt
View File

@ -123,7 +123,7 @@ and configure it in the constructor.
As marked in line 4, the call of the constructor of the base class is very
important. It takes the command line parameters and sets up internal
application variables. Without this call the application will either not run
at all or show undefined/unexpected behaviour.
at all or show undefined/unexpected behavior.
The constructor takes also the initial parameters of the application such as
enabling a messaging connection and enabling database access.
@ -155,7 +155,7 @@ All application methods are defined in the C++ header file
Init
^^^^
The workflow of the init function looks like this:
The workflow of the :func:`init` function looks like this:
.. code-block:: python
@ -394,7 +394,7 @@ returns the RecordStream instance which can be used to add stream requests.
The record stream service is configured either with configuration files
(:confval:`recordstream`) or
via command-line options ``-I`, ``--record-url``.
via the command-line option ``-I, --record-url``.
The application finishes if the record stream read EOF. Running a :class:`StreamApplication`
with :ref:`Seedlink<seedlink>` would probably never terminate since it is a

423
share/doc/seiscomp/html/_sources/base/api-python.rst.txt
View File

@ -47,10 +47,12 @@ EventParameters
MomentTensorPhaseSetting [label="MomentTensorPhaseSetting", href="../base/api-python.html#api-python-datamodel-momenttensorphasesetting", target="_top"]
MomentTensorStationContribution [label="MomentTensorStationContribution", href="../base/api-python.html#api-python-datamodel-momenttensorstationcontribution", target="_top"]
MomentTensorComponentContribution [label="MomentTensorComponentContribution", href="../base/api-python.html#api-python-datamodel-momenttensorcomponentcontribution", target="_top"]
Catalog [label="Catalog", href="../base/api-python.html#api-python-datamodel-catalog", target="_top"]
Event [label="Event", href="../base/api-python.html#api-python-datamodel-event", target="_top"]
EventDescription [label="EventDescription", href="../base/api-python.html#api-python-datamodel-eventdescription", target="_top"]
OriginReference [label="OriginReference", href="../base/api-python.html#api-python-datamodel-originreference", target="_top"]
FocalMechanismReference [label="FocalMechanismReference", href="../base/api-python.html#api-python-datamodel-focalmechanismreference", target="_top"]
Event [label="Event", href="../base/api-python.html#api-python-datamodel-event", target="_top"]
EventParameters [label="EventParameters", href="../base/api-python.html#api-python-datamodel-eventparameters", target="_top"]
EventParameters -> Pick [dir=back arrowtail=diamond]
MomentTensor -> Comment [dir=back arrowtail=diamond]
@ -60,6 +62,7 @@ EventParameters
StationMagnitude -> Comment [dir=back arrowtail=diamond]
Pick -> Comment [dir=back arrowtail=diamond]
Event -> Comment [dir=back arrowtail=diamond]
Catalog -> Comment [dir=back arrowtail=diamond]
Origin -> Comment [dir=back arrowtail=diamond]
EventParameters -> Amplitude [dir=back arrowtail=diamond]
EventParameters -> Reading [dir=back arrowtail=diamond]
@ -77,10 +80,14 @@ EventParameters
MomentTensor -> MomentTensorPhaseSetting [dir=back arrowtail=diamond]
MomentTensor -> MomentTensorStationContribution [dir=back arrowtail=diamond]
MomentTensorStationContribution -> MomentTensorComponentContribution [dir=back arrowtail=diamond]
EventParameters -> Catalog [dir=back arrowtail=diamond]
Catalog -> Event [dir=back arrowtail=diamond]
EventParameters -> Event [dir=back arrowtail=diamond]
Event -> EventDescription [dir=back arrowtail=diamond]
Event -> OriginReference [dir=back arrowtail=diamond]
Event -> FocalMechanismReference [dir=back arrowtail=diamond]
Catalog -> Event [dir=back arrowtail=diamond]
EventParameters -> Event [dir=back arrowtail=diamond]
}
.. graphviz::
@ -477,6 +484,27 @@ EventParameters
href = "../base/api-python.html#api-python-datamodel-momenttensorcomponentcontribution"
target = "_top"
]
Catalog [
labeltooltip = "Catalog"
label = <
<table border="0" cellpadding="0" cellspacing="2">
<tr><td>Catalog</td></tr>
<hr/>
<tr><td> </td></tr>
<tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr>
<tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr>
<tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr>
<tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr>
<tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr>
<tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr>
<tr><td align="left" port="dynamic"><font color="#8b0000">+ dynamic: boolean</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ event: Event [0..*]</font></td></tr>
</table>
>
href = "../base/api-python.html#api-python-datamodel-catalog"
target = "_top"
]
Event [
labeltooltip = "Event"
label = <
@ -540,6 +568,29 @@ EventParameters
href = "../base/api-python.html#api-python-datamodel-focalmechanismreference"
target = "_top"
]
Event [
labeltooltip = "Event"
label = <
<table border="0" cellpadding="0" cellspacing="2">
<tr><td>Event</td></tr>
<hr/>
<tr><td> </td></tr>
<tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr>
<tr><td align="left" port="preferredOriginID"><font color="#8b0000">+ preferredOriginID: string</font></td></tr>
<tr><td align="left" port="preferredMagnitudeID"><font color="#8b0000">+ preferredMagnitudeID: string</font></td></tr>
<tr><td align="left" port="preferredFocalMechanismID"><font color="#8b0000">+ preferredFocalMechanismID: string</font></td></tr>
<tr><td align="left" port="type"><font color="#8b0000">+ type: EventType [0..1]</font></td></tr>
<tr><td align="left" port="typeCertainty"><font color="#8b0000">+ typeCertainty: EventTypeCertainty [0..1]</font></td></tr>
<tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ eventDescription: EventDescription [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ originReference: OriginReference [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ focalMechanismReference: FocalMechanismReference [0..*]</font></td></tr>
</table>
>
href = "../base/api-python.html#api-python-datamodel-event"
target = "_top"
]
EventParameters [
labeltooltip = "EventParameters"
label = <
@ -553,6 +604,7 @@ EventParameters
<tr><td align="left"><font color="#8b0000">+ reading: Reading [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ origin: Origin [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ focalMechanism: FocalMechanism [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ catalog: Catalog [0..*]</font></td></tr>
<tr><td align="left"><font color="#8b0000">+ event: Event [0..*]</font></td></tr>
</table>
>
@ -567,6 +619,7 @@ EventParameters
StationMagnitude -> Comment [dir=back arrowtail=diamond]
Pick -> Comment [dir=back arrowtail=diamond]
Event -> Comment [dir=back arrowtail=diamond]
Catalog -> Comment [dir=back arrowtail=diamond]
Origin -> Comment [dir=back arrowtail=diamond]
EventParameters -> Amplitude [dir=back arrowtail=diamond]
EventParameters -> Reading [dir=back arrowtail=diamond]
@ -584,10 +637,14 @@ EventParameters
MomentTensor -> MomentTensorPhaseSetting [dir=back arrowtail=diamond]
MomentTensor -> MomentTensorStationContribution [dir=back arrowtail=diamond]
MomentTensorStationContribution -> MomentTensorComponentContribution [dir=back arrowtail=diamond]
EventParameters -> Catalog [dir=back arrowtail=diamond]
Catalog -> Event [dir=back arrowtail=diamond]
EventParameters -> Event [dir=back arrowtail=diamond]
Event -> EventDescription [dir=back arrowtail=diamond]
Event -> OriginReference [dir=back arrowtail=diamond]
Event -> FocalMechanismReference [dir=back arrowtail=diamond]
Catalog -> Event [dir=back arrowtail=diamond]
EventParameters -> Event [dir=back arrowtail=diamond]
}
@ -5475,6 +5532,280 @@ Blob
:rtype: string
.. _api-python-datamodel-catalog:
Catalog
............................................................
.. py:class:: Catalog
Inherits :ref:`PublicObject <api-python-datamodel-publicobject>`.
**Parents**:
- ``eventParameters`` -- :ref:`EventParameters <api-python-datamodel-eventparameters>`
**Children**:
- ``comment`` -- :ref:`Comment <api-python-datamodel-comment>`
- ``event`` -- :ref:`Event <api-python-datamodel-event>`
**Attributes**:
- ``publicID``: string
- ``name`` -- string
- ``description`` -- string
- ``creationInfo`` -- :ref:`CreationInfo <api-python-datamodel-creationinfo>` (optional)
- ``start`` -- seiscomp.core.Time
- ``end`` -- seiscomp.core.Time (optional)
- ``dynamic`` -- boolean
**Methods**:
.. py:staticmethod:: Cast(obj)
:param obj: The object to be casted.
:rtype: An object of type Catalog if the cast was successful,
None otherwise.
Cast an arbitrary object to Catalog if the internal wrapped
representation is an Catalog object. The cast is important if
instances of type :ref:`Object <api-python-datamodel-object>`
are passed to methods which need access to the real type.
.. py:staticmethod:: Create()
:rtype: A new object of type Catalog.
Creates and registers (if enabled) a Catalog instance. The
publicID is auto-generated.
.. py:staticmethod:: Create(publicID)
:rtype: A new object of type Catalog.
Creates and registers (if enabled) a Catalog instance with
passed publicID.
.. py:method:: equal(other)
:param other: Another object of type Catalog to compare this
instance to
:rtype: A Boolean value indicating True if both objects are equal or
False otherwise.
Compares two objects without its child objects. Both objects are compared
by value.
.. py:method:: setName(name)
:param name: string
.. py:method:: name()
:rtype: string
.. py:method:: setDescription(description)
:param description: string
Catalog description
.. py:method:: description()
:rtype: string
.. py:method:: setCreationInfo(creationInfo)
:param creationInfo: :ref:`CreationInfo <api-python-datamodel-creationinfo>`
CreationInfo for the Catalog object.
.. py:method:: creationInfo()
:rtype: :ref:`CreationInfo <api-python-datamodel-creationinfo>`
.. note::
As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.
.. py:method:: setStart(start)
:param start: seiscomp.core.Time
Start of epoch in ISO datetime format
.. py:method:: start()
:rtype: seiscomp.core.Time
.. py:method:: setEnd(end)
:param end: seiscomp.core.Time
End of epoch \(empty if the catalog epoch is open\)
.. py:method:: end()
:rtype: seiscomp.core.Time
.. note::
As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.
.. py:method:: setDynamic(dynamic)
:param dynamic: boolean
.. py:method:: dynamic()
:rtype: boolean
.. py:method:: add(comment)
:param comment: Object of type :ref:`Comment <api-python-datamodel-comment>`
:rtype: A Boolean value indicating success with True, False otherwise.
Adds a Comment object to Catalog. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.
.. py:method:: add(event)
:param event: Object of type :ref:`Event <api-python-datamodel-event>`
:rtype: A Boolean value indicating success with True, False otherwise.
Adds a Event object to Catalog. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.
.. py:method:: remove(comment)
:param comment: Object of type :ref:`Comment <api-python-datamodel-comment>`
:rtype: A Boolean value indicating success with True, False otherwise.
Removes a previously added Comment object from Catalog.
.. py:method:: remove(event)
:param event: Object of type :ref:`Event <api-python-datamodel-event>`
:rtype: A Boolean value indicating success with True, False otherwise.
Removes a previously added Event object from Catalog.
.. py:method:: removeComment(idx)
:param idx: An integer index of the object to be removed.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: removeComment(commentIndex);
:param commentIndex: The index of the object to be removed of type CommentIndex.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: removeEvent(idx)
:param idx: An integer index of the object to be removed.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: commentCount()
:rtype: integer value indicating the number of child objects.
Returns the number of Comment child objects.
.. py:method:: eventCount()
:rtype: integer value indicating the number of child objects.
Returns the number of Event child objects.
.. py:method:: comment(idx)
:param idx: An integer index of the object to be returned.
:rtype: Object of type :ref:`Comment <api-python-datamodel-comment>`.
Returns the Comment at index idx.
.. py:method:: comment(commentIndex)
:param commentIndex: The index of the object to be removed of type CommentIndex.
:rtype: Object of type :ref:`Comment <api-python-datamodel-comment>`.
Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.
.. py:method:: event(idx)
:param idx: An integer index of the object to be returned.
:rtype: Object of type :ref:`Event <api-python-datamodel-event>`.
Returns the Event at index idx.
.. py:method:: findEvent(publicID)
:param publicID: The publicID of the object to find.
:rtype: Object of type :ref:`Event <api-python-datamodel-event>`.
Returns the child object with a certain publicID, None otherwise.
.. py:method:: eventParameters()
:rtype: EventParameters
Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().
.. py:method:: assign(other)
This method implements the :ref:`Object <api-python-datamodel-object>` interface.
.. py:method:: attachTo(parent)
This method implements the :ref:`Object <api-python-datamodel-object>` interface.
.. py:method:: detachFrom(parent)
This method implements the :ref:`Object <api-python-datamodel-object>` interface.
.. py:method:: detach()
This method implements the :ref:`Object <api-python-datamodel-object>` interface.
.. py:method:: clone()
:rtype: A cloned Catalog.
Returns a new instance that is a clone of the current instance. Child
objects are being ignored.
.. py:method:: updateChild(ref)
:param ref: A child object derived from class Object.
:rtype: A Boolean flag indicating success with True, False otherwise
This method takes the passed reference object and searches for a child
with the same publicID (if derived from :ref:`PublicObject <api-python-datamodel-publicobject>`)
or the same index (if derived from :ref:`Object <api-python-datamodel-object>`).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the :ref:`PublicObject <api-python-datamodel-publicobject>` interface.
.. py:method:: accept(visitor)
:param visitor: A visitor.
This method implements the :ref:`PublicObject <api-python-datamodel-publicobject>` interface.
.. _api-python-datamodel-comment:
Comment
@ -5496,6 +5827,7 @@ Comment
- ``stationMagnitude`` -- :ref:`StationMagnitude <api-python-datamodel-stationmagnitude>`
- ``pick`` -- :ref:`Pick <api-python-datamodel-pick>`
- ``event`` -- :ref:`Event <api-python-datamodel-event>`
- ``catalog`` -- :ref:`Catalog <api-python-datamodel-catalog>`
- ``origin`` -- :ref:`Origin <api-python-datamodel-origin>`
- ``parameter`` -- :ref:`Parameter <api-python-datamodel-parameter>`
- ``parameterSet`` -- :ref:`ParameterSet <api-python-datamodel-parameterset>`
@ -5671,6 +6003,14 @@ Comment
if the parent is not a Event. This is a convenience wrapper
for parent().
.. py:method:: catalog()
:rtype: Catalog
Returns the parent Catalog if available. Returns None
if the parent is not a Catalog. This is a convenience wrapper
for parent().
.. py:method:: origin()
:rtype: Origin
@ -6764,6 +7104,7 @@ CreationInfo
- :func:`Amplitude.creationInfo`
- :func:`Arrival.creationInfo`
- :func:`Catalog.creationInfo`
- :func:`Comment.creationInfo`
- :func:`ConfigStation.creationInfo`
- :func:`Event.creationInfo`
@ -8495,6 +8836,7 @@ Event
**Parents**:
- ``catalog`` -- :ref:`Catalog <api-python-datamodel-catalog>`
- ``eventParameters`` -- :ref:`EventParameters <api-python-datamodel-eventparameters>`
**Children**:
@ -8821,6 +9163,14 @@ Event
are compared by value which makes this function slower than the direct
integer index look-up.
.. py:method:: catalog()
:rtype: Catalog
Returns the parent Catalog if available. Returns None
if the parent is not a Catalog. This is a convenience wrapper
for parent().
.. py:method:: eventParameters()
:rtype: EventParameters
@ -9009,6 +9359,7 @@ EventParameters
- ``reading`` -- :ref:`Reading <api-python-datamodel-reading>`
- ``origin`` -- :ref:`Origin <api-python-datamodel-origin>`
- ``focalMechanism`` -- :ref:`FocalMechanism <api-python-datamodel-focalmechanism>`
- ``catalog`` -- :ref:`Catalog <api-python-datamodel-catalog>`
- ``event`` -- :ref:`Event <api-python-datamodel-event>`
**Attributes**:
@ -9085,6 +9436,15 @@ EventParameters
copied but managed by this instance. Any change to the passed object
will also change the child.
.. py:method:: add(catalog)
:param catalog: Object of type :ref:`Catalog <api-python-datamodel-catalog>`
:rtype: A Boolean value indicating success with True, False otherwise.
Adds a Catalog object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.
.. py:method:: add(event)
:param event: Object of type :ref:`Event <api-python-datamodel-event>`
@ -9129,6 +9489,13 @@ EventParameters
Removes a previously added FocalMechanism object from EventParameters.
.. py:method:: remove(catalog)
:param catalog: Object of type :ref:`Catalog <api-python-datamodel-catalog>`
:rtype: A Boolean value indicating success with True, False otherwise.
Removes a previously added Catalog object from EventParameters.
.. py:method:: remove(event)
:param event: Object of type :ref:`Event <api-python-datamodel-event>`
@ -9161,6 +9528,11 @@ EventParameters
:param idx: An integer index of the object to be removed.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: removeCatalog(idx)
:param idx: An integer index of the object to be removed.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: removeEvent(idx)
:param idx: An integer index of the object to be removed.
@ -9196,6 +9568,12 @@ EventParameters
Returns the number of FocalMechanism child objects.
.. py:method:: catalogCount()
:rtype: integer value indicating the number of child objects.
Returns the number of Catalog child objects.
.. py:method:: eventCount()
:rtype: integer value indicating the number of child objects.
@ -9237,6 +9615,13 @@ EventParameters
Returns the FocalMechanism at index idx.
.. py:method:: catalog(idx)
:param idx: An integer index of the object to be returned.
:rtype: Object of type :ref:`Catalog <api-python-datamodel-catalog>`.
Returns the Catalog at index idx.
.. py:method:: event(idx)
:param idx: An integer index of the object to be returned.
@ -9279,6 +9664,13 @@ EventParameters
Returns the child object with a certain publicID, None otherwise.
.. py:method:: findCatalog(publicID)
:param publicID: The publicID of the object to find.
:rtype: Object of type :ref:`Catalog <api-python-datamodel-catalog>`.
Returns the child object with a certain publicID, None otherwise.
.. py:method:: findEvent(publicID)
:param publicID: The publicID of the object to find.
@ -15138,23 +15530,14 @@ QCLog
Compares two objects without its child objects. Both objects are compared
by value.
.. py:method:: index()
:rtype: The object's index of type QCLogIndex.
Returns the objects index which is also used for the database as unique
constraint.
.. py:method:: equalIndex(lhs)
:param lhs: :ref:`QCLog <api-python-datamodel-qclog>`
:rtype: A Boolean value indicating True if both indexes are equal or
False otherwise.
.. py:method:: setWaveformID(waveformID)
:param waveformID: :ref:`WaveformStreamID <api-python-datamodel-waveformstreamid>`
The waveform identifier for which the annotation is valid. Each component
can contain wildcards \(asterisk or question mark\) but no regular
expressions.
.. py:method:: waveformID()
:rtype: :ref:`WaveformStreamID <api-python-datamodel-waveformstreamid>`
@ -15348,11 +15731,6 @@ QualityControl
:param idx: An integer index of the object to be removed.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: removeQCLog(qCLogIndex);
:param qCLogIndex: The index of the object to be removed of type QCLogIndex.
:rtype: A Boolean value indicating success with True, False otherwise.
.. py:method:: removeWaveformQuality(idx)
:param idx: An integer index of the object to be removed.
@ -15398,15 +15776,6 @@ QualityControl
Returns the QCLog at index idx.
.. py:method:: qCLog(qCLogIndex)
:param qCLogIndex: The index of the object to be removed of type QCLogIndex.
:rtype: Object of type :ref:`QCLog <api-python-datamodel-qclog>`.
Returns the QCLog at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.
.. py:method:: waveformQuality(idx)
:param idx: An integer index of the object to be returned.

30
share/doc/seiscomp/html/_sources/base/build.rst.txt
View File

@ -98,26 +98,30 @@ a build directory, configure the build and start it:
Software dependencies
=====================
For compiling the |scname| sources the following development software packages
are required (Debian/Ubuntu package names):
For compiling the |scname| sources the development software packages must be
installed by Linux system commands such as :program:`apt` or :program:`dnf`.
The required packages are (Debian/Ubuntu package names):
* flex
* g++
* git
* cmakecmake-gui
* crypto-dev
* libboost
* libxml2-dev
* flex
* libbson-dev
* libfl-dev
* libssl-dev
* crypto-dev
* python3-dev (optional)
* python3-numpy (optional, required if Numpy support is enabled which is also the default configuration)
* libqt5-dev (optional)
* qtbase5-dev (optional)
* libmysqlclient-dev (optional)
* libpq-dev (optional)
* libsqlite3-dev (optional)
* ncurses-dev (optional)
* libxml2-dev
Optional, depending on the modules to be built are (Debian/Ubuntu package names):
* libmysqlclient-dev
* libpq-dev
* libqt5-dev
* libsqlite3-dev
* ncurses-dev
* python3-dev
* python3-numpy (required if Numpy support is enabled which is also the default configuration)
* qtbase5-dev
As of |scname| in version 5.0.0 support for Python 2 is dropped and Python 3 has
become the default.

19
share/doc/seiscomp/html/_sources/base/coding-conventions.rst.txt
View File

@ -21,6 +21,7 @@ used to fill the space. The recommended tab width is 4 characters.
> if ( a > 5 ) {
> > SEISCOMP_DEBUG("A is greater than 5. Its current value is %d",
> > ...............a);
> }
> return a;
}
@ -84,14 +85,14 @@ C++ code is (or should be) written with the following code style:
}
namespace Foo {
namespace Bar {
namespace Foo::Bar {
void foo(int a, int b) {
for ( int i = 0; i < a; ++i ) {
if ( i < b )
if ( i < b ) {
bar(i);
}
else {
bar(i);
bar(b);
@ -100,8 +101,7 @@ C++ code is (or should be) written with the following code style:
}
} // namespace Bar
} // namespace Foo
} // namespace Foo::Bar
#endif
@ -217,22 +217,25 @@ Check a null pointer with implicit boolean conversion.
.. code-block:: c++
if ( !ptr )
if ( !ptr ) {
do_something();
}
rather than
.. code-block:: c++
if ( ptr == 0 )
if ( ptr == 0 ) {
do_something();
}
or
.. code-block:: c++
if ( ptr == NULL )
if ( ptr == NULL ) {
do_something();
}
Virtual Functions
=================

2
share/doc/seiscomp/html/_sources/base/concepts.rst.txt
View File

@ -19,5 +19,5 @@ the :term:`trunk` package.
RecordStream: Access to data from real-time servers or archives </base/concepts/recordstream>
Inventory: Station meta data </base/concepts/inventory>
Configuration: Inventory, module and binding configurations </base/concepts/configuration>
Processing: Magnitude computation </base/concepts/magnitudes>
Processing: Amplitudes and magnitudes </base/concepts/magnitudes>
Processing: Locator types </base/concepts/locators>

9
share/doc/seiscomp/html/_sources/base/concepts/locators.rst.txt
View File

@ -11,7 +11,7 @@ further.
|scname| ships with built-in locators:
* :ref:`FixedHypocenter <global_fixedhypocenter>` (FH)
* :ref:`FixedHypocenter <global_fixedhypocenter>`
* :ref:`Hypo71 <global_hypo71>`
* :ref:`iLoc <global_iloc>`
* :ref:`LOCSAT <global_locsat>`, the default locator in :ref:`scautoloc` and :ref:`scolv`
@ -41,13 +41,14 @@ A comparison of the locators is given in the table below.
.. csv-table::
:widths: 30 10 10 10 10 10 10 10
:header: , FH, Hypo71, iLoc, LocExt, LOCSAT, NonLinLoc, StdLoc
:header: , Fixed Hypocenter, Hypo71, iLoc, LocExt, LOCSAT, NonLinLoc, StdLoc
:align: center
**Applications**, ,,,,,,
phases considered by default, seismic / infrasound, seismic, seismic / infrasound / hydroacoustic, [3], seismic / infrasound, seismic, seismic
distance ranges of application, local / regional / teleseismic, local / regional, local / regional / teleseismic, [3], local / regional / teleseismic, local / regional / teleseismic, local / regional [4]
application with default configuration, regional / teleseismic, ❌, regional / global, [3], regional / teleseismic, ❌, local / regional [1]
origin depth range, [4], non-negative, 0 - 700 km, [3], 0 - 800 km, full range depending on travel-time tables, [4]
**Algorithm**, ,,,,,,
inversion algorithm, linear, iterative, configurable, [3], grid search, probabilistic, configurable
automatic phase renaming, ❌, ❌, ✅, [3], ❌, ❌, ❌
@ -59,7 +60,7 @@ A comparison of the locators is given in the table below.
considers pick backazimuth, ❌, ❌, ✅, [3], ✅, ❌, ❌
speed, fast, fast, fast - intermediate, [3], fast, intermediate, fast - intermediate
**Velocity model**, ,,,,,,
velocity model, 1D [4], 1D, 1D, [3],1D, 1D / 3D, 1D / 3D [4]
velocity model, 1D [4], 1D, 1D / local adjustments, [3], 1D, 1D / 3D, 1D / 3D [4]
independent Vp and Vs, ✅ [4], ❌, ✅, [3], ✅, ✅, ✅ [4]
default velocity model, iasp91 / tab, ❌, iasp91 / ak135, [3], iasp91 / tab, ❌, iasp91 / tab [1]
applies RSTT, ❌ , ❌, ✅, [3], ❌, ❌, ❌
@ -74,7 +75,7 @@ A comparison of the locators is given in the table below.
operates without custom scripts, ✅, ✅, ✅, ❌, ✅, ✅, ✅
**Others**, ,,,,,,
remarks, intended for ground-truth tests / single-station location / any travel-time interface, ,operational at EMSC and ISC (earlier version), any external locator can be called by a custom script, currently the fastest locator in |scname| and the only one available to :ref:`scautoloc`, considers model uncertainties, uses travel-times from any travel-time interface
point of contact, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`, `ibondar2014 @gmail.com <ibondar2014@gmail.com>`_, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`
point of contact, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`, `istvan.bondar @slsiloc.eu <istvan.bondar@slsiloc.eu>`_, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`, :cite:t:`seiscomp-forum`
* [1]: requires initial or specific configuration
* [2]: requires correction file

205
share/doc/seiscomp/html/_sources/base/concepts/magnitudes.rst.txt
View File

@ -1,34 +1,85 @@
.. _concepts_magnitudes:
Magnitudes
##########
Amplitudes and Magnitudes
#########################
Magnitudes are computed based on amplitudes measured from waveforms. Different
types of amplitudes and magnitudes are available which are listed in
:ref:`scamp` and :ref:`scmag`.
:ref:`Magnitudes of specific types <concepts_magnitudes-station>` are computed
from :ref:`amplitudes <concepts_magnitudes-amplitudes>` measured on waveforms.
Different types of amplitudes and magnitudes are available including aliases.
All magnitudes can be regionalized and mapped to Mw. The native amplitude and
magnitudes types are listed in :ref:`scamp` and :ref:`scmag`.
All amplitude and magnitude values can be read in the Magnitudes tab of
:ref:`scolv`, in bulletins created by :ref:`scbulletin` and dumped
from database to XML for an origin or event by :ref:`scxmldump`.
This concept section describes the principles applied in |scname| and links to
more specific sections including tutorials describing the configuration and
application.
.. figure:: media/amplitude-magnitude-processing.png
:alt: amplitudes and magnitudes: processing flow
:align: center
:width: 18cm
Schematic processing flow for computing magnitudes from measured amplitudes
including the involved |scname| modules and interfaces. Multiple network
magnitude types can be computed for the same :term:`origin`. The default
processing of native amplitudes and magnitudes in the center can be extended
by aliases, regionalization, Mw mapping or external magnitudes.
.. _concepts_magnitudes-amplitudes:
Amplitudes
==========
Amplitudes can be measured automatically from waveforms
Amplitudes can be measured on waveforms
* During phase picking by :ref:`scautopick` with generally fixed time windows
due to the absence of knowledge about source parameters or by,
* :ref:`scamp` as soon as :term:`origins <origin>` are available. Depending
on the magnitude type, fixed or distance-dependent time windows apply.
* Automatically during phase picking by :ref:`scautopick` with generally fixed
time windows due to the absence of knowledge about source parameters.
* Automatically by :ref:`scamp` as soon as :term:`origins <origin>` are
available. Depending on the amplitude type and their configuration, fixed or
distance-dependent time windows as well as constraints on signal quality apply.
* Interactively using :ref:`scolv` with preset or user-defined conditions.
and interactively using :ref:`scolv`.
:ref:`Time grammar <time-grammar>` applies for configuring the time windows.
Instrument simulation
---------------------
Input data
----------
Amplitude measurements for some magnitude types require or allow the simulation
Depending on type amplitudes are measured on raw or filtered waveform data.
Initial raw data are given in counts of the digitizer with a stream gain unit of
m/s which is typical for seismometers.
It is assumed that the measured signal has its dominant
frequency where the response of the recording instrument is flat.
For other instruments such as accelerometers or short-period geophones, amplitude
correction for instrument response and the corresponding frequency range may be
configured by the global binding parameters
:confval:`amplitudes.enableResponses`, :confval:`amplitudes.resp.minFreq`,
:confval:`amplitudes.resp.maxFreq` or even with in amplitude-type profiles for
more specific application. Amplitude measurements will fail if the
unit of the (corrected) input data do not correspond to the requirement of the
amplitude type.
Filtering may involve
:ref:`simulation of Wood-Anderson seismographs <concepts_magnitudes-wa>`.
Final amplitude measurements are corrected by stream gain and provided as an
amplitude object.
.. _concepts_magnitudes-wa:
Wood-Anderson simulation
------------------------
Some amplitude types require or allow the correction of waveforms by simulation
of instruments such as :py:func:`Wood-Anderson torsion seismometers <WA>`
(:cite:t:`richter-1935,uhrhammer-1990`), :py:func:`WWSSN_SP` or :py:func:`WWSSN_LP`.
The calibration parameters describing the Wood-Anderson seismometer are
configurable in global bindings or global module configuration:
The calibration parameters describing a Wood-Anderson seismometer are
configurable in global bindings or module configuration:
:confval:`amplitudes.WoodAnderson.gain`, :confval:`amplitudes.WoodAnderson.T0`,
:confval:`amplitudes.WoodAnderson.h`. Specifically, the difference in magnitude
due to configuration using original values listed in
@ -38,16 +89,61 @@ Wood-Anderson simulation, e.g. :term:`ML <magnitude, local (ML)>`,
:term:`MLv <magnitude, local vertical (MLv)>`, :term:`MLc <magnitude, local custom (MLc)>`.
Physical units
--------------
The physical units of measured amplitudes depend on amplitudes type. They are
documented along with the corresponding magnitude type. Starting with the initial
gain unit of raw data streams, typically m/s, the amplitude processor in
|scname| converts to the required unit. Where instrument simulation if optional,
e.g., for :term:`MLc amplitudes <magnitude, local custom (MLc)>`, a conversion
configurable factor must be considered for non-default amplitude processing.
.. _concepts_amplitudes-aliases:
Amplitude Aliases
-------------------------------
New amplitude types (aliases) can be created based on existing amplitude types
but configured and measured specifically. They can be measured as any other
amplitude by :ref:`scamp` or :ref:`scautopick` and used by other modules, e.g.,
by :ref:`scmag` for :ref:`magnitude aliases <concepts_magnitudes-station>`. The
setup procedure is outlined in the tutorial on
:ref:`amplitude aliases <tutorials_amplitude-aliases>`.
.. _concepts-amplitudes-regionalization:
Regionalization
---------------
Measuring amplitudes only for sources or pairs of sources and stations in
specific regions is supported by regionalization. The region polygons are
defined by :ref:`magnitude regionalization <concepts-magnitudes-regionalization>`.
In order to use the feature, regionalized amplitudes and magnitudes must have
the same type (name) and regionalization must be activated per amplitude type in
amplitude-type profiles of global bindings.
.. _concepts_magnitudes-station:
Station Magnitudes
==================
Station magnitudes are computed automatically by :ref:`scmag` or interactively
by :ref:`scolv` from measured amplitudes based on distance-dependent
calibration curves which depend on magnitude type. When computing a set of
magnitudes in :ref:`scolv` which is different from the set configured in
:ref:`scmag`, then scmag may later add the missing magnitudes automatically.
Magnitude types for which the evaluation status is set to "rejected", e.g., in
scolv, will not be recomputed by scmag.
calibration curves which depend on magnitude type. Since distance measures are
required, station magnitudes are always related to one :term:`origin`. For
computing new magnitudes in scolv, a new origin must be created which is done by
relocating.
When computing a set of station magnitudes in :ref:`scolv` which is different from
the set configured in :ref:`scmag`, then scmag may later add the missing
magnitudes automatically. Magnitude types for which the evaluation status is
set to "rejected", e.g., in :ref:`scolv`, will not be recomputed by scmag. In
order to ignore a magnitude type interactively, it should therefore be treated
and rejected in scolv.
.. _concepts-magnitudes-correction:
@ -64,7 +160,7 @@ global :ref:`binding parameters <global_bindings_config>`:
When using binding profiles, all referencing stations will be affected equally
which is typically not intended. In contrast, applying station bindings requires
to set up many bindings which may not be intended either.
to set up many bindings which may not be intended either.concepts-magnitudes-regionalization
Therefore, you may add lines to the global module configuration in
:file:`global.cfg` where one line corresponds to one station with one magnitude
@ -85,39 +181,26 @@ parameters are identical to the global bindings parameters. All lines start with
:file:`seiscomp/etc/global.cfg`.
Network Magnitudes
==================
.. _concepts_magnitudes-aliases:
Network magnitudes are computed automatically by :ref:`scmag` or interactively
by :ref:`scolv` from station magnitudes based on averaging station magnitudes.
The averaging methods applied by :ref:`scmag` are configurable by
:confval:`magnitudes.average`. Available are (:cite:t:`rosenberger-1983`):
Magnitude Aliases
-------------------------------
* *mean*: the mean value from all station magnitudes.
* *median*: the mean value from all station magnitudes.
* *trimmedMean(X)*: gnores outlier station magnitudes by first removing the
largest and the smallest *X* % of the observed values (percentiles). The mean is
formed from the remaining station magnitudes.
* *trimmedMedian(X)*: forms the median from all station magnitudes but returns
the uncertainty by ignoring the largest and the smallest *X* % station
magnitudes.
* *medianTrimmedMean(X)*: returns the mean magnitude from all station magnitudes
differing less than *X* magnitudes from the median.
Aliases
=======
New magnitude types (aliases) can be created based on existing magnitude and
amplitude types but configured specifically.
The setup procedure is outlined in the
:ref:`tutorial on magnitude aliases <tutorials_magnitude-aliases>`.
New magnitude types (aliases) can be created inheriting the configuration
parameters but not the configured values from existing magnitude and amplitude types or
:ref:`amplitude aliases <concepts_amplitudes-aliases>`. The values are configured
specifically. Unless specified explicitly, the amplitude type
is the base amplitude of the original magnitude. Other
amplitude types or amplitude aliases must be defined first and given explicitly.
The aliased magnitudes can be computed by other modules such as :ref:`scmag` or
:ref:`scolv`. The setup procedure is outlined in the tutorial on
:ref:`magnitude aliases <tutorials_magnitude-aliases>`.
.. _concepts-magnitudes-regionalization:
Regionalization
===============
---------------
The computation of station magnitudes can be regionalized. This means that for
a specific region specific conditions apply when computing magnitudes. The
@ -135,6 +218,30 @@ setup procedure including
:ref:`tutorial on regionalization <tutorials_magnitude-region-aliases>`.
.. _concepts_magnitudes-network:
Network Magnitudes
==================
Network magnitudes are computed automatically by :ref:`scmag` or interactively
by :ref:`scolv` from station magnitudes based on averaging station magnitudes.
The averaging methods applied by :ref:`scmag` are configurable by
:confval:`magnitudes.average`. Available are (:cite:t:`rosenberger-1983`):
* *mean*: The mean value from all station magnitudes.
* *median*: The mean value from all station magnitudes.
* *trimmedMean(X)*: Ignores outlier station magnitudes by first removing the
largest and the smallest *X* % of the observed values (percentiles). The mean is
formed from the remaining station magnitudes.
* *trimmedMedian(X)*: Forms the median from all station magnitudes but returns
the uncertainty by ignoring the largest and the smallest *X* % station
magnitudes.
* *medianTrimmedMean(X)*: Returns the mean magnitude from all station magnitudes
differing less than *X* magnitudes from the median.
.. _concepts_magnitudes-moment:
Moment Magnitudes
=================
@ -165,6 +272,8 @@ usually referred to as *M*. The name is configurable.
:term:`origin`.
.. _concepts_magnitudes-preferred:
Preferred Magnitude
===================

16
share/doc/seiscomp/html/_sources/base/concepts/messaging.rst.txt
View File

@ -140,9 +140,11 @@ Examples:
connection.server = localhost/production
On the command line use, e.g. ::
On the command line use, e.g.
$ scolv -H localhost
.. code-block:: sh
scolv -H localhost
* Connect to the production queue of the messaging on localhost with default port.
Using non-default secure encryption and port the scheme and the port must be
@ -150,9 +152,11 @@ Examples:
connection.server = scmps://localhost18181/production
On the command line use, e.g. ::
On the command line use, e.g.
$ scolv -H scmps://localhost:18181/production
.. code-block:: sh
scolv -H scmps://localhost:18181/production
.. _messaging-db :
@ -172,7 +176,9 @@ When connecting from a client to the messaging, the database connection paramete
are reported by :ref:`scmaster`. They can be overridden by the global configuration
or command-line option ``-d``.
Example: ::
Example:
.. code-block:: sh
scolv -H localhost -d mysql://sysop:sysop@localhost/seiscomp-test

155
share/doc/seiscomp/html/_sources/base/contributing-docs.rst.txt
View File

@ -10,18 +10,17 @@ It aims to document the configuration and command line options for
consistent way. The functionality of |scname| differs between
versions so the documentation is versioned along with |scname|.
For more general topics and tutorials please refer to the
`SeisComP wiki`_.
|scname| website and documentation :cite:p:`seiscomp`.
The documentation is written in `reStructuredText`_ (reST) a
simple text mark up format. The documentation is generated using `Sphinx`_
which is used to create the `Python documentation`_.
The Sphinx website has a very good
`introduction to reST`_ and also covers the Sphinx specific
`directives`_.
The documentation is written in :cite:t:`reStructuredText` (reST) a simple text
mark up format. The documentation is generated using Sphinx :cite:p:`sphinx`
which is used to create the Python documentation :cite:p:`python-doc`.
The Sphinx website :cite:p:`reStructuredText-sphinx` has a very good
introduction to reST and also covers the Sphinx-specific
directives :cite:p:`reStructuredText-directives`.
If you would like to add to this documentation or you find an error, then please
submit a patch to `SeisComP on GitHub`_ or report to the
SeisComP `discussion forum`_.
submit a patch to :cite:t:`seiscomp-github` or report to the :cite:t:`seiscomp-forum`.
.. note::
@ -33,54 +32,64 @@ then you can use the *Show Source* link on each page to view the reST
source. The source and the documentation files for executables (see below) are
good starting points for a new patch.
Documenting Executables
=======================
The documentation for executables is generated from two sources:
The documentation for modules and plugins is generated from two sources:
'executable'.xml
An XML file that contains a brief description of the command,
markup describing the command line parameters, and any
configuration parameters for the executable. Each parameter should
An :ref:`XML file <contributing_documentation_XML>` that contains a brief
description of the command, markup describing the command line parameters,
and any configuration parameters for the executable. Each parameter should
have a brief description of the purpose of the parameter.
The description should be plain text and not contain reST markup. Where parameters are common across
a number of executables they should be placed in the appropriate common file and referred to using
their publicID.
The description should be plain text and not contain reST markup. Where
parameters are common across a number of executables they should be placed
in the appropriate common file and referred to using their publicID.
All XML files live in the :file:`doc/apps` directory of the source
distribution or in :file:`etc/descriptions` of an installation.
'executable'.rst
This is a text file in reST markup that gives any more-detailed description and examples for the executable.
It is combined with the corresponding .xml to create the full documentation.
This is a RST text file in :ref:`reST markup <reStructuredText>` that gives
any more-detailed description and examples for modules or plugins. It is
combined with the corresponding :file:`executable.xml` file to create the
full HTML documentation and man pages of a module or plugin.
When listed in a table of content, the RST file allows generating general
content without providing an XML file. Examples can be found in the
`documentation index file`_ .
The first entry in the file should be a paragraph giving a more
detailed description of the executable.
detailed description of the executable. The following paragraphs provide
background information, use cases and examples.
These two files should be placed in a :file:`descriptions` sub-directory of the
respective module, e.g. :file:`src/seedlink/apps/seedlink/descriptions/seedlink.rst`.
The intention is that the documentation is close to the code to make it easier for developers to keep the
documentation up to date with code changes.
respective module or plugin, e.g., the `scolv description`_ .
The intention is that the documentation is close to the code to make it easier
for developers to keep the documentation up to date with code changes.
For a new executable an entry should also be made in the man section of :file:`conf.py`.
The man page is a short form of the documentation that is generated from only the .xml file.
For a new executable an entry can also be made in the man section of
:file:`conf.py`. For |scname| modules located, `documentation templates directory`_.
The man page is a short form of the documentation of a module that is generated
from the XML and the RST files.
Example:
.. code-block:: sh
man scolv
Images
======
Creating the RST
================
Any images should be placed in a suitable sub-directory of :file:`descriptions/media`.
Read the :ref:`documentation on image styles <documentation_style_guide_image>` for more details.
The images can then be referred to (in .rst) like::
The RST file should be written according to the
:ref:`documentation style guide <documentation_style_guide>`.
.. figure:: media/scolv/scolv-overview.png
:width: 16cm
:align: center
Overview of the defrobnicator switches in :ref:`scolv`.
The images will be moved to the correct location during the documentation build.
.. _contributing_documentation_XML:
Understanding the XML
=====================
@ -97,10 +106,13 @@ Any description XML uses the root element *seiscomp*:
...
</seiscomp>
Three elements are used inside the root element: :ref:`module<xml-module>`, :ref:`plugin<xml-plugin>` and :ref:`binding<xml-binding>`.
Modules, plugins and bindings can be described in one XML or split up into one file per description. It is better to
have things as close as possible. A module and its binding should go into one module.XML whereas plugins should
go into separate XML files.
Three elements are used inside the root element: :ref:`module<xml-module>`,
:ref:`plugin<xml-plugin>` and :ref:`binding<xml-binding>`.
Modules, plugins and bindings can be described in one XML or split up into one
file per description. It is better to have things as close as possible. A module
and its binding should go into one module.XML whereas plugins should go into
separate XML files. Examples can be found in the source code as well as in the
XML files installed in :file:`seiscomp/etc/descriptions`.
.. _xml-module:
@ -295,7 +307,6 @@ Element: **configuration**
| | | | |
+-------------------+----------+-----------+---------------------------------------------------+
.. _xml-configuration-parameter:
Element: **parameter**
@ -312,6 +323,13 @@ Element: **parameter**
| | | | configurator to provide specialized input |
| | | | widgets. It is also important for the user |
| | | | how the parameter is read by the module. |
| | | | Supported are: *uint, list:uint, int, list:uint, |
| | | | double, list:double, float, list:float, file, |
| | | | list:file, directory, list:directory, time |
| | | | list:time, host-with-port, boolean, gradient* |
+-------------------+----------+-----------+---------------------------------------------------+
| **options** | attrib | no | Options to type if type is file or directory. |
| | | | Supported: *read, write, execute* |
+-------------------+----------+-----------+---------------------------------------------------+
| **unit** | attrib | no | An optional unit such as "s" or "km" or |
| | | | "deg". |
@ -319,9 +337,28 @@ Element: **parameter**
| **default** | attrib | no | The default value the module uses if this |
| | | | parameter is not configured. |
+-------------------+----------+-----------+---------------------------------------------------+
| **values** | element | no | Lists the supported value separated by comma. For |
| | attrib | | files, the list describes file name suffices. |
+-------------------+----------+-----------+---------------------------------------------------+
| **range** | element | no | The range of values. Format: minimum:maximum |
| | attrib | | |
+-------------------+----------+-----------+---------------------------------------------------+
| **description** | element | no | Gives a brief description of the parameter. |
+-------------------+----------+-----------+---------------------------------------------------+
.. note::
Further explanations of **type**:
* uint: Non-negative integer. Example values: 0, 1
* gradient: Colon-separated pairs of value and color. Example:
-4:"rgb(0,0,255)".
* host-with-port: Colon-separated pairs of host address and port number.
Example: localhost:8080.
* time: Any :ref:`time format supported by SeisComP <time-formats>` is
possible unless stated differently.
* list: One ore more values separated by comma.
.. _xml-configuration-struct:
Element: **struct**
@ -333,6 +370,8 @@ Element: **struct**
| | | | used in a configurator to give a selection |
| | | | of available types to be instantiated. |
+-------------------+----------+-----------+---------------------------------------------------+
| **title** | attrib | no | The title of the struct as shown, e.g. in scconfig|
+-------------------+----------+-----------+---------------------------------------------------+
| **link** | attrib | no | The absolute reference parameter as it would |
| | | | appear in the configuration file which |
| | | | holds all instantiated structures. |
@ -362,8 +401,21 @@ Element: **struct**
| **group** | element | no | Describes a group part of this struct. See |
| | | | :ref:`group<xml-configuration-group>`. |
+-------------------+----------+-----------+---------------------------------------------------+
| **aliases** | attrib | no | Explains where to find alias parameters. |
+-------------------+----------+-----------+---------------------------------------------------+
.. _xml-configuration-extend-struct:
Element: **extend-struct**
+-------------------+----------+-----------+---------------------------------------------------+
| Name | XML type | Mandatory | Description |
+===================+==========+===========+===================================================+
| **type** | attrib | yes | The name of the struct type to be extended. This |
+-------------------+----------+-----------+---------------------------------------------------+
| **match-name** | attrib | no | The name given of the struct with parameters |
| | | | extending name the struct given by name. |
+-------------------+----------+-----------+---------------------------------------------------+
.. _xml-configuration-group:
@ -386,7 +438,6 @@ Element: **group**
| **group** | element | no | Describes a group part of this group. |
+-------------------+----------+-----------+---------------------------------------------------+
Below is an example of the plugin definition for the NonLinLoc plugin. It contains
groups, parameters and structures.
@ -406,7 +457,7 @@ groups, parameters and structures.
</description>
</parameter>
<parameter name="outputPath" type="path" default="/tmp/sc3.nll">
<parameter name="outputPath" type="directory" default="/tmp/sc3.nll">
<description>
Defines the output path for all native NonLinLoc input and
output files.
@ -438,7 +489,6 @@ groups, parameters and structures.
</seiscomp>
.. _xml-command-line:
Command-line
@ -466,7 +516,6 @@ Element: **command-line**
| | | | :ref:`group<xml-command-line-group>`. |
+---------------------+----------+-----------+-----------------------------------------------+
.. _xml-command-line-group:
Element: **group**
@ -484,7 +533,6 @@ Element: **group**
| | | | publicID. |
+---------------------+----------+-----------+-----------------------------------------------+
.. _xml-command-line-option:
Element: **option**
@ -520,7 +568,6 @@ Element: **option**
| **description** | element | no | Gives a brief description of the option. |
+---------------------+----------+-----------+-----------------------------------------------+
Below is an example of the module definition for :program:`scautoloc` (extract).
.. code-block:: xml
@ -533,6 +580,9 @@ Below is an example of the module definition for :program:`scautoloc` (extract).
...
</configuration>
<command-line>
<synopsis>
scautoloc [options]
</synopsis>
<group name="Generic">
<optionReference>generic#help</optionReference>
<optionReference>generic#version</optionReference>
@ -571,11 +621,6 @@ References
.. target-notes::
.. _`SeisComP wiki` : https://www.seiscomp.de/
.. _`reStructuredText` : https://docutils.sourceforge.io/rst.html
.. _`Sphinx` : https://www.sphinx-doc.org/
.. _`Python documentation` : https://docs.python.org/
.. _`introduction to reST` : https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
.. _`directives` : https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
.. _`SeisComP on GitHub` : https://github.com/SeisComP
.. _`discussion forum` : https://forum.seiscomp.de
.. _`documentation index file` : https://github.com/SeisComP/seiscomp/blob/master/doc/templates/index.rst
.. _`scolv description` : https://github.com/SeisComP/main/blob/master/apps/gui-qt/scolv/descriptions/
.. _`documentation templates directory` : https://github.com/SeisComP/seiscomp/tree/master/doc/templates

15
share/doc/seiscomp/html/_sources/base/filter-grammar.rst.txt
View File

@ -213,9 +213,9 @@ parentheses, e.g. :py:func:`DIFF()<DIFF()>`, or without, e.g.
.. py:function:: DT
Replaces each input sample with the sampling time of the current sample. This
Replaces each input sample with the sampling interval of the current sample. This
is a shortcut for :code:`1/SR` but more efficient as the division has to be
done only once and not once per input sample.
done only once and not once per input sample. The output unit is *seconds*.
.. py:function:: DURATION(trigger_on, trigger_off)
@ -252,12 +252,14 @@ parentheses, e.g. :py:func:`DIFF()<DIFF()>`, or without, e.g.
:param a: Coefficient `a`.
.. py:function:: ITAPER(timespan)
.. py:function:: ITAPER(timespan[,offset = 0])
A one-sided cosine taper applied when initializing the filter, e.g. at the
beginning of the data or after longer gaps.
:param timespan: The timespan to apply the taper in seconds.
:param timespan: The length of the taper in seconds
:param offset: The offset in counts removed from the data records before
applying the taper. Optional parameter.
.. py:function:: MAX(timespan)
@ -342,7 +344,8 @@ parentheses, e.g. :py:func:`DIFF()<DIFF()>`, or without, e.g.
.. py:function:: SR
Replaces each input sample with the sampling rate of the current sample.
Replaces each input sample with the sampling rate of the current sample. The
output unit is *1/seconds*.
.. py:function:: STALTA(sta, lta)
@ -377,7 +380,7 @@ parentheses, e.g. :py:func:`DIFF()<DIFF()>`, or without, e.g.
Computes the amplitude sum of the timespan preceding the sample.
.. py:function:: WA([type = 1[,gain=2080[,T0=0.8[,h=0.7]]]])
.. py:function:: WA([type = 1[,gain = 2080[,T0 = 0.8[,h = 0.7]]]])
The simulation filter of a :term:`Wood-Anderson seismometer`. The data format
of the waveforms has to be given for applying the simulation filter

135
share/doc/seiscomp/html/_sources/base/getting-started.rst.txt
View File

@ -21,35 +21,10 @@ Once the database server is defined and optimized as described in the section
Initially execute the steps listed in this section. You will need to consider
differences in databases:
* :ref:`MySQL <getting-started-mysql>` (not recommended),
* :ref:`MariaDB <getting-started-mariadb>`,
* :ref:`PostgreSQL <getting-started-postgresql>`.
.. _getting-started-mysql:
MySQL
-----
The initial configuration by the :program:`seiscomp` script or the
wizard of :ref:`scconfig` allows to create and configure the MySQL database
for |scname|. If you want to use MySQL continue with the
:ref:`general setup <getting-started-setup>`.
.. warning ::
* Using MySQL is currently not recommended. Preferably use MariaDB instead of MySQL
as MariaDB is the default SQL flavor of most supported Linux systems!
* As of MySQL 8.0 the password encryption and policy has changed resulting in
errors when connecting to a MySQL server. In 04/2021 this
does not seem to be fully supported in **Ubuntu 20.04**. Therefore, you need
to use a native password on the MySQL server.
.. code-block:: sh
$ sudo mysql -u root -p
ALTER USER 'sysop'@'%%' IDENTIFIED WITH mysql_native_password BY 'my_super_secret_password_matching_the_mysql_password_validation_policy';
* :ref:`PostgreSQL <getting-started-postgresql>`,
* :ref:`SQLite3<getting-started-sqlite3>`,
* :ref:`MySQL <getting-started-mysql>` (not recommended).
.. _getting-started-mariadb:
@ -81,7 +56,7 @@ The full procedure to create the seiscomp database:
.. code-block:: sh
user@host:~$ sudo mysql -u root -p
CREATE DATABASE seiscomp CHARACTER SET utf8mb4;
CREATE DATABASE seiscomp CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
grant usage on seiscomp.* to sysop@localhost identified by 'sysop';
grant all privileges on seiscomp.* to sysop@localhost;
grant usage on seiscomp.* to sysop@'%' identified by 'sysop';
@ -92,11 +67,10 @@ The full procedure to create the seiscomp database:
user@host:~$ mysql -u sysop -p seiscomp < ~/seiscomp/share/db/mysql.sql
.. note::
If character set 'utf8mb4' is not supported by your specific database server
version then use the old 'utf8' format. For historical reasons, SeisComP
would use then the 'utf8_bin' collation. The full statement looks as
follows: :code:`CREATE DATABASE seiscomp CHARACTER SET utf8 COLLATE utf8_bin`.
version then use the old 'utf8' format. The full statement looks as follows:
:code:`CREATE DATABASE seiscomp CHARACTER SET utf8 COLLATE utf8_bin`.
.. _getting-started-postgresql:
@ -108,14 +82,13 @@ for |scname|.
It also allows :ref:`creating the database <database_configuration_postgresql>`
and the database tables.
For a manual setup of the PostgreSQL database first :ref:`setup the database
server<database_configuration_postgresql>`, then create the user, the database
and the tables.
For a manual setup of the PostgreSQL database first
:ref:`setup the database server<database_configuration_postgresql>`. Thereafter
create the user, the database and the tables.
#. Create the user and the database
:program:`CentOS`:
:program:`RHEL`:
.. code-block:: sh
@ -138,7 +111,42 @@ and the tables.
user@host:~$ psql -f ~/seiscomp/share/db/postgres.sql -t seiscomp -U sysop
Continue with the :ref:`general setup <getting-started-setup>` considering the
created database but **do not create the database again**.
created database but you do not need to create the database again.
.. _getting-started-sqlite3:
SQLite3
-------
Alternatively, a SQLite3 database can be used. The setup up is identical to the
other databases and described in section :ref:`getting-started-setup` .
.. _getting-started-mysql:
MySQL
-----
The initial configuration by the :program:`seiscomp` script or the
wizard of :ref:`scconfig` allows to create and configure the MySQL database
for |scname|. If you want to use MySQL continue with the
:ref:`general setup <getting-started-setup>`.
.. warning::
* Using MySQL is currently not recommended. Preferably use MariaDB instead of MySQL
as MariaDB is the default SQL flavor of most supported Linux systems!
* As of MySQL 8.0 the password encryption and policy has changed resulting in
errors when connecting to a MySQL server. In 04/2021 this
does not seem to be fully supported in **Ubuntu 20.04**. Therefore, you need
to use a native password on the MySQL server.
.. code-block:: sh
$ sudo mysql -u root -p
ALTER USER 'sysop'@'%%' IDENTIFIED WITH mysql_native_password BY 'my_super_secret_password_matching_the_mysql_password_validation_policy';
.. _getting-started-setup:
@ -204,20 +212,18 @@ trunk modules and the default request handler of Arclink.
.. code-block:: none
0) mysql
MySQL server.
Enable database storage. [yes]:
0) mysql/mariadb
MySQL/MariaDB server.
1) postgresql
PostgreSQL server. There is currently no support in setup to create the
database for you. You have to setup the database and user accounts on
your own. The database schema is installed under share/db/postgresql.sql.
PostgresSQL server version 9 or later.
2) sqlite3
SQLite3 database.
Database backend [0]:
If the database is enable the database backend can be selected. |scname|
supports two main backends: MySQL and PostgreSQL. Select the backend to be used
here but be prepared that only for the MySQL backend the setup can help to
create the database and tables for you. If you are using PostgreSQL you have
to provide a working database with the correct schema. The schema files are
part of the distribution and can be found in :file:`seiscomp/share/db/postgresql.sql`.
If the database is enabled, the database backend can be selected. |scname|
supports three main backends: MariaDB/MySQL, PostgreSQL, and SQLite3. Select the
backend to be used.
.. note::
@ -236,13 +242,6 @@ part of the distribution and can be found in :file:`seiscomp/share/db/postgresql
Create database [yes]:
.. warning ::
If MySQL is selected it is possible to let :command:`seiscomp setup` to create
the database and all tables for you. Otherwise currently not and you need to set up the
database manually following the :ref:`given instructions <getting-started-mysql>`.
If the database has been created already, answer 'no' here.
----
.. code-block:: none
@ -294,12 +293,16 @@ without doing anything.
Command? [P]:
.. _getting-started-variables:
Environment variables
=====================
Commands can be used along with the :program:`seiscomp` script located in *seiscomp/bin/seiscomp*.
Read the section :ref:`sec-management-commands` for more details on :program:`seiscomp`.
E.g. |scname| modules can be executed like ::
E.g. |scname| modules can be executed like
.. code-block:: sh
user@host:~$ seiscomp/bin/seiscomp exec scrttv
@ -314,11 +317,15 @@ Providing the full path allows starting other |scname| modules in a specific
|scname| environment. Thus, multiple SeisComP installations can be maintained
and referred to on the same machine.
:program:`seiscomp` can also be used for printing the considered |scname| environment ::
:program:`seiscomp` can also be used for printing the considered |scname| environment
.. code-block:: sh
user@host:~$ seiscomp/bin/seiscomp print env
resulting in ::
resulting in
.. code-block:: sh
export SEISCOMP_ROOT="/home/sysop/seiscomp"
export PATH="/home/sysop/seiscomp/bin:$PATH"
@ -335,11 +342,15 @@ executed without the :program:`seiscomp` script.
For setting the environment
#. Use the :program:`seiscomp` script itself to generate the parameters and write
the parameters to :file:`~/.bashrc` ::
the parameters to :file:`~/.bashrc`
.. code-block:: sh
user@host:~$ seiscomp/bin/seiscomp print env >> ~/.bashrc
#. Load the environment or log out and in again ::
#. Load the environment or log out and in again
.. code-block:: sh
user@host:~$ source ~/.bashrc

32
share/doc/seiscomp/html/_sources/base/glossary.rst.txt
View File

@ -343,7 +343,7 @@ Scientific and technical terms
seismicity. It is the main development and service company for |scname|.
GEOFON
GEOFON (https://geofon.gfz-potsdam.de) is part of the Modular Earth Science
GEOFON (https://geofon.gfz.de) is part of the Modular Earth Science
Infrastructure (MESI) at :term:`GFZ`.
geometrical spreading
@ -351,8 +351,8 @@ Scientific and technical terms
increasing distance from a given source.
GFZ
Helmholtz Centre Potsdam `German Research Centre for Geosciences <http://www.gfz-potsdam.de/>`_.
|scname| was originally developed at GFZ.
`GFZ Helmholtz Centre for Geosciences <http://www.gfz.de/>`_. |scname| was
originally developed at GFZ.
GMPE
Ground Motion Prediction Equation
@ -626,21 +626,14 @@ Scientific and technical terms
magnitude, broadband surface wave (Ms(BB))
Ms(BB) is a broadband magnitude scale based on teleseismic surface waves.
In contrast to :term:`Ms <magnitude, surface wave (Ms)>`, amplitudes for Ms(BB)
In contrast to :term:`Ms <magnitude, surface wave (Ms)>`/
:term:`Ms <magnitude, surface wave (Ms_20)>`, amplitudes for Ms(BB)
are measured as the maximum on vertical true ground motion velocity seismograms without
instrument simulation or restitution.
The Moscow-Prague equation for surface wave magnitude is applied as given by
.. math::
M_s = \log \left(\frac{A}{2\pi}\right) + 1.66 \log(\Delta) + 3.3
* Amplitude unit in |scname|: **meter per second** (m/s)
* Period range: all
* Distance range: 2 - 160°
* Depth range: 0 - 100 km
* Time window: distance (km) / 3.5 km/s + 30 s
The Moscow-Prague equation for surface wave magnitude is applied.
Read the :ref:`technical documentation <global_msbb>` for more details and
the configuration.
magnitude, duration (Md)
The duration magnitude measured on the coda wave train.
@ -998,7 +991,7 @@ Scientific and technical terms
:term:`SeisComP` Markup Language. SCML is a flavor of `QuakeML
<https://quake.ethz.ch/quakeml/>`_ and is used by |scname| and by
products of :term:`gempa GmbH` for exchange. For details read the
`UML diagram <https://geofon.gfz-potsdam.de/_uml/>`_.
`UML diagram <https://geofon.gfz.de/_uml/>`_.
SDS
|scname| Data Structure which is used for archiving waveform data. Below the
@ -1026,10 +1019,9 @@ Scientific and technical terms
seismological data acquisition and real-time data exchange over internet.
Its data transmission protocol SeedLink became a de facto world standard.
The first version of SeisComP was developed for the `GEOFON
<http://geofon.gfz-potsdam.de/geofon/>`_ network and further extended
within the MEREDIAN project under the lead of `GEOFON
<http://geofon.gfz-potsdam.de/geofon/>`_/`GFZ
<http://www.gfz-potsdam.de/>`_ Potsdam and `ORFEUS
<http://geofon.gfz.de>`_ network and further extended within the MEREDIAN
project under the lead of `GEOFON <http://geofon.gfz.de>`_/`GFZ
<http://www.gfz.de>`_ Potsdam and `ORFEUS
<http://www.orfeus-eu.org/>`_. Originally SeisComP was designed as a high
standard fully automatic data acquisition and (near-)real-time data
processing tool including quality control, event detection and location as

10
share/doc/seiscomp/html/_sources/base/history.rst.txt
View File

@ -19,7 +19,9 @@ Following the devastating 2004 Indian Ocean earthquake and tsunami, the
to additional functionality being implemented to fulfill the requirements of
24/7 early warning control centers. Major changes in the architecture of SeisComP
were necessary and many new features resulted in the upgrade of SeisComP to
version 3.
version 3, resulting in the new name SeisComP3. Since the major software redesign
including a new messaging system and the switch to AGPL in 2020 the term
SeisComP is exclusively used along with the version number.
Since 2008 SeisComP has been jointly developed by :term:`gempa GmbH`, a spin-off
company of GFZ and GFZ. Nowadays, gempa GmbH is the main SeisComP developing and
@ -51,7 +53,7 @@ are documented in the :ref:`changelog <sc-changelog>`.
| 2.5 | | March 2006 | Integration of add-on packages, modular config |
| | | | script |
+---------+-----------+--------------------+-----------------------------------------------------+
| 3.0 | alpha | May 2007 | new architecture, new magnitude types, GUI |
| 3.0 | alpha | May 2007 | New architecture, new magnitude types, GUI |
+---------+-----------+--------------------+-----------------------------------------------------+
| 3.0 | Barcelona | May 2008 | Stability and performance improvements, improved |
| | | | GUI functionality |
@ -69,3 +71,7 @@ are documented in the :ref:`changelog <sc-changelog>`.
| 4.0.0 | | May 2020 | Adopts the GNU Affero General Public License v. 3.0,|
| | | | (AGPL), support for Python3 and QT5 |
+---------+-----------+--------------------+-----------------------------------------------------+
| 5.0.0 | | June 2022 | |
+---------+-----------+--------------------+-----------------------------------------------------+
| 6.0.0 | | November 2023 | |
+---------+-----------+--------------------+-----------------------------------------------------+

258
share/doc/seiscomp/html/_sources/base/installation.rst.txt
View File

@ -10,10 +10,12 @@ long-term support (LTS). The Linux flavors under which |scname| has been tested
are given along with the |scname| package names on the download sites of
:cite:t:`seiscomp` and :cite:t:`gempa`.
The software can be obtained and installed from
|scname| can be obtained and installed from
* Officially released packages (TAR files) for different release versions,
Linux systems and architectures,
* Officially released packages (TAR files) for different
:ref:`release versions <installation_versions>`, Linux systems and
architectures from the download sites of |scname| :cite:p:`seiscomp` or from
:cite:t:`gempa-download`.,
* :ref:`Source code available on GitHub <build>`.
Packages may include
@ -30,10 +32,90 @@ Download these packages from :cite:t:`seiscomp` or :cite:t:`gempa-download`.
The next sections describe the installation of the binary packages of |scname|
on
* :program:`Ubuntu 18`, 64 bit system,
* :program:`CentOS 7`, 64 bit system.
* :program:`Ubuntu`, 64 bit system,
* :program:`RHEL`, 64 bit system.
.. _installation_versions:
SeisComP Versions
=================
|scname| has :ref:`developed over time <history>`. The versions can be
distinguished by the name of the release:
* **SeisComP since version 4.0.0** uses release version numbers such as *5.2.1*
where
* 5: major version with changes in API and database schema version, new features,
bug fixed, optimizations,
* 2: minor version with new features, bug fixed, optimizations,
* 1: patch number with bug fixes, optimizations.
* **SeisComP3** uses release versions, names, numbers and patch numbers.
Full example: *SeisComP3-jakarta-2020.330.02*
* 3: release version
* jakarta: release name
* 2020.330: release number
* 02: patch number
Names are adjusted depending on changes in source code:
* **Release version:** major changes in module groups, functionality,
concepts, data model.
Example: SeisComp3 is SeisComP in version 3.0
in comparison to version 2.5 the GUIs were introduced.
* **Release name:** major changes in functionality, concepts, data model.
Example: with SeisComP3-Seattle the new user friendly configuration GUI
:ref:`scconfig` was introduced.
* **Release number:** changes in data model version and/or major changes in
applications and optimizations.
The numbers include the year and the day of the year of the software
release. Example: Jakarta-2018.327
* **Patch number:** optimizations of applications without changes in the data
model version.
The version number of the installed |scname| can be obtained by
* This documentation where it printed in the header along with the SeisComP icon
* The running any |scname| module on the command-line using :option:`-V` such as
.. code-block:: sh
$ scm -V
scm
Framework: 6.8.4 Release
API version: 16.3.0
Data schema version: 0.13
GIT HEAD: c28f6323
Compiler: c++ (Ubuntu 13.2.0-23ubuntu4) 13.2.0
Build system: Linux 6.8.12-11-pve
OS: Ubuntu 24.04 LTS / Linux
.. _installation-os:
Supported Operating Systems
===========================
|scname| is developed and tested on Linux for the latest stable flavors with
long-term support (LTS) and on x86_64 architecture. For |scname| in version
7.*.*. the minimum OS and version are
* Debian: 11
* RHEL: 8
* Ubuntu: 22.04
Higher versions of |scname| will require higher OS versions.
Packages for more flavors and versions may be found on
`the SeisComP website <https://www.seiscomp.de/downloader/>`_.
.. _installation-hw:
Hardware Requirements
=====================
@ -50,7 +132,6 @@ Minimum requirements are:
CPU; 2
RAM; 4 GB
HDD; 20 GB
OS; Ubuntu last 3 major LTS versions, 64bit, Debian 8.0 64bit, RHEL 7, CentOS 7 64bit
In case large networks (>100 stations) are operated, a distributed system is
recommended. Normally a |scname| system is separated in several subsystems.
@ -93,17 +174,58 @@ GUI system:
.. _installation-packages:
Installation from Packages
==========================
Installation of Packages
========================
This section describes the installation of |scname| from compiled |scname|
packages which ship as :file:`*.tar.gz` files.
This section describes the initial installation of |scname| from compiled
|scname| packages which ship as :file:`*.tar.gz` files. For installation from
source code follow the instructions outlined in section :ref:`compiling_source`.
You may install the |scname| packages in either way:
* :ref:`gsm<installation-gsm>` (recommended) a package manager provided by
:cite:t:`gempa`,
* :ref:`manually by extracting packages <installation-manual>`.
For later updates/upgrades read the tutorial :ref:`tutorials_upgrade`.
.. hint::
We recommend to track any changes in the installation and configuration of
|scname| except :file:`seiscomp/var`, :file:`seiscomp/share/maps` and large
binary files or files changing often during |scname| operation
(e.g. :ref:`global_hypo71`, :ref:`global_nonlinloc` input and output files)
using :program:`git`.
.. _installation-gsm:
gsm
---
Installation of packages by gsm :cite:p:`gsm` is
recommended allowing to easily update/upgrade or add/remove packages in the
future and in order to maintain a clean file structure also after
updates/upgrades. If you wish to install and maintain |scname|
by :program:`gsm` :cite:p:`gsm`, then read the instruction given in the
:cite:t:`gsm-doc`.
.. note::
While :program:`gsm` :cite:p:`gsm` allows the installation of software
packages the OpenSource map package of |scname| must be
:ref:`installed manually <installation-manual>`.
Steps to take
-------------
.. _installation-manual:
Simply follow a few steps to complete your installation of |scname|:
Manual unpacking
----------------
A simply installation can be done by simply downloading and unpacking the
packages, but installation and maintenance using :ref:`gsm<installation-gsm>`
is recommended.
For simple unpacking follow a few steps to complete your installation of
|scname|:
#. Log in to your Linux system as user, e.g. sysop, the standard user in this
documentation.
@ -150,16 +272,18 @@ Simply follow a few steps to complete your installation of |scname|:
user@host:~$ tar xzf seiscomp-[version]-doc.tar.gz
Unpacking these files creates the |scname| :ref:`directory structure<directory_structure>`.
.. _directory_structure:
Directory structure
-------------------
Directory Structure
===================
All installed files and directories are found below the *seiscomp* directory.
The directory structure of the installed system is described the table below.
The installation of |scname| creates the |scname|
:ref:`directory structure<directory_structure>`.
All installed files and directories are found below the *seiscomp* directory
unless an alternative directory is given when installing with :program:`gsm` or
:ref:`compiling from source code<compiling_source>`.
The directory structure of the installed system is described in the table below.
.. csv-table::
:widths: 10 90
@ -188,76 +312,63 @@ The directory structure of the installed system is described the table below.
.. _software_dependencies:
Software dependencies
---------------------
Software Dependencies
=====================
|scname| depends on a number of additional software packages shipped with each
Linux distribution.
After installation of |scname| these packages can be installed using the
:program:`seiscomp`.
The :program:`seiscomp` tool comes with
the command :command:`install-deps` which installs required packages.
Read the section :ref:`System management<system-management>` for more detailed
instructions. For example, to install the dependencies for using the MariaDB
database, give 'mariadb-server' as parameter.
:ref:`seiscomp` script.
:ref:`seiscomp` comes with the command :command:`install-deps` which installs
required packages. For example, to install the dependencies for
using the MariaDB database, give 'mariadb-server' as parameter.
.. code-block:: sh
user@host:~$ seiscomp/bin/seiscomp install-deps base mariadb-server
Distribution: Ubuntu 18.04
Distribution: Ubuntu 24.04
[sudo] password for sysop:
Reading package lists... Done
Building dependency tree
Reading state information... Done
...
More options for systems with GUIs and FDSNWS are: ::
user@host:~$ seiscomp/bin/seiscomp install-deps gui fdsnws
If your distribution is not supported by :command:`install-deps`,
install the above packages manually:
:program:`Ubuntu` `version`
More requirements for systems with GUIs, FDSNWS and iLoc are:
.. code-block:: sh
user@host:~$ cd seiscomp/share/deps/ubuntu/[version]
...
user@host:~$ seiscomp/bin/seiscomp install-deps gui
user@host:~$ seiscomp/bin/seiscomp install-deps fdsnws
user@host:~$ seiscomp/bin/seiscomp install-deps iloc
:program:`CentOS` `version`
If your distribution is not supported by :ref:`seiscomp` *install-deps*,
install the above packages manually from the scripts within the OS- and
version-dependent directories:
.. code-block:: sh
user@host:~$ cd seiscomp/share/deps/centos/[version]
user@host:~$ cd seiscomp/share/deps/[OS]/[version]
...
.. code-block:: sh
su root
bash install-mariadb-server.sh
bash install-postgresql-server.sh
bash install-base.sh
bash install-gui.sh
bash install-fdsnws.sh
...
or contact the |scname| developers to add support for your distribution.
Read the section :ref:`System management<system-management>` for more detailed
options and instructions.
.. warning::
Either the MariaDB **or** the MySQL server can be installed; not both at the
same time. When replacing on by the other, ensure that all related files are
Either the MariaDB **or** the MySQL server can be installed; **not both at the
same time**. When replacing one by the other, ensure that all related files are
removed before installing the alternative server. For MySQL instead of MariaDB
use: ::
use:
.. code-block:: sh
root@host:~$ sh install-mysql-server.sh
Preferably use MariaDB instead of MySQL as MariaDB is the default for the
supported Linux distributions!
.. note ::
.. note::
Linux systems develop dynamically and the installation of the dependencies
may be incomplete. |scname| modules will stop and indicate the missing software.
@ -304,7 +415,7 @@ MariaDB / MySQL
innodb_buffer_pool_size = <your value>
innodb_flush_log_at_trx_commit = 2
.. note ::
.. note::
The location of the configuration file can differ between distributions.
@ -312,7 +423,7 @@ MariaDB / MySQL
:file:`/etc/mysql/mariadb.conf.d/50-server.cnf`
:program:`CentOS`:
:program:`RHEL`:
:file:`/etc/my.cnf`
@ -327,7 +438,7 @@ MariaDB / MySQL
user@host:~$ sudo systemctl enable mariadb
:program:`CentOS`
:program:`RHEL`
.. code-block:: sh
@ -337,11 +448,15 @@ MariaDB / MySQL
* If you make a fresh installation of MariaDB/MySQL, secure the database and set
a password for the root user
:program:`Ubuntu` ::
:program:`Ubuntu`
.. code-block:: sh
user@host:~$ sudo mysql_secure_installation
:program:`CentOS` ::
:program:`RHEL`
.. code-block:: sh
user@host:~$ su root
root@host:~$ mysql_secure_installation
@ -361,14 +476,14 @@ MariaDB / MySQL
user@host:~$ sudo systemctl restart mariadb
:program:`CentOS`:
:program:`RHEL`:
.. code-block:: sh
user@host:~$ su root
root@host:~$ systemctl restart mariadb
.. note ::
.. note::
Replace mariadb by mysql when using MySQL instead of MariaDB.
@ -385,15 +500,14 @@ PostgreSQL
after |scname| database initialization. Here an example how to enable
user/password authentication for local and remote connections.
.. code-block:: sh
# TYPE DATABASE USER ADDRESS METHOD
# IPv4 local connections:
host seiscomp sysop 0.0.0.0/0 md5
host all all 127.0.0.1/32 ident
# TYPE DATABASE USER ADDRESS METHOD
# IPv4 local connections:
host seiscomp sysop 0.0.0.0/0 md5
host all all 127.0.0.1/32 ident
.. note ::
.. note::
The order of the rules matters and the location of the configuration file
can differ between distributions.
@ -402,7 +516,7 @@ PostgreSQL
:file:`/etc/postgresql/10/main/pg_hba.conf`
:program:`CentOS`:
:program:`RHEL`:
:file:`/var/lib/pgsql/data/pg_hba.conf`
@ -414,7 +528,7 @@ PostgreSQL
listen_addresses = 0.0.0.0/0
.. note ::
.. note::
The location of the configuration file can differ between distributions.
@ -422,7 +536,7 @@ PostgreSQL
:file:`/etc/postgresql/10/main/postgresql.conf`
:program:`CentOS`:
:program:`RHEL`:
:file:`/var/lib/pgsql/data/postgresql.conf`

27
share/doc/seiscomp/html/_sources/base/management.rst.txt
View File

@ -86,10 +86,23 @@ The *seiscomp* script can be executed with additional commands:
* **install-deps** [packages]
Installs 3rd party packages on which |scname| depends such as MariaDB or MySQL.
Installs 3rd-party packages on which |scname| depends such as MariaDB or MySQL.
This is currently only supported for major Linux distributions. A list of packages
needs to be given. Available packages are: **base**, **GUI**,
**mariadb-server**, **postgresql-server**, **fdsnws**.
needs to be given. Available packages are defined in BASH scripts located in
:file:`@DATADIR@/deps/[os]/[version]/install-[name].sh`:
.. csv-table::
:widths: 40 60
:align: left
:delim: ;
:header: Package name, Installation
base; Base libraries needed for all |scname| module
gui; Libraries for running graphical interfaces
mariadb-server/mysql-sever; Mariadb/MySQL server
postgresql-server; Postgresql server
fdsnws; Python modules for running FDSNWS
iloc; Auxiliary files for :ref:`global_iloc` from :cite:t:`iloc-github`
#. Install only base system dependencies:
@ -117,6 +130,12 @@ The *seiscomp* script can be executed with additional commands:
seiscomp install-deps gui fdsnws
#. For using :ref:`global_iloc`:
.. code-block:: sh
seiscomp install-deps iloc
* **list** modules|aliases|enabled|disabled
Lists items.
@ -237,7 +256,7 @@ Examples
/home/sysop/seiscomp/etc/key/seedlink/profile_geofon
--------------------------------------------------------------------------------
sources = chain
sources.chain.address = geofon.gfz-potsdam.de
sources.chain.address = geofon.gfz.de
sources.chain.port = 18000
--------------------------------------------------------------------------------

5
share/doc/seiscomp/html/_sources/base/overview.rst.txt
View File

@ -126,8 +126,9 @@ Here *alphanumeric* means the digits 0 to 9, and uppercase letters A-Z.
For publicly-available seismic stations these are typically supplied
by external servers such as :ref:`seedlink` or :cite:t:`caps` servers.
For example, the :cite:t:`geofon` seismic network makes data available at port 18000
at geofon.gfz-potsdam.de which you may query and test using :ref:`slinktool`.
For example, the :cite:t:`geofon` seismic network makes data available at port
*18000* at *geofon.gfz.de* which you may query and test using
:ref:`slinktool`.
If you operate your own seismic network, you may collect data directly
from your station's digitizer using one of the many plugins included with

230
share/doc/seiscomp/html/_sources/base/style-guide.rst.txt
View File

@ -8,19 +8,23 @@ Style Guide for Documentation
File Layout
===========
The documentation of an executable module comes as a pair of source files:
The documentation of an executable module or plugin comes as a pair of source
files:
* A description XML file (.xml) giving command details, command-line and configuration parameters,
* A documentation reST text file (.rst) gives a more-detailed module description and examples.
* A :ref:`description XML file (.xml) <contributing_documentation_XML>` giving
command details, command-line and configuration parameters,
* A :ref:`documentation reST text file (.rst) <documentation_style_guide_rst>`
gives a more-detailed module description and examples.
Any other documentation, e.g. this style guide, tutorials, etc. only require the
documentation reST text file.
The reST text file should follow the guidelines in this style guide.
The :ref:`contributing_documentation` section details the documentation
requirements for executables including the structure of description XML files.
The :ref:`contributing_documentation` section details
the documentation requirements for executables including the structure of description XML files.
.. _documentation_style_guide_rst:
Documentation Syntax
====================
@ -35,10 +39,10 @@ Add information about testing and examples into their own sections.
General principles
------------------
- If possible, keep line lengths under 80 characters.
- It eases later editing if sentences in the raw RST start on a new
* If possible, confine lines to 80 characters.
* It eases later editing if sentences in the raw RST start on a new
line, even though they will flow together in the finished document.
- It is helpful if long text objects such as HTML link text each
* It is helpful if long text objects such as HTML link text each
appear on their own line.
@ -53,14 +57,14 @@ description information in the appropriate part of the documentation.
While RST doesn't care too much about what syntax is used for
headings, it is best to stick to one style consistently.
Thus, you will generally need only two levels of headings but you can add more.
Thus, you will generally need only few levels of headings but you can add more.
+-------+------------------------------+
| Level | Mark up beneath heading text |
+=======+==============================+
| 1 | ' ==== ' |
+-------+------------------------------+
| 2 | " ---- " |
| 2 | ' - - - ' |
+-------+------------------------------+
| 3 | ' ~~~~ ' |
+-------+------------------------------+
@ -89,8 +93,9 @@ Parts such as Examples are marked in **bold**.
However notes and figures should use the appropriate RST directive, and don't require their own headings.
- One blank line below headings is enough.
- Two lines above are often used, and this looks better than one.
* One blank line below headings is enough.
* Two lines above are often used, and this looks better than one.
Lists
-----
@ -122,10 +127,44 @@ Use numbered or unnumbered lists at several levels.
* subitem 2.
Other markup tools and conventions
----------------------------------
Tables
------
- **Code fragments:** Use the reST code-block syntax for code fragments, with
Tables may be generated as CSV tables defining the
* column width
* header text
* alignment
* delimiter
* table content
.. code-block:: rst
.. csv-table::
:widths: 20 80
:header: Item, Value
:align: center
:delim: ;
1; value for item 1
2; value for item 2
**Result:**
.. csv-table::
:widths: 20 80
:header: Item, Value
:align: center
:delim: ;
1; value for item 1
2; value for item 2
Other tools and conventions
---------------------------
* **Code fragments:** Use the reST code-block syntax for code fragments, with
flavors like "c", "python", "sh", "bash", "properties´" or "xml" as appropriate:
.. code-block:: rst
@ -142,7 +181,7 @@ Other markup tools and conventions
#!/bin/bash
echo $SEISCOMP_ROOT
- **Configuration parameters:** Configuration values have a special
* **Configuration parameters:** Configuration values have a special
syntax. Use the ':confval:' indicator for referencing a module configuration
parameter:
@ -150,20 +189,24 @@ Other markup tools and conventions
:confval:`logging.level`
Result: :confval:`logging.level`.
Using this tag allows a link to be made within the documentation of that module
to the given configuration of the same module. The parameter must be defined
in the description XML file of the module.
- **Command-line options:** Command-line options have a special
* **Command-line options:** Command-line options have a special
syntax. Use the ':option:' indicator for referencing an option:
.. code-block:: rst
:option:`--help`
The option must be defined in the description XML file of the module.
Result: :option:`--help`.
- **Configuration files:** Use the reST ':file:' indicator to refer to files such
The option must be defined in the description XML file of the module or global.
* **Configuration files:** Use the reST ':file:' indicator to refer to files such
as configuration files:
.. code-block:: rst
@ -172,7 +215,7 @@ Other markup tools and conventions
Result: :file:`$SEISCOMP_ROOT/etc/scautopick.cfg`
- **Programs:** Use the reST ':program:' indicator for |scname| programs:
* **Programs:** Use the reST ':program:' indicator for |scname| programs:
.. code-block:: rst
@ -180,7 +223,7 @@ Other markup tools and conventions
Result: :program:`scautopick`
- **References:** Use the reST ':ref:' indicator for cross referencing |scname|
* **References:** Use the reST ':ref:' indicator for cross referencing |scname|
module documentation pages:
.. code-block:: rst
@ -189,7 +232,7 @@ Other markup tools and conventions
Result: :ref:`scautopick`
- **Glossary:** Use the reST ':term:' indicator for referencing terms in the
* **Glossary:** Use the reST ':term:' indicator for referencing terms in the
|scname| :ref:`glossary`:
.. code-block:: rst
@ -198,6 +241,27 @@ Other markup tools and conventions
Result: :term:`magnitude`
* **Download link:** Use the reST ':download:' indicator for referencing a file
in the local file system. The file is loaded when clicking on the link
.. code-block:: rst
:download:`changelog <./CHANGELOG.md>`
Result: :download:`changelog <./CHANGELOG.md>`
.. hint::
When using the reST indicators, text may be given which is shown instead of
the actual link. Enclose the actual link within '<link>' and prepend the
actual text. Example
.. code-block:: rst
:ref:`the scautopick module <scautopick>`
Result: :ref:`the scautopick module <scautopick>`
.. _documentation_style_guide_links:
@ -208,19 +272,19 @@ Create links to sections and subsections within and to figures the text which c
Use unique link names, e.g. including the upper-level section name or the module name.
Use appropriate short names to fit within the texts.
Link within this documentation to the section on headings:
Create a label within this |scname| documentation to the section on headings:
.. code-block:: rst
.. _documentation_style_guide_headings:
Reference:
and refer to the lable within the text:
.. code-block:: rst
:ref:`short name <documentation_style_guide_headings>`
:ref:`link to this section <documentation_style_guide_headings>`
Result: :ref:`short name <documentation_style_guide_headings>`
Result: :ref:`link to this section <documentation_style_guide_headings>`
External links and references
@ -336,66 +400,19 @@ Make sensible use of it!
This adds an important warning.
English Language
================
- SeisComP (capital P), not SeisComP 3 or SC3.
- |scname| module names are proper nouns, even though written with lower case.
Thus they do not need an article.
* Correct: "Although :program:`scmaster` receives a message"
* Incorrect: "Although the scmaster receives a message..."
A sentence may begin with a lower case module name e.g. "scmaster has five modes..."
avoiding this: "The :program:`scmaster` module has..."
- Word separation:
- Separate words:
base class, wave number, time span
- One word:
aftershock, foreshock, *and mainshock too*,
bandpass, eigenperiod etc., metadata, standalone, username, workflow, waveform
- Difficult:
high-pass filter; command line; command-line parameter
- Hyphenation for compound adjectives: yes, before a noun; after verb to be is harder.
See the `discussion`_, e.g.:
- Use command-line parameters
- Type on the command line
- Spelling:
Use American English:
- With 'z': digitizer, realize, visualize, synchronize, behavior, color.
- With 's': license.
- Center, data center.
- Case:
- SEED, miniSEED (miniSEED in :cite:t:`libmseed-github`, or MiniSEED,
but Mini-SEED appears in Appendix G of the :cite:t:`seed-2012`.)
- Ctrl+S for 'control' key plus 's'.
- MySQL, PostgreSQL, MariaDB
- Abbreviations:
- e.g., i.e.
- STA, LTA, STA/LTA detector
- TAR file
.. _documentation_style_guide_images:
Adding Images
=============
Images
------
Code implementation
-------------------
~~~~~~~~~~~~~~~~~~~
The images will be moved to the correct location during the documentation build.
* Place image files in a suitable sub-directory of :file:`descriptions/media`.
* Add images with fixed width.
* Define image alignment.
* Add image captions.
* Store images in a separate directory of below the directory where the
documentation is kept.
@ -436,7 +453,7 @@ Compare with the :ref:`concept section on configuration<concepts_configuration-c
Image style and format
----------------------
~~~~~~~~~~~~~~~~~~~~~~
* Images shall be informative.
* Images must not have any offensive or inappropriate content.
@ -451,6 +468,57 @@ Image style and format
X-forwarding may distort the application features.
English Language
================
* SeisComP (capital P), not SeisComP 3 or SC3.
* |scname| module names are proper nouns, even though written with lower case.
Thus they do not need an article.
* Correct: "Although :program:`scmaster` receives a message"
* Incorrect: "Although the scmaster receives a message..."
A sentence may begin with a lower case module name e.g. "scmaster has five modes..."
avoiding this: "The :program:`scmaster` module has..."
* Word separation:
* Separate words:
base class, wave number, time span
* One word:
aftershock, foreshock, *and mainshock too*,
bandpass, eigenperiod etc., metadata, standalone, username, workflow, waveform
* Difficult:
high-pass filter; command line; command-line parameter
* Hyphenation for compound adjectives: yes, before a noun; after verb to be is harder.
See the `discussion`_, e.g.:
* Use command-line parameters
* Type on the command line
* Spelling:
Use American English:
* With 'z': digitizer, realize, visualize, synchronize, behavior, color.
* With 's': license.
* Center, data center.
* Case:
* SEED, miniSEED (miniSEED in :cite:t:`libmseed-github`, or MiniSEED,
but Mini-SEED appears in Appendix G of the :cite:t:`seed-2012`.)
* Ctrl+S for 'control' key plus 's'.
* MySQL, PostgreSQL, MariaDB
* Abbreviations:
* e.g., i.e.
* STA, LTA, STA/LTA detector
* TAR file
References
==========

19
share/doc/seiscomp/html/_sources/base/tests.rst.txt
View File

@ -7,12 +7,12 @@ Unit Testing
Introduction
============
From Wikipedia:
From Wikipedia [#WPUT]_: ::
In computer programming, unit testing is a software testing method by which
individual units of source code, sets of one or more computer program modules
together with associated control data, usage procedures, and operating
procedures, are tested to determine whether they are fit for use. [#WPUT]_
In computer programming, unit testing is a software testing method by which
individual units of source code, sets of one or more computer program modules
together with associated control data, usage procedures, and operating
procedures, are tested to determine whether they are fit for use.
This chapter targets programmers, either ones contributing to |scname| or
adding their extended set of modules / libraries.
@ -35,6 +35,7 @@ library.
Apart from the availability of the Boost test libraries, cmake with version
2.8.0 or greater is also required.
Preparations
============
@ -53,6 +54,7 @@ its executable against the library the tests are built for.
The recommend test file naming is :code:`{class}_{function}.cpp`.
Execution
=========
@ -62,9 +64,10 @@ Compiling and running tests is as easy as running
make test
in the build directory. Thats it.
in the build directory. That's it.
Test implementation
Test Implementation
===================
The following section shows an example of a simple but in many cases sufficient
@ -108,6 +111,7 @@ your test executable against :code:`${Boost_unit_test_framework_LIBRARY}` and
COMMAND test_mylib_myfeature
)
Warning levels
--------------
@ -163,6 +167,7 @@ Tools
For more tools and information about the Boost unit test tools see [#b4]_.
Test output
===========

87
share/doc/seiscomp/html/_sources/base/time-grammar.rst.txt
View File

@ -13,11 +13,18 @@ Historically, the only time format native to |scname| would be
.. code-block:: properties
YYYY-MM-DD hh:mm:ss.ssssss
'%F %T.%f'
As a consequence of the space between *DD* and *hh* this time string needs
to be enclosed by quotes or double quotes. Otherwise, the time string meant to
be a single string only would be interpreted as two strings. Example:
like
.. code-block:: properties
'2025-01-01 00:00:00.000000'
As a consequence of the space character between *DD* and *HH* this time string
needs to be enclosed by quotes or double quotes. Otherwise, the time string
meant to be a single string only would be interpreted as two strings. Example
application:
.. code-block:: sh
@ -55,55 +62,43 @@ Currently unsupported are:
* Time zone offset designators,
* Local times.
.. csv-table:: List and examples of supported time string formats
:widths: 30 30 40
:header: Implementation, Time string format, Examples: all actual times are identical
.. csv-table:: Table: List and examples of supported time string formats
:widths: 40 60
:header: Implementation (+), Examples: all given times are identical
:align: left
:delim: ;
%FT%T.%fZ ; YYYY-MM-DDThh:mm:ss.ssssssZ ; 2025-01-01T00:00:00.000000Z
%FT%T.%f ; YYYY-MM-DDThh:mm:ss.ssssss ; 2025-01-01T00:00:00.000000
%FT%TZ ; YYYY-MM-DDThh:mm:ssZ ; 2025-01-01T00:00:00Z
%FT%T ; YYYY-MM-DDThh:mm:ss ; 2025-01-01T00:00:00
%FT%R ; YYYY-MM-DDThh:mm ; 2025-01-01T00:00
%FT%H ; YYYY-MM-DDThh ; 2025-01-01T00
%Y-%jT%T.%f ; YYYY-DDDThh:mm:ss.ssssss ; 2025-001T00:00:00.000000
%Y-%jT%T ; YYYY-DDDThh:mm:ss ; 2025-001T00:00:00
%Y-%jT%R ; YYYY-DDDThh:mm ; 2025-001T00:00
%Y-%jT%H ; YYYY-DDDThh ; 2025-001T00
%F %T.%f (*) ; YYYY-MM-DD hh:mm:ss.ssssss ; '2025-01-01 00:00:00.000000'
%F %T (*) ; YYYY-MM-DD hh:mm:ss ; '2025-01-01 00:00:00'
%F %R (*) ; YYYY-MM-DD hh:mm ; '2025-01-01 00:00'
%F %H (*) ; YYYY-MM-DD hh ; '2025-01-01 00'
%F ; YYYY-MM-DD ; 2025-01-01
%Y-%j ; YYYY-DDD ; 2025-001
%Y ; YYYY ; 2025
%FT%T.%fZ ; 2025-01-01T00:00:00.000000Z
%FT%T.%f ; 2025-01-01T00:00:00.000000
%FT%TZ ; 2025-01-01T00:00:00Z
%FT%T ; 2025-01-01T00:00:00
%FT%R ; 2025-01-01T00:00
%FT%H ; 2025-01-01T00
%Y-%jT%T.%f ; 2025-001T00:00:00.000000
%Y-%jT%T ; 2025-001T00:00:00
%Y-%jT%R ; 2025-001T00:00
%Y-%jT%H ; 2025-001T00
%F %T.%f (*) ; '2025-01-01 00:00:00.000000'
%F %T (*) ; '2025-01-01 00:00:00'
%F %R (*) ; '2025-01-01 00:00'
%F %H (*) ; '2025-01-01 00'
%F ; 2025-01-01
%Y-%j ; 2025-001
%Y ; 2025
(+): Compare the formats with those of the :program:`date` command:
:program:`man date`.
(*): Time strings with spaces must be enclosed by quotes or double quotes for
protecting the space.
protecting the space character.
.. csv-table:: List of format symbols used in table of time string formats
:widths: 10 90
:header: Symbol, Description
:align: left
:delim: ;
YYYY; 4-digit year
MM; 2-digit month starting with 01
DD; 1- or 2-digit day of the month starting with 01
DDD; 1-, 2- or 3-digit day of year starting with 001
hh; 1- or 2-digit hour of the day starting with 00
mm; 1- or 2-digit minute of the hour starting with 00
ss; 1- or 2-digit second of the minute starting with 00
ssssss; 1-6 digits decimal fraction of a second with 0
Z; Zone designator for the zero UTC offset
Durations can be formed from start and end dates and times combined by tilde(~).
Example:
Time spans can be formed from start and end dates and times combined by tilde
(~). Examples:
.. code-block:: sh
scart -dsEv -t 2024-01-01T12~2024-01-01T12:15:30.2Z
scart -dsEv -t '2024-01-01 12:00:00~2024-01-01 12:15:30.2'
.. _time-grammar:
@ -258,7 +253,7 @@ Functions
.. py:function:: tt(phase)
Calculates the travel-time of the given phase **w.r.t. relative origin
time, :py:envvar:`OT`**. The result is unset if the travel time cannot be
time**, :py:envvar:`OT`. The result is unset if the travel time cannot be
computed. The travel times are computed based on the travel-time interface
and model defined in :confval:`amplitudes.ttt.interface` and
:confval:`amplitudes.ttt.model`, respectively.
@ -276,9 +271,9 @@ Functions
sensor location of the associated pick must match the sensor
location of the target object.
:param acceptAll: Whether to accept all arrivals or only manually
revised arrivals. The default is 'true' if not
revised arrivals. The default is 'false' if not
given. Allowed is either 'true' or 'false'. If
'true' is given, then either the evaluation mode
'false' is given, then either the evaluation mode
of the origin or the evaluation mode of the pick
must be 'manual'.

2
share/doc/seiscomp/html/_sources/base/tutorials.rst.txt
View File

@ -22,7 +22,7 @@ For details, see the other chapters of this manual.
/base/tutorials/processing
/base/tutorials/geofon_waveforms
/base/tutorials/servefdsnws
/base/tutorials/magnitude-regionalization
/base/tutorials/amplitudes-magnitudes
/base/tutorials/waveformplayback
/base/tutorials/help

528
share/doc/seiscomp/html/_sources/base/tutorials/amplitudes-magnitudes.rst.txt Normal file
View File

@ -0,0 +1,528 @@
.. _tutorials_magnitude-region-aliases:
***************************************************
Amplitudes/Magnitudes: Regionalization, Aliases, Mw
***************************************************
You will ...
* Regionalize magnitudes.
* Create new amplitude and magnitude types as aliases from other amplitudes and
magnitudes.
* Map magnitudes to the moment magnitude, Mw.
:Pre-requisites for this tutorial:
* Read the :ref:`concepts section on magnitudes <concepts_magnitudes>`.
* Real-time data for the station must be available locally.
See :ref:`tutorials_waveforms` or :ref:`tutorials_geofon_waveforms`.
* Inventory must be loaded locally.
:Afterwards/Results/Outcomes:
* Regionalized amplitudes and magnitudes
* New amplitude and magnitude types as aliases
* Moment magnitudes
:Time range estimate:
* 60 minutes
-----------
Regionalization
===============
By regionalization, amplitudes and magnitudes can be computed depending on the
region of the source or source-receiver pairs.
Regions are defined by polygons in BNA or GeoJSON files which must be known to
|scname|.
.. _tutorials_amplitudes-region:
Amplitudes
----------
Measuring amplitudes only for sources or pairs of sources and stations in
specific regions is possible by regionalization. The region polygons are defined
by :ref:`magnitude regionalization <tutorials_magnitude-region>`. In
order to use the feature, regionalized amplitudes and magnitudes must have the
same type (name) and regionalization must be activated per amplitude type in
amplitude-type profiles of global bindings.
.. _tutorials_magnitude-region:
Magnitudes
----------
With regionalization magnitudes can be computed with region-dependent parameters.
If magnitude regionalization is configured but a source or source-station pairs
are not considered, no magnitude of the corresponding type is computed.
Setup
~~~~~
The procedure to set up magnitude regionalization is:
#. Create one file which contains the polygons surrounding the regions within
which magnitude parameters shall apply. The polygon files are provided in
:ref:`BNA <sec-gui_layers-vector-format-bna>` or
:ref:`GeoJSON format <sec-gui_layers-vector-format-geojson>` and located as
set out in the :ref:`documentation of map layers <sec-gui_layers>`. The file
can be created from any |scname| GUI application providing maps, e.g.,
:ref:`scmv`.
#. For the desired magnitude type create a magnitude-type profile in global
module configuration. The name of the profile matches the name of the
magnitude, e.g., *MLc* for the :ref:`MLc magnitude <global_mlc>`.
#. Configure the :confval:`magnitudes.MLc.regionFile` parameter with the full
path and name of the polygon file created above.
#. Within the magnitude-type profile create one or more magnitude-region
profile(s) for defining the regionalized parameters applied to the region(s).
The name of a profile corresponds to the name of the polygon contained in the
polygon file to which the parameters shall apply. Use *world* for all regions
not covered by any polygon.
#. Configure the regionalized magnitude parameters of the magnitude-region
profile. Activate the *enable* parameter if you wish to apply this profile.
#. Restart the data processing:
.. code-block:: sh
seiscomp restart
or execute a GUI module.
.. important::
* Parameters which can be configured along with regionalization assume
defaults from global binding parameters but override global bindings
parameters when configured.
* Once regionalization is active, magnitudes for events outside the
defined region(s) will not be computed. For considering such events add
another magnitude-region profile with the name "*world*".
Magnitudes for events outside any other magnitude-region profile will then
be computed according to this profile.
Setup: station corrections
~~~~~~~~~~~~~~~~~~~~~~~~~~
:ref:`Magnitude station corrections <concepts-magnitudes-correction>` can also
be applied in case of reBy regionalization, magnitudes can be computed with region-dependent properties.
Regions are defined by polygons in BNA or GeoJSON files which must be known to
|scname|.gionalization. Simply add the names of the
magnitude-region profile along with the correction parameter to the original
parameter in global module configuration, :file:`global.cfg`, for the respective
magnitude type and station. Use comma separation for multiple regions and colon
for separating the region name from the value.
Example for correcting MLv computed at station GE.UGM:
.. code-block:: properties
module.trunk.GE.UGM.magnitudes.MLv.offset = 0.1, europe:0.2, asia:-0.1
.. note::
The configuration of parameters starting with *module.trunk.* is not
supported by :ref:`scconfig`. All corresponding configurations must be done
by directly editing the configuration file, e.g.,
:file:`seiscomp/etc/global.cfg`.
Application
~~~~~~~~~~~
When configured, regionalization is automatically applied when computing
magnitudes in :ref:`scmag` or :ref:`scolv`.
.. _tutorials_mags_regionalize_testing:
Testing
~~~~~~~
* Regionalization:
#. Start :ref:`scolv` with the option :option:`--debug` and load an event of
interest
.. code-block:: sh
scolv --debug
#. Relocate the event for generating a new origin.
#. Compute magnitudes selecting the magnitude of interest.
#. Inspect the computed magnitudes in the
:ref:`Magnitude tab of scolv <scolv-sec-magnitude-tab>` or read the
debug output listing the considered magnitudes and stations along with
the regionalized parameters.
.. _tutorials_amplitude-aliases:
Amplitude Aliases
=================
Amplitude aliases are new amplitude types based original ones. Such aliases
allow their specific configuration and computation. They can be created and
independent of magnitudes by :ref:`scautopick` and :ref:`scamp` and used for
:ref:`magnitude aliases <tutorials_magnitude-aliases>`.
.. note::
Amplitude aliases make use of the same parameter structure as the initial
amplitude but the parameters must be configured independently.
Setup
-----
#. Global module configuration: Define the alias name in :confval:`amplitudes.aliases`.
Format and example:
.. code-block:: properties
amplitudes.aliases = alias:original amplitude type
amplitudes.aliases = MLc01:MLc
#. Configure the amplitude bindings parameters. The parameters are identical to
those of the original amplitude type except that the name of the original
magnitude must be replaced by the name of the alias. You may thus first
configure the original amplitude and then replace the name.
**Example binding configuration** for MLc01 derived from MLc:
.. code-block:: properties
amplitudes.MLc01.preFilter = BW(3,0.5,12)
amplitudes.MLc01.applyWoodAnderson = true
...
amplitudes.MLc01.enable = true
amplitudes.MLc01.enableResponses = false
amplitudes.MLc01.minSNR = 1.5
amplitudes.MLc01.signalBegin = -1
amplitudes.MLc01.signalEnd = min(tt(S) + 10, 150)
...
amplitudes.MLc01.maxDepth = 50
Repeat the action for all applicable binding profiles.
Instead of adjusting the bindings profiles you may add the configuration to
global or any other module configuration by prepending
*module.trunk.[module]* where *[module]* is to be replaced by the name of the
module including *global*.
**Example global module configuration** in :file:`global.cfg`:
.. code-block:: properties
module.trunk.global.amplitudes.MLc01.preFilter = BW(3,0.5,12)
module.trunk.global.amplitudes.MLc01.applyWoodAnderson = true
...
module.trunk.global.amplitudes.MLc01.enable = true
module.trunk.global.amplitudes.MLc01.enableResponses = false
module.trunk.global.amplitudes.MLc01.minSNR = 1.5
module.trunk.global.amplitudes.MLc01.signalBegin = -1
module.trunk.global.amplitudes.MLc01.signalEnd = min(tt(S) + 10, 150)
...
module.trunk.global.amplitudes.MLc01.maxDepth = 50
Configuration of bindings profiles has the advantage that the parameters are
available on any client connected to the messaging including external
SeisComP systems. Writing to global module configuration may be more simple
than maintaining multiple bindings profiles but the configuration is not
available to clients in external computers/SeisComP systems.
Application
-----------
* For automatic measurement by :ref:`scautopick` or :ref:`scamp` add the alias
name to the list of measured amplitudes in the corresponding module
configuration.
* For using the measured amplitude value with magnitudes, create a
:ref:`magnitude alias <tutorials_magnitude-aliases>`.
Testing
-------
Compute amplitudes with :ref:`scamp` or by magnitude aliases in :ref:`scolv` and
read the debug log output as when testing
:ref:`magnitude aliases <tutorials_mags_aliases_testing>`.
.. _tutorials_magnitude-aliases:
Magnitude Aliases
=================
Magnitude aliases are new magnitude types based original ones. Such aliases
allow their specific configuration and computation. They can be created from
magnitude and amplitude types native in |scname| or from
:ref:`amplitude aliases <tutorials_amplitude-aliases>` which must be defined
first. Unless specified explicitly, the amplitude type
is the base amplitude of the original magnitude.
Other amplitude types or amplitude aliases must be defined first and given
explicitly.
.. note::
Magnitude aliases make use of the same parameter structure as the initial
magnitude but the parameters must be configured independently.
Setup
-----
#. Create a magnitude alias in :file:`global.cfg` by configuring
:confval:`magnitudes.aliases`.
Format:
.. code-block:: properties
magnitudes.aliases = alias:original magnitude type[:amplitude type]
The amplitude type is optional and can be omitted when equal to the type of
the original magnitude.
Example for an alias magnitude, MLc1, derived from the MLc magnitude and
amplitude. Since initial amplitudes and magnitudes are identical, the
amplitude type can be dropped:
.. code-block:: properties
magnitudes.aliases = MLc01:MLc:MLc
magnitudes.aliases = MLc01:MLc
Example for an alias magnitude, MLc1, derived from the MLc magnitude and
amplitude. Since initial amplitudes and magnitudes are different, the
amplitude type must be given and
:ref:`configured independently <tutorials_amplitude-aliases>`
.. code-block:: properties
magnitudes.aliases = MLc01:MLc:MLc01
#. Configure the alias amplitude if any is used.
#. Configure the alias magnitude in **either** way:
* **Adjust binding profiles:** Configure global bindings parameters by
directly adjusting binding profiles.
Parameters of original magnitudes which are supported by magnitude-type
profiles can be set for the magnitude alias in :ref:`scconfig` by creating
a new magnitude-type profile having the name of the magnitude alias.
All other parameters must be written to the binding parameter files using
an external text editor:
#. Read the relevant parameter names of the original magnitude from global
binding, e.g., in :ref:`scconfig` or the binding parameter file.
Parameter names must include the full hierarchy including all sections.
Example for parameter name of original magnitude:
.. code-block:: properties
magnitudes.MLc.parametric.c1
#. Edit all relevant binding parameter files, e.g.,
:file:`seiscomp/etc/key/global/profile_HHZ` in a text editor and set the
values for the alias magnitude. For default values, the parameters do not
need to be set.
Example of resulting parameter for alias magnitude MLc01:
.. code-block:: properties
magnitudes.MLc01.parametric.c1 = 0.6
* **Regionalization:** Set up by :ref:`regionalization <tutorials_magnitude-region>`.
* Consider the tutorial above on
:ref:`magnitude regionalization <tutorials_magnitude-region>`.
* For the name of new magnitude-type profiles now use the new alias name.
.. hint::
When initially configuring amplitude and magnitude aliases, :ref:`scconfig`
does not know which original amplitude and magnitude types are considered and
the corresponding parameters may not be accessible.
The full list of parameters of the alias can, however, be derived from
original types:
#. Open scconfig and configure the original amplitude and magnitude
referenced by the alias.
#. Close scconfig.
#. Open the binding or module configuration file, e.g.,
:file:`seiscomp/etc/key/global/profile_HHZ` or :file:`global.cfg`.
#. Copy or rename the name of the referenced amplitude or magnitude in the
parameters to the name of the alias.
#. Open scconfig. The new parameters are now visible along with the
original one and can be adjusted. You may now remove all
irrelevant parameters of the original magnitude.
This procedure applies to the adjustment of binding profiles and to
regionalization except that regionalization only supports magnitudes.
* **Write bindings parameters to global module configuration:** Manually
adjust the module configuration file, e.g., :file:`global.cfg`. The
operation is not supported by :ref:`scconfig`.
#. Read the relevant parameter names of the original magnitude from global
binding, e.g., in :ref:`scconfig`. The names must include the full
hierarchy including all sections. Example:
.. code-block:: properties
magnitudes.MLc01.parametric.c1
#. Open the module configuration file, e.g.,
:file:`seiscomp/etc/global.cfg` in a text editor.
#. Prepend *module.trunk.global.* to the parameter name and add it along with
its value to the configuration file for all networks and stations.
Example:
.. code-block:: properties
module.trunk.global.magnitudes.MLc01.parametric.c1 = 0.7
For a given network or network and station replace *global* by the
*network* or the *network* and the *station* code. Example for network
CX and station PB01:
.. code-block:: properties
module.trunk.CX.PB01.magnitudes.MLc01.parametric.c1 = 0.7
module.trunk.CX.magnitudes.MLc01.parametric.c1 = 0.7
#. Add the new magnitude name to the configuration of all relevant modules,
e.g., :ref:`scamp`, :ref:`scmag`, :ref:`scevent`, :ref:`scolv`.
.. note::
The parameters starting with *module.trunk.* are not available for
configuration in :ref:`scconfig`.
.. warning::
Binding parameters configured in global module configuration should only
be considered exceptionally. These parameters will
* Override the corresponding parameters configured by regionalization
using the region *world*.
* Not be written to the database and cannot be accessed by SeisComP
modules running on other computers.
Application
-----------
* For automatic computation by :ref:`scmag` add the alias name to the list of
measured magnitudes in the corresponding module configuration.
* For interactive computation choose the magnitude alias name in :ref:`scolv`
when computing magnitudes. The alias may be added to the default magnitudes in
the scolv module configuration.
.. _tutorials_mags_aliases_testing:
Testing
-------
#. Start :ref:`scolv` with the option :option:`--debug` and load an event of
interest
.. code-block:: sh
scolv --debug
#. Relocate the event for generating a new origin.
#. Compute magnitudes selecting the magnitude of interest including the new
alias.
#. Inspect the computed magnitudes in the
:ref:`Magnitude tab of scolv <scolv-sec-magnitude-tab>` or read the
debug output listing the considered magnitude names and aliases along with
the considered parameters and their values. Example where MLc1 is derived
from MLc with a modified maximum depth:
.. code-block:: sh
...
13:30:46 [debug] GE.UGM: MLc1: effective correction (no locale) = 1.00:0.00
13:30:46 [debug] Parameters for magnitude MLc1
13:30:46 [debug] + maximum depth: 50.000 km
13:30:46 [debug] + distance mode: hypocentral
13:30:46 [debug] + minimum distance: -1.000 km
13:30:46 [debug] + maximum distance: 889.561 km
...
.. _tutorials_mags_moment:
Moment Magnitudes
=================
All magnitudes, Mx, can be mapped to a moment magnitude, Mw(Mx) by piecewise
linear interpolation.
.. warning::
Do not map :term:`mB <magnitude, broadband body-wave (mB)>`
or :term:`Mwp <magnitude, broadband P-wave moment (Mwp)>` to Mw since
this is hardcoded already and done automatically by :ref:`scmag`.
Setup
-----
The configuration procedure is:
#. Set up a magnitude-type profile for the original magnitude type in global
module configuration. Use :ref:`scconfig` for creating the profile.
#. Configure the parameter *MwMapping*, which will become available along with
the new profile, e.g., :confval:`magnitudes.MLc.MwMapping`. Alternatively,
add the parameter to :file:`seiscomp/etc/global.cfg`. The parameter is
configured as a list of sample points of a piecewise linear function mapping
from the original magnitude, Mx, to Mw(Mx).
Example for Mw(MLc) based on MLc:
.. code-block:: properties
magnitudes.MLc.MwMapping = MLc_0:Mw(MLc)_0,MLc_1:Mw(MLc)_1,...,MLc_N:Mw(MLc)_N
Any magnitude value outside the configured range is ignored.
The new moment magnitudes will be available along with the original magnitudes
and can be viewed in :ref:`scolv` or :ref:`scesv` and considered by :ref:`scmag`
or :ref:`scevent`.
In order to avoid that :ref:`summary magnitudes <concepts-magnitudes-summary>`
are computed from original magnitudes and mapped Mw together and biased to both,
the original magnitudes can be blocklisted in :ref:`scmag`
(:confval:`summaryMagnitude.blacklist`).
Application
-----------
* Mapped Mw() magnitudes are automatically computed when configured.
* For consideration in summary magnitudes configure and run :ref:`scmag`.
* For consideration in preferred magnitudes configure and run :ref:`scevent` or
select in :ref:`scolv`.
* For interactive computation choose the original magnitude name in :ref:`scolv`
when computing magnitudes.

226
share/doc/seiscomp/html/_sources/base/tutorials/archiving.rst.txt
View File

@ -1,13 +1,14 @@
.. _tutorials_archiving:
*******************************
Set up local waveform archiving
*******************************
**************************
Maintain waveform archives
**************************
You will ...
* Set up :ref:`slarchive` with its necessary bindings
* Set up `purge_datafiles` in crontab
* Control the life-time of waveforms
* Access waveforms
Pre-requisites for this tutorial:
@ -21,11 +22,12 @@ Pre-requisites for this tutorial:
Afterwards/Results/Outcomes:
* Save real-time data in a local archive for later processing.
* See :term:`miniSEED` day files for GE stations in your local :ref:`waveform archive <concepts_waveformarchives>`.
* See :term:`miniSEED` day files for GE stations in your local
:ref:`waveform archive <concepts_waveformarchives>`.
Time range estimate:
* 5 minutes
* 20 minutes
Related tutorial(s):
@ -34,23 +36,40 @@ Related tutorial(s):
----------
**Motivation**:
Without activating archiving, your local Seedlink server
will only keep waveforms for a short time.
Motivation
==========
Without activating waveform archiving, your local :ref:`Seedlink server <seedlink>`
will only keep waveforms for a short period of time.
This makes it hard to review old events, for example.
:ref:`slarchive` is therefore set up and used for archiving real-time waveforms
from a seedlink server.
In this example, we'll arrange for keeping waveforms for one week.
Before starting, you'll need bindings for your stations;
see the tutorials :ref:`tutorials_geofon_waveforms`
or :ref:`tutorials_waveforms`.
The :program:`slarchive` collects data and archives it
locally using a :term:`SDS` file system structure of
nested subdirectories and systematically named files.
Before starting, you'll need ensure to have access to readl-time data from a
:ref:`seedlink` server. To make seedlink bindings for your stations see the
tutorials :ref:`tutorials_geofon_waveforms` or :ref:`tutorials_waveforms`.
Background
==========
:ref:`slarchive` collects data and archives it locally in the directory defined
by :confval:`archive` using a :term:`SDS` file
system structure of nested subdirectories and systematically named files. For
working with the archived data, read the section on
:ref:`tutorials_archiving-access`.
Setup
=====
:ref:`slarchive` requires a module configuration and bindings.
You may configure slarchive using :ref:`scconfig` or by command-line actions.
In scconfig
===========
-----------
#. Under the Modules tab, go to Acquisition, and select :program:`slarchive`.
Here you can see the default parameters used.
@ -71,11 +90,15 @@ In scconfig
should apply to, under "Networks" on the left-hand side of the
bindings tool.
.. warning:: The name 'week' is just a label.
.. warning::
The name 'week' is just a label.
Its functionality comes from changing the value of the `keep` parameter.
Changing the *name* of a binding profile does not change its function.
.. note:: You can also choose which channels should be archived,
.. note::
You can also choose which channels should be archived,
using the ":confval:`selectors`" box.
For instance, you may collect data at several sample rates,
and only wish to archive the highest rate.
@ -93,17 +116,21 @@ In scconfig
Command line
============
------------
You will need to edit each of your top-level key files to refer to
a new binding profile.
e.g.::
e.g.
.. code-block:: sh
$ cd ~/seiscomp/etc/key
$ vi station_GR_CLL
Add the line `slarchive:week` to whatever lines are already there.
Afterwards it will look something like this::
Afterwards it will look something like this
.. code-block:: properties
# Binding references
global:BH
@ -114,7 +141,9 @@ Afterwards it will look something like this::
Repeat this for the top-level key file of each station
you wish this binding to apply to.
Now create the binding profile in the key directory.
This is a file with a name corresponding to the binding profile name; here: 'week' ::
This is a file with a name corresponding to the binding profile name; here: 'week'
.. code-block:: sh
$ cd ~/seiscomp/etc/key
$ mkdir slarchive
@ -129,66 +158,131 @@ This is a file with a name corresponding to the binding profile name; here: 'wee
slarchive is not running
starting slarchive
.. note::
Left unattended, your disk will eventually fill up with archived data.
To prevent this you will need a script like `purge_database`,
which is provided with SeisComP.
This can be run once per day using the `cron` feature of your system.
The command::
Data life cycle
---------------
$ seiscomp print crontab
Left unattended, your disk will eventually fill up with archived data since
:ref:`slarchive` itself does not delete any data.
will print a number of lines to the terminal.
Type `crontab -e` and insert these lines into the crontab file for your
user (typically `sysop`).
Exit your crontab editor.
Displaying your crontab should now show a line for `purge_database`.::
$ crontab -l
20 3 * * * /home/sysop/seiscomp/var/lib/slarchive/purge_datafiles >/dev/null 2>&1
[There may be other lines too.]
Deleting files
~~~~~~~~~~~~~~
This shows you that the `purge_datafiles` script
will run every day at 3:20 a.m.
To prevent your file system from filling up you may delete data using a script
like `purge_database`, provided with |scname|. The script considers duration set
by the *keep* parameter in slarchive bindings for defining the number of days to
keep the data in your archive.
The script can be run once per day using the `cron` feature of your system.
The command
.. code-block:: sh
$ seiscomp print crontab
will print a number of lines with suggested actions to the terminal. Type
`crontab -e` and insert these lines into the crontab file for your user (typically `sysop`).
Exit your crontab editor.
Displaying your crontab should now show a line for `purge_database`.
.. code-block:: sh
$ crontab -l
20 3 * * * /home/sysop/seiscomp/var/lib/slarchive/purge_datafiles >/dev/null 2>&1
[There may be other lines too.]
This shows you that the `purge_datafiles` script will run every day at 3:20 a.m.
.. note::
If you examine the `purge_datafiles` script, you will see that all it does
is look for files with a last modified time older than a certain number
of days ago.
The number of days to keep can be set station-by-station using the
ARCH_KEEP feature.
A convenient way to do this for many stations is with
multiple binding profiles, one for each length of time desired.
If you examine the `purge_datafiles` script, you will see that all it does
is looking for files with a last modified time older than a certain number
of days ago.
The number of days to keep can be set station-by-station using the
ARCH_KEEP feature.
A convenient way to do this for many stations is with
multiple slarchive binding profiles, one for each length of time desired.
Checking archiving is functioning
=================================
Extending disk space
~~~~~~~~~~~~~~~~~~~~
* If :program:`seedlink` is configured correctly, a new station's streams
appears in output from :program:`slinktool`::
In case your file system fills up with data and you do not wish to delete
old ones, you may add an additional harddisk and configure :confval:`archive`
of :program:`slarchive` to store the new data there. Thereafter you may
configure the *combined* or the *sdsarchive* :ref:`global_recordstream` to read
the data from both sources.
$ slinktool -Q : | grep CLL
GR CLL HHZ D 2020/04/01 01:11:57.6649 - 2020/04/01 07:28:49.0299
GR CLL HHE D 2020/04/01 01:11:57.6649 - 2020/04/01 07:28:45.0299
GR CLL HHN D 2020/04/01 01:11:57.6649 - 2020/04/01 07:28:39.2299
Verification
------------
* If :ref:`seedlink` is configured correctly, a new station's streams
appear in output from :ref:`slinktool`
.. code-block:: sh
$ slinktool -Q : | grep CLL
GR CLL HHZ D 2020/04/01 01:11:57.6649 - 2020/04/01 07:28:49.0299
GR CLL HHE D 2020/04/01 01:11:57.6649 - 2020/04/01 07:28:45.0299
GR CLL HHN D 2020/04/01 01:11:57.6649 - 2020/04/01 07:28:39.2299
This shows three streams being acquired from station 'CLL'.
The second time shown is the time of the most recent data for each stream.
* If :program:`slarchive` is configured correctly, waveform data for the
* If :ref:`slarchive` is configured correctly, waveform data for the
station appears in :program:`slarchive`'s SDS archive directory:
.. code-block:: sh
.. code-block:: sh
$ ls -l seiscomp/var/lib/archive/2020/GR/CLL
total 12
drwxr-xr-x 2 user user 4096 Apr 1 06:30 HHE.D
drwxr-xr-x 2 user user 4096 Apr 1 06:30 HHN.D
drwxr-xr-x 2 user user 4096 Apr 1 06:30 HHZ.D
$ ls -l seiscomp/var/lib/archive/2020/GR/CLL
total 12
drwxr-xr-x 2 user user 4096 Apr 1 06:30 HHE.D
drwxr-xr-x 2 user user 4096 Apr 1 06:30 HHN.D
drwxr-xr-x 2 user user 4096 Apr 1 06:30 HHZ.D
$ ls -l seiscomp/var/lib/archive/2020/GR/CLL/HHZ.D/
total 12728
-rw-r--r-- 1 user user 5492224 Mar 31 00:04 GR.CLL..BHZ.D.2020.090
-rw-r--r-- 1 user user 7531008 Apr 1 00:03 GR.CLL..BHZ.D.2020.091
$ ls -l seiscomp/var/lib/archive/2020/GR/CLL/HHZ.D/
total 12728
-rw-r--r-- 1 user user 5492224 Mar 31 00:04 GR.CLL..BHZ.D.2020.090
-rw-r--r-- 1 user user 7531008 Apr 1 00:03 GR.CLL..BHZ.D.2020.091
You may read these data files directly using :ref:`scrttv`, e.g.:
.. code-block:: sh
$ scrttv seiscomp/var/lib/archive/2020/GR/CLL/HHZ.D/*
.. _tutorials_archiving-access:
Access to Archived Data
=======================
Archived waveforms can be read or provided in multiple ways depending on the
application.
* Offline reading with :ref:`scrttv`: Read miniSEED files directly using
:ref:`scrttv`, e.g.:
.. code-block:: sh
$ scrttv seiscomp/var/lib/archive/2020/GR/CLL/HHZ.D/*
* Automatically for data processing: |scname| modules such as
:ref:`scautopick` or :ref:`scolv` can read data from SDS
archive with the *sdsarchive* :ref:`global_recordstream` when running on the
same computer.
* External clients: You may provide the data to clients on other
computers using :ref:`scwfas` or :ref:`fdsnws` both providing data via
:cite:t:`fdsn`.
* Direct file access: For directly fetching :term:`miniSEED` waveform data from
archive you may use :ref:`scart` or Linux commands. You may combine scart
with other modules avoiding redundant file storage. Examples:
.. code-block:: sh
$ scart -dEsv -t 2025-02-01T01:00~2025-02-01T01:00 /archive | scrttv -
$ scart -dEsv -t 2025-02-01T01:00~2025-02-01T01:00 /archive | scautopick -I - -d localhost --ep --playback

15
share/doc/seiscomp/html/_sources/base/tutorials/geofon_waveforms.rst.txt
View File

@ -52,13 +52,13 @@ Check data are available
========================
First, we'll query the upstream Seedlink server, which runs on
host `geofon.gfz-potsdam.de` at port 18000.
host *geofon.gfz.de* at port *18000*.
We do this with SeisComP's :ref:`slinktool` command, giving the ``-L`` option
to :ref:`slinktool`
.. code-block:: sh
$ slinktool -L geofon.gfz-potsdam.de
$ slinktool -L geofon.gfz.de
6C GF01 GF01
6C GF02 GF02
6C GF03 GF03
@ -76,7 +76,7 @@ code GE
.. code-block:: sh
$ slinktool -Q geofon.gfz-potsdam.de | grep ^GE.*BHZ
$ slinktool -Q geofon.gfz.de | grep ^GE.*BHZ
GE ACRG BHZ D 2019/11/28 06:51:48.7500 - 2019/11/28 09:18:32.1000
GE APE BHZ D 2019/11/28 07:40:52.0400 - 2019/11/28 12:22:00.3950
GE ARPR BHZ D 2019/11/27 23:23:27.4400 - 2019/11/28 09:41:22.1500
@ -130,7 +130,7 @@ StationXML format.
.. code-block:: sh
$ wget "http://geofon.gfz-potsdam.de/fdsnws/station/1/query?net=GE&level=response" -O ge.xml
$ wget "http://geofon.gfz.de/fdsnws/station/1/query?net=GE&level=response" -O ge.xml
Option 2: Using WebDC3
@ -144,7 +144,7 @@ from different data centres among other possibilities.
You can find detailed information about WebDC3 in the on-line documentation at
:cite:t:`webdc3-documentation`.
* Go to http://eida.gfz-potsdam.de/webdc3 with a browser.
* Go to http://eida.gfz.de/webdc3 with a browser.
* Click on "Explore stations" and move the slider to select only the current year
and only "Public permanent nets" on the Network type list.
@ -335,10 +335,9 @@ References
.. target-notes::
.. [#WebDC] The WebDC3 service is available at http://eida.gfz-potsdam.de.
See also
.. [#WebDC] The WebDC3 service is available at http://eida.gfz.de. See also
M. Bianchi, *et al.* (2015): WebDC3 Web Interface. GFZ Data Services.
doi:`10.5880/GFZ.2.4/2016.001 <http://dx.doi.org/10.5880/GFZ.2.4/2016.001>`_
.. [#NETPAGES] For instance that of the GEOFON Program, at
https://geofon.gfz-potsdam.de/waveform/archive/network.php?ncode=GE.
https://geofon.gfz.de/waveform/archive/network.php?ncode=GE.

278
share/doc/seiscomp/html/_sources/base/tutorials/magnitude-regionalization.rst.txt
View File

@ -1,278 +0,0 @@
.. _tutorials_magnitude-region-aliases:
****************************************
Magnitudes: Regionalization, Aliases, Mw
****************************************
You will ...
* Regionalize magnitude
* Create new magnitude types as aliases from other magnitudes and amplitudes.
* Map magnitudes to the moment magnitude, Mw
:Pre-requisites for this tutorial:
* Read the :ref:`concepts section on magnitudes <concepts_magnitudes>`.
* Real-time data for the station must be available locally.
See :ref:`tutorials_waveforms` or :ref:`tutorials_geofon_waveforms`.
* Inventory must be loaded locally.
:Afterwards/Results/Outcomes:
* Regionalized magnitudes,
* New magnitude types as aliases.
* Moment magnitudes
:Time range estimate:
* 30 minutes
-----------
.. _tutorials_magnitude-region:
Regionalize Magnitudes
======================
By regionalization, magnitudes can be computed with region-dependent properties.
The procedure to set up magnitude regionalization is:
#. Create one file which contains the polygons surrounding the regions within
which magnitude parameters shall apply. The polygon files are provided in
:ref:`BNA <sec-gui_layers-vector-format-bna>` or
:ref:`GeoJSON format <sec-gui_layers-vector-format-geojson>` and located as
set out in the :ref:`documentation of map layers <sec-gui_layers>`. The file
can be created from any |scname| GUI application providing maps, e.g.,
:ref:`scmv`.
#. For the desired magnitude type create a magnitude-type profile in global
module configuration. The name of the profile matches the name of the
magnitude, e.g., *MLc* for the :ref:`MLc magnitude <global_mlc>`.
#. Configure the :confval:`magnitudes.MLc.regionFile` parameter with the full
path and name of the polygon file created above.
#. Within the magnitude-type profile create one or more magnitude-region
profile(s) for defining the regionalized parameters applied to the region(s).
The name of a profile corresponds to the name of the polygon contained in the
polygon file to which the parameters shall apply. Use *world* for all regions
not covered by any polygon.
#. Configure the regionalized magnitude parameters of the magnitude-region
profile. Activate the *enable* parameter if you wish to apply this profile.
#. Restart the data processing:
.. code-block:: sh
seiscomp restart
or execute a GUI module.
.. important::
* Parameters which can be configured along with regionalization assume
defaults from global binding parameters but override global bindings
parameters when configured.
* Once regionalization is active, magnitudes for events outside the
defined region(s) will not be computed. For considering such events add
another magnitude-region profile with the name "*world*".
Magnitudes for events outside any other magnitude-region profile will then
be computed according to this profile.
Station corrections
-------------------
:ref:`Magnitude station corrections <concepts-magnitudes-correction>` can also
be applied in case of regionalization. Simply add the names of the
magnitude-region profile along with the correction parameter to the original
parameter in global module configuration, :file:`global.cfg`, for the respective
magnitude type and station. Use comma separation for multiple regions and colon
for separating the region name from the value.
Example for correcting MLv computed at station GE.UGM:
.. code-block:: properties
module.trunk.GE.UGM.magnitudes.MLv.offset = 0.1, europe:0.2, asia:-0.1
.. note::
The configuration of parameters starting with *module.trunk.* is not
supported by :ref:`scconfig`. All corresponding configurations must be done
by directly editing the configuration file, e.g.,
:file:`seiscomp/etc/global.cfg`.
.. _tutorials_magnitude-aliases:
Magnitude Aliases
=================
New magnitude types (aliases) can be created based on existing magnitude and
amplitude types but configured specifically.
The procedure to set up magnitude aliases is:
#. Create a magnitude alias in :file:`global.cfg` by configuring
:confval:`magnitudes.aliases`. Example:
.. code-block:: properties
magnitudes.aliases = MLc1:MLc:MLc
#. Configure the alias magnitudes in either way:
* Write bindings parameters to global module configuration or
* Set up :ref:`regionalization <tutorials_magnitude-region>`:
**Binding parameters in global module configuration:**
#. Read the relevant parameter names of the original magnitude from global
binding, e.g., in :ref:`scconfig`. The names must include the full
hierarchy including all sections. Example:
.. code-block:: properties
magnitudes.MLc01.parametric.c1
#. Open the module configuration file, e.g.,
:file:`seiscomp/etc/global.cfg` in a text editor.
#. Prepend *module.trunk.global.* to the parameter name and add it along with
its value to the configuration file. Example:
.. code-block:: properties
module.trunk.global.magnitudes.MLc01.parametric.c1 = 0.7
#. Add the new magnitude name to the configuration of all relevant modules,
e.g., :ref:`scamp`, :ref:`scmag`, :ref:`scevent`, :ref:`scolv`.
.. note::
The parameters starting with *module.trunk.* are not available for
configuration in :ref:`scconfig`.
.. warning::
Binding parameters configured in global module configuration should only
be considered exceptionally. These parameters will
* Override the corresponding parameters configured by regionalization
using the region *world*.
* Not be written to the database and cannot be accessed by SeisComP
modules running on other computers.
**Regionalization:**
* Consider the tutorial on
:ref:`magnitude regionalization <tutorials_magnitude-region>` above.
* For the name of the new magnitude-type profile now use the alias name.
.. hint::
When adding the magnitude-region profile in
:ref:`scconfig`, scconfig does not know about the referenced original
magnitude. Therefore, not all possible configuration parameters may be
listed depending on the magnitude, e.g. for MLc. For getting the full
list, first create and configure a magnitude-region profile for the
referenced magnitude.
#. Close scconfig
#. Open the configuration file :file:`global.cfg`
#. Rename the name of the referenced magnitude in the parameters to the
name of the alias.
.. _tutorials_mags_moment:
Moment Magnitudes
=================
All magnitudes, Mx, can be mapped to a moment magnitude, Mw(Mx).
The configuration procedure is:
#. Set up a magnitude-type profile for the original magnitude type in global
module configuration. Use :ref:`scconfig` for creating the profile.
#. Configure the parameter *MwMapping*, which will become available along with
the new profile, e.g., :confval:`magnitudes.MLc.MwMapping`. Alternatively,
add the parameter to :file:`seiscomp/etc/global.cfg`. The parameter is
configured as a list of sample points of a piecewise linear function mapping
from the original magnitude, Mx, to Mw(Mx).
Example for Mw(MLc) based on MLc:
.. code-block:: properties
magnitudes.MLc.MwMapping = MLc_0:Mw(MLc)_0,MLc_1:Mw(MLc)_1,...,MLc_N:Mw(MLc)_N
Any magnitude value outside the configured range is ignored.
.. warning::
Do not map the magnitudes :term:`mB <magnitude, broadband body-wave (mB)>`
and :term:`Mwp <magnitude, broadband P-wave moment (Mwp)>` to Mw since
this is hardcoded already and done automatically by :ref:`scmag`.
The new moment magnitudes will be available along with the original magnitudes
and can be viewed in :ref:`scolv`or :ref:`scesv` and considered by :ref:`scmag`
or :ref:`scevent`.
In order to avoid that :ref:`summary magnitudes <concepts-magnitudes-summary>`
are computed from original magnitudes and mapped Mw together and biased to both,
the original magnitudes can be blocklisted in :ref:`scmag`
(:confval:`summaryMagnitude.blacklist`).
.. _tutorials_mags_regionalize_testing:
Final Tests
===========
* Regionalization:
#. Start :ref:`scolv` with the option :option:`--debug` and load an event of
interest
.. code-block:: sh
scolv --debug
#. Relocate the event for generating a new origin.
#. Compute magnitudes selecting the magnitude of interest.
#. Inspect the computed magnitudes in the
:ref:`Magnitude tab of scolv <scolv-sec-magnitude-tab>` or read the
debug output listing the considered magnitudes and stations along with
the regionalized parameters.
* Magnitude aliases:
#. Start :ref:`scolv` with the option :option:`--debug` and load an event of
interest
.. code-block:: sh
scolv --debug
#. Relocate the event for generating a new origin.
#. Compute magnitudes selecting the magnitude of interest including the new
alias.
#. Inspect the computed magnitudes in the
:ref:`Magnitude tab of scolv <scolv-sec-magnitude-tab>` or read the
debug output listing the considered magnitude names and aliases along with
the considered parameters and their values. Example where MLc1 is derived
from MLc with a modified maximum depth:
.. code-block:: sh
...
13:30:46 [debug] GE.UGM: MLc1: effective correction (no locale) = 1.00:0.00
13:30:46 [debug] Parameters for magnitude MLc1
13:30:46 [debug] + maximum depth: 50.000 km
13:30:46 [debug] + distance mode: hypocentral
13:30:46 [debug] + minimum distance: -1.000 km
13:30:46 [debug] + maximum distance: 889.561 km
...

69
share/doc/seiscomp/html/_sources/base/tutorials/postinstall.rst.txt
View File

@ -6,11 +6,14 @@ Installation on Ubuntu
You will ...
* Make a basic |scname| installation
* Make a basic |scname| installation of SeisComP in version 4.0.0 on Ubuntu 20.04
* Make an initial configuration
* Perform function tests
Pre-requisites for this tutorial:
* Internet access
* :ref:`Documentation of installation <installation>`
Afterwards/Results/Outcomes:
@ -51,18 +54,20 @@ but the steps for other Ubuntu versions are similar.
$ sudo addgroup admin
$ sudo usermod -a -G admin,adm,audio sysop
.. note:
.. note::
Adding a new user is not mandatory. You can install under an existing user
directory. Creating a new user is recommended as it allows an easy cleanup
of the system later simply by removing the new user if needed.
#. Check the size and the architecture. This is espcially required when installing
:ref:`pre-compiled packages<tutorials_postinstall_package>`: ::
:ref:`pre-compiled packages<tutorials_postinstall_package>`:
$ df -h
$ cat /etc/issue
$ uname -m
.. code-block:: sh
$ df -h
$ cat /etc/issue
$ uname -m
Compare the available disk space with the requirements given in
the :ref:`installation` section.
@ -75,9 +80,10 @@ but the steps for other Ubuntu versions are similar.
Install from source code
========================
To compile SeisComP from the source code follow the
:ref:`instructions in the development section <build>`. You may later download and add
maps as described below in the :ref:`package section <tutorials_postinstall_package>`.
To compile |scname| from the source code follow the
:ref:`instructions in the development section <build>`. You may later download
and add maps as described below in the
:ref:`Documentation of installation <installation>`.
.. _tutorials_postinstall_package:
@ -85,7 +91,18 @@ maps as described below in the :ref:`package section <tutorials_postinstall_pack
Install pre-compiled release packages
=====================================
You may download and installed pre-compile SeisComP binary package, maps and documentation.
You may install the |scname| packages in either way:
* :ref:`gsm<installation-gsm>` (recommended) a package manager provided by
:cite:t:`gempa`,
* :ref:`manually by extracting packages <installation-manual>`.
Here we refer to the manual extraction of packages. More details are given
in section :ref:`installation`.
You may download and installed pre-compile |scname| binary package, maps and
documentation.
#. Download the appropriate |scname| binary package taking into
account your Linux distribution and the architecture.
@ -99,15 +116,16 @@ You may download and installed pre-compile SeisComP binary package, maps and doc
.. code-block:: sh
wget "https://www.seiscomp.de/downloader/seiscomp-maps.tar.gz"
$ wget "https://www.seiscomp.de/downloader/seiscomp-maps.tar.gz"
* the documentation package. Make sure, the documentation matches your
SeisComP version.
|scname| version.
.. note::
The |scname| packages received from gempa GmbH contain the documentation
for the respective version and no separate download is required.
The |scname| packages received from :cite:t:`gempa-download` contain the
documentation for the respective version and no separate download is
required.
#. Untar the :file:`seiscomp*` files (binary package, maps and documentation)
you will find in your home or downloads directory. For SeisComP in version
@ -180,7 +198,7 @@ You may download and installed pre-compile SeisComP binary package, maps and doc
For PostgreSQL, also see the detailed :ref:`installation` instructions.
.. warning ::
.. warning::
For Ubuntu 18.04 and newer, take care with MariaDB/MySQL installation.
Before the next step, you must set a root password *for MariaDB/MySQL*
@ -250,14 +268,14 @@ Find a detailed description in section :ref:`getting-started` and short guide be
.. hint::
If, when you attempt to run a SeisComP command such as :ref:`scconfig` or
If, when you attempt to run a |scname| command such as :ref:`scconfig` or
:ref:`scolv`, you receive an error message like
.. code-block:: sh
scconfig: command not found
then the most likely explanation is that you have not set your SeisComP
then the most likely explanation is that you have not set your |scname|
environment variables correctly.
Run the `seiscomp` command with the full path to
@ -278,7 +296,7 @@ Find a detailed description in section :ref:`getting-started` and short guide be
Datacenter ID. These are used for Arclink and Seedlink, and in the information
describing data model objects such as origins and events.
#. The `seiscomp` command is a wrapper, which controls the SeisComP modules.
#. The `seiscomp` command is a wrapper, which controls the |scname| modules.
See :ref:`system-management`.
Run something by typing seiscomp followed by a command
@ -296,15 +314,22 @@ Find a detailed description in section :ref:`getting-started` and short guide be
Use 'help [command]' to get more help about a command
#. Start :ref:`scmaster`.
#. Start and test :ref:`scmaster`.
As described in the :ref:`overview`, these are needed for
communication between the SeisComP database and the individual
SeisComP modules.
communication between the |scname| database and the individual
|scname| modules.
.. code-block:: sh
$ seiscomp start scmaster
starting scmaster
$ seiscomp status scmaster
In case errors are reported you should understand the full debug log:
.. code-block:: sh
$ scmaster --debug
#. Install all dependencies needed for the GUI
@ -333,7 +358,7 @@ Find a detailed description in section :ref:`getting-started` and short guide be
$ seiscomp exec scrttv
After seeing the SeisComP splash screen,
After seeing the |scname| splash screen,
you'll likely get an error message "Could not read inventory (NULL)".
After a new installation, that's okay.
Click that box away, and you'll see a screen with

4
share/doc/seiscomp/html/_sources/base/tutorials/servefdsnws.rst.txt
View File

@ -127,12 +127,12 @@ Check it Works
Further Information
===================
* The `URL Builder at GEOFON <https://geofon.gfz-potsdam.de/waveform/builder.php>`_
* The `URL Builder at GEOFON <https://geofon.gfz.de/waveform/builder.php>`_
lets you fill out a form to tailor your request.
The URL to use to make your request is displayed at the bottom of that page.
* More example requests are at the
`FDSNWS description at GEOFON <https://geofon.gfz-potsdam.de/waveform/webservices.php>`_
`FDSNWS description at GEOFON <https://geofon.gfz.de/waveform/webservices.php>`_
* The FDSN Web Services specification document :cite:p:`fdsn-specs` provides the
technical documentation and examples.

Some files were not shown because too many files have changed in this diff Show More