.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "SCFINDER" "1" "Nov 17, 2026" "vX.Y.Z" "ETHZ-SED EEW SeisComP contributions" .SH NAME scfinder \- ETHZ-SED EEW SeisComP contributions Documentation .sp \fBscfinder is a wrapper module for the Finite\-Fault Rupture Detector (FinDer) Earthquake Early Warning algorithm.\fP .SH DESCRIPTION .sp Part of the \fI\%EEW\fP package (used by \fI\%FinDer\fP). .sp \fIscfinder\fP is released under the GNU Affero General Public License (Free Software Foundation, version 3 or later). It uses the same library as \fI\%sceewenv\fP to compute acceleration envelope values provided as input for the \X'tty: link http://www.seismo.ethz.ch/en/knowledge/earthquake-data-and-analysis-tools/EEW/finite-fault-rupture-detector-finder/'\fI\%Finite\-Fault Rupture Detector\fP\X'tty: link' [1] API. .sp This module requires FinDer to be installed and SeisComP to be compiled from source. The FinDer software is distributed by the Swiss Seismological Service (SED) at ETH Zurich. Access to the source code is limited to users who have an established collaboration with the SED. In other cases, compiled binaries (in a docker image) may be provided instead. Please contact Dr. Maren Böse (SED) for requests and further information. .sp FinDer provides estimates of the rupture centroid, length and strike. These values are attached by \fIscfinder\fP within a derived object called \fIstrong motion origin\fP, which uses the strong motion database extension. In order to save the strong motion origins to the database and to provide them to other modules, the messaging system must be able to handle these messages. Therefore, the plugins \fIdmsm\fP must be available to scmaster\&. .sp The plugins can be most easily \fBadded\fP through the configuration parameters in \fBglobal.cfg\fP: .INDENT 0.0 .INDENT 3.5 .sp .EX plugins = dmsm .EE .UNINDENT .UNINDENT .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 Within \fI\%scfinder\fP, FinDer uses continuously updated envelope amplitudes from the same library than module \fI\%sceewenv\fP and the same pre\-processing. .UNINDENT .UNINDENT .SH SCEVENT CONFIGURATION .sp \fIscfinder\fP can produce an origin as soon as seismic waves have reached a minimum number of stations as configured in finder.config. \fI\%Finite\-Fault Rupture Detector\fP is not pick\-based; the phase number attached to its origin relates to the stations exceeding \fI\%Finite\-Fault Rupture Detector\fP ground motion acceleration threshold. For scevent to create an event from an origin with 4 phases requires the following setting: .INDENT 0.0 .INDENT 3.5 .sp .EX # Minimum number of Picks for an Origin that is automatic and cannot be # associated with an Event to be allowed to form a new Event. eventAssociation.minimumDefiningPhases = 4 .EE .UNINDENT .UNINDENT .sp Users interested in EEW may decide to run both FinDer and VS together. \fI\%scvsmag\fP uses the preferred origin for VS magnitude computation, and it should not run on a FinDer origin. In order to run \fIscfinder\fP and \fI\%scvsmag\fP on the same system, \fIscfinder\fP should be excluded from the list of potential preferred origins. This can be achieved by explicitely defining a method priority list that does not include the FinDer \fImethodID\fP in the configuration of scevent: .INDENT 0.0 .INDENT 3.5 .sp .EX # The method priority list. When the eventtool comes to the point to select a # preferred origin 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. eventAssociation.methods = \(dqNonLinLoc(L2)\(dq,\e \(dqNonLinLoc(EDT)\(dq,\e \(dqiLoc\(dq,\e \(dqHypo71\(dq,\e \(dqLOCSAT\(dq eventAssociation.priorities = AGENCY, STATUS, METHOD, PHASES_AUTOMATIC, TIME_AUTOMATIC .EE .UNINDENT .UNINDENT .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 Do not include the \(dqMVS\(dq nor \(dqMfd\(dq magnitude types within scevent list of preferred magnitude types (\fBeventAssociation.magTypes\fP), otherwise, the first origin with an \(dqMVS\(dq or \(dqMfd\(dq will remain preferred for automatic processing despite any newer origins. .UNINDENT .UNINDENT .IP [1] 5 \X'tty: link http://www.seismo.ethz.ch/en/knowledge/earthquake-data-and-analysis-tools/EEW/finite-fault-rupture-detector-finder/'\fI\%http://www.seismo.ethz.ch/en/knowledge/earthquake\-data\-and\-analysis\-tools/EEW/finite\-fault\-rupture\-detector\-finder/\fP\X'tty: link' .SH CONFIGURATION .nf \fBetc/defaults/global.cfg\fP \fBetc/defaults/scfinder.cfg\fP \fBetc/global.cfg\fP \fBetc/scfinder.cfg\fP \fB~/.seiscomp/global.cfg\fP \fB~/.seiscomp/scfinder.cfg\fP .fi .sp .sp scfinder inherits \X'tty: link https://docs.gempa.de/seiscomp/current/apps/global.html'\fI\%global options\fP\X'tty: link'\&. .INDENT 0.0 .TP .B saturationThreshold Type: \fIdouble\fP .sp Unit: \fIpercent\fP .sp Saturation threshold in percent of 2**23 of raw values (COUNTS). Default is \fB80\fP\&. .UNINDENT .INDENT 0.0 .TP .B baselineCorrectionBuffer Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Length of base line correction buffer. Default is \fB60\fP\&. .UNINDENT .INDENT 0.0 .TP .B horizontalBuffer Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Length of buffer for horizontal components. Because horizontal components are being received seperately they must be buffered to align them properly. This buffer size correlates to the maximum latency of one horiontal component with respect to the other. Default is \fB60\fP\&. .UNINDENT .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 \fBstreams.*\fP \fIDefines the white\- and blacklist of data streams to be used. The\fP \fIrules to decide if a stream is used or not are the following:\fP ** \fI1. if whitelist is not empty and the stream is not on the whitelist,\fP \fIdon\(aqt use it, ok otherwise\fP ** \fI2. if blacklist is not empty and the stream is on the blacklist,\fP \fIdon\(aqt use it, ok otherwise\fP ** \fIBoth checks are made and combined with AND. Either whitelist or\fP \fIblacklist contains a list of patterns (wildcard allowed as * and ?),\fP \fIeg GE.\fP\&.*.*, \fI, GE.MORC.\fP\&.BH? Each stream id (NET.STA.LOC.CHA) will* \fIbe checked against the defined patterns.\fP .UNINDENT .UNINDENT .INDENT 0.0 .TP .B streams.whitelist Type: \fIlist:string\fP .sp The stream whitelist .UNINDENT .INDENT 0.0 .TP .B streams.blacklist Type: \fIlist:string\fP .sp The stream blacklist .UNINDENT .INDENT 0.0 .TP .B vsfndr.envelopeInterval Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Interval of the envelope computation. The maximum is taken with that data interval and declared as envelope value. The intervals do not overlap. Default is \fB1.0\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.config Type: \fIpath\fP .sp Path to Finder config. .UNINDENT .INDENT 0.0 .TP .B finder.magnitudeGroup Type: \fIstring\fP .sp Messaging group to send magnitudes to. Default is \fBMAGNITUDE\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.strongMotionGroup Type: \fIstring\fP .sp Messaging group to send strong motion objects to. Default is \fBLOCATION\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.envelopeBufferSize Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Size of envelope buffer in seconds. This value should be set large enough for the longest anticipated rupture duration. The envelope buffer is a ring buffer and FinDer receives a maximum from it based on the time window defined by defaultFinDerEnvelopeLength. Default is \fB120\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.defaultFinDerEnvelopeLength Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Default window length (in seconds) of envelope buffer to search when passing maximum to FinDer. This default window length will be used when there are no active FinDer events, or the largest FinDer event rupture (in km) is less than the default time window (in seconds) * 1.5. Otherwise the window length (in seconds) is computed as maximum rupture length (in km) / 1.5, up to the maximum size of the envelope buffer as defined by envelopeBufferSize. A smaller value will reduce false detections caused by noise, but the value should be large enough to account for station spacing and the number of trigger stations used by FinDer. Default is \fB60\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.scanInterval Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Defines the interval to scan amplitudes by Finder. If set to 0 then the scan is called as soon as an amplitude change has been detected. This can cause a high CPU usage. Default is \fB1\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.processInterval Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Defines the interval to process Finder objects. If set to 0 then Finder is called as soon as data has been scanned. This can cause a high CPU usage. Default is \fB1\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.maxEnvelopeBufferDelay Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Sets the maximum delay for the latest update of each envelope buffer before skipping the related station stream in FinDer PGA input data. The default is 15s. Default is \fB15\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.clipTimeout Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Defines the delay following a clipped record that a stream is not used in FinDer. Default is 30s. Default is \fB30\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.preferredGainUnits Type: \fIstring\fP .sp Defines the preferred data gain units in case envelopes are provided by several different instruments from the same location code. Default is \(dqM/S**2\(dq. Set \(dq\(dq (empty) to disable prevailing. Default is \fBM/S**2\fP\&. .UNINDENT .INDENT 0.0 .TP .B finder.regionFile Type: \fIstring\fP .sp Set the full file path to the BNA file that contains the region(s) used for filtering finder solutions. Geographic filtering requires both \(dqregionFile\(dq and \(dqregionNames\(dq to be defined and valid. .UNINDENT .INDENT 0.0 .TP .B finder.regionNames Type: \fIstring\fP .sp Defines the name(s) of the region(s), as a comma\-separated list, within which finder solutions should be filtered. Geographic filtering requires both \(dqregionFile\(dq and \(dqregionNames\(dq to be defined and valid. .UNINDENT .INDENT 0.0 .TP .B debug.maxDelay Type: \fIdouble\fP .sp Unit: \fIs\fP .sp Sets the maximum absolute value of packet delay before issuing a warning. That parameter does not configure buffers as such but only a threshold (in seconds with fractional part) to warn the user that something is not real\-time anymore. The default is 3s. Default is \fB3\fP\&. .UNINDENT .INDENT 0.0 .TP .B debug.filterCornerFreq Type: \fIdouble\fP .sp Unit: \fIHz\fP .sp Sets the corner frequency of the Butterworth (4 poles) high\-pass filter, default is 1/3 Hz. Default is \fB1/3\fP\&. .UNINDENT .SH COMMAND LINE .SS Generic .INDENT 0.0 .TP .B \-x, \-\-expiry time Time span in hours after which objects expire. .UNINDENT .INDENT 0.0 .TP .B \-O, \-\-origin\-id publicID OriginID to calculate amplitudes for and exit. .UNINDENT .INDENT 0.0 .TP .B \-\-dump\-records Dumps the filtered traces to ASCII when using \-O. .UNINDENT .SS Verbosity .SS Messaging .INDENT 0.0 .TP .B \-\-test Test mode where no messages are sent. .UNINDENT .SS Database .SS Records .SS Offline .INDENT 0.0 .TP .B \-\-offline Do not connect to the messaging. This mode requires either an explicit database connection to read the inventory from or an inventory XML file. This option implies \-\-test. .UNINDENT .INDENT 0.0 .TP .B \-\-dump\-config Show configuration in debug log and stdcerr and exit. .UNINDENT .INDENT 0.0 .TP .B \-\-ts Start time of data acquisition time window, requires also \-\-te .UNINDENT .INDENT 0.0 .TP .B \-\-te End time of data acquisition time window, requires also \-\-ts .UNINDENT .INDENT 0.0 .TP .B \-\-calculate\-mask Calculate FinDer mask according to scfinder configuration (i.e., FinDer \(dqMASK_STATION_DISTANCE\(dq, FinDer template resolution \(dqD_KM\(dq as well as scfinder \(dqstreams.whitelist\(dq and \(dqstreams.blacklist\(dq), output in specified path, and exit. .UNINDENT .SH AUTHOR Swiss Seismological Service .SH COPYRIGHT 2020, SED .\" Generated by docutils manpage writer. .