.\" 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 "SCEEWLOG" "1" "Nov 17, 2026" "vX.Y.Z" "ETHZ-SED EEW SeisComP contributions" .SH NAME sceewlog \- ETHZ-SED EEW SeisComP contributions Documentation .sp \fBLogs EEW magnitude messages via file, email, ActiveMQ and FCM.\fP .SH DESCRIPTION .sp Part of the \fI\%EEW\fP package (used by \fI\%VS\fP and \fI\%FinDer\fP). .sp \fIsceewlog\fP logs the VS and FinDer magnitude messages received from \fI\%scvsmag\fP and \fI\%scfinder\fP (configurable), broadcasts these alerts, and triggers scripts, generates and disseminates reports. .sp \fIsceewlog\fP is released under the GNU Affero General Public License (Free Software Foundation, version 3 or later). It requires the Python 3 and the package \X'tty: link https://pypi.python.org/pypi/python-dateutil/'\fI\%dateutil\fP\X'tty: link' [2] to be installed. sceewlog replaces scvslog that was originally part of the SeisComP implementation of the \X'tty: link http://www.seismo.ethz.ch/en/knowledge/earthquake-data-and-analysis-tools/EEW/Virtual-Seismologist/index.html'\fI\%Virtual Seismologist\fP\X'tty: link' [1] (VS) Earthquake Early Warning algorithm. .sp Once an event has timed out, the modules generates report files. These report files are saved to disk and can also be sent via email. .sp It also implements \X'tty: link http://activemq.apache.org/'\fI\%ActiveMQ\fP\X'tty: link' [3] and \X'tty: link https://firebase.google.com/docs/cloud-messaging'\fI\%Firebase Cloud Messaging\fP\X'tty: link' [8] interfaces which can send alert messages in real\-time. It supports regionalized filter profiles (based on polygons and EQ parameter threshold values). Currently, messages can be sent in four different formats (\fIsc3ml\fP, \fIqml1.2\-rt\fP, \fIshakealertml\fP the UserDisplay format, \fICAP1.2\fP). Optionally, a comment with ID \fBEEW\fP storing the EEW update number, can be added to each magnitude that passes all configured filters and scoring. .sp The SED\-ETHZ team provides a client that can display \fIqml1.2\-rt\fP messages sent via ActiveMQ, the \X'tty: link http://www.seismo.ethz.ch/en/knowledge/earthquake-data-and-analysis-tools/EEW/earthquake-early-warning-display-eewd/'\fI\%Earthquake Early Warning Display (EEWD)\fP\X'tty: link' [4] an OpenSource user interface developed within the European REAKT project and based on early versions of the ShakeAlert \X'tty: link http://www.eew.caltech.edu/research/userdisplay.html'\fI\%UserDisplay\fP\X'tty: link' [5]\&. .sp To receive alerts with the EEWD set the format to \fIqml1.2\-rt\fP\&. There are currently no clients which can digest \fIsc3ml\fP and the \fIshakealertml\fP is not supported. Using pipelines alerts can be sent out in more than one format. .sp The real\-time ActiveMQ interface requires the Python packages \X'tty: link https://pypi.python.org/pypi/stompy/'\fI\%stompy\fP\X'tty: link' [6] and \X'tty: link http://lxml.de/'\fI\%lxml\fP\X'tty: link' [7] to be installed. .sp It is beyond the scope of this documentation to explain the complete setup of an ActiveMQ broker. However, since sceewlog uses the STOMP protocol to send messages to the broker it is essential to add the following line to configuration of the ActiveMQ broker. .INDENT 0.0 .INDENT 3.5 .sp .EX .EE .UNINDENT .UNINDENT .sp Please refer to \X'tty: link http://activemq.apache.org/'\fI\%ActiveMQ\fP\X'tty: link' [3] for setting up an ActiveMQ broker. .SH REPORTS .sp Below is an example of the first few lines of a report file: .INDENT 0.0 .INDENT 3.5 .sp .EX |#St. | Tdiff |Type|Mag.|Lat. |Lon. |Depth |origin time (UTC) |Lik.|Or.|Ma.|Str.|Len. |Author |Creation t. |Tdiff(current o.) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 5.24| MVS|2.40| 46.05| 6.89| 20.53|2020\-06\-23T06:25:38.55Z|0.40| 4| 2| | |scvsmag2@|2020\-06\-23T06:25:45.99Z| 7.44 6.24| MVS|3.69| 46.05| 6.89| 20.53|2020\-06\-23T06:25:38.55Z|0.40| 4| 4| | |scvsmag2@|2020\-06\-23T06:25:46.99Z| 8.45 6.79| MVS|3.71| 46.05| 6.89| 20.53|2020\-06\-23T06:25:38.55Z|0.40| 4| 3| | |scvsmag@s|2020\-06\-23T06:25:47.54Z| 8.99 7.24| MVS|3.65| 46.05| 6.89| 22.30|2020\-06\-23T06:25:38.33Z|0.99| 6| 5| | |scvsmag2@|2020\-06\-23T06:25:48.00Z| 9.67 7.79| MVS|3.53| 46.05| 6.89| 22.30|2020\-06\-23T06:25:38.33Z|0.99| 6| 5| | |scvsmag@s|2020\-06\-23T06:25:48.54Z| 10.21 8.24| MVS|3.61| 46.05| 6.89| 22.30|2020\-06\-23T06:25:38.33Z|0.99| 6| 5| | |scvsmag2@|2020\-06\-23T06:25:48.99Z| 10.66 8.62| Mfd|4.00| 46.04| 6.88| 5.00|2020\-06\-23T06:25:41.93Z|0.88| 0| | 80| 0.28|scfdalpin|2020\-06\-23T06:25:49.37Z| 7.44 8.62| Mfd|3.90| 46.04| 6.88| 12.00|2020\-06\-23T06:25:40.29Z|0.85| 0| | 140| 0.38|scfdforel|2020\-06\-23T06:25:49.37Z| 9.07 .EE .UNINDENT .UNINDENT .sp \fICreation time\fP is the time the VS magnitude message was generated, \fItdiff\fP is the time difference between \fIcreation time\fP and last \fIorigin time\fP in seconds, \fIlik.\fP is the likelihood that this event is a real event (see documentation of \fI\%scvsmag\fP), \fI#St.(Or.)\fP is the number of stations that contributed to the origin and \fI#St.(Ma.)\fP the number of envelope streams that contributed to the magnitude. \fIStr.\fP and \fILen.\fP are the strike and length of the fault line provided by \fI\%scfinder\fP\&. .SH REGIONALIZED FILTERS .sp To filter alerts to be sent out through ActiveMQ or FCM, it is necessary to set profiles on RegFilters section. Since this is using regions defined as closed polygons, then the first step is to provide a BNA file that contains the polygons. If the user does not provide a BNA file, then the other profile parameters will be evaluated globally. .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.bnaFile = /opt/seiscomp/share/sceewlog/closedpolygons.bna .EE .UNINDENT .UNINDENT .sp Then profile names have to be set. Two profile examples are provided below. .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.profiles = global, America .EE .UNINDENT .UNINDENT .sp The \fBglobal\fP profile is not configured with polygon since this spans on the entire world. The \fBAmerica\fP profile uses the \(dqAmerica\(dq closed polygon defined in \fBactiveMQ.bnaFile\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.profile.global.bnaPolygonName = none RegFilters.profile.America.bnaPolygonName = America .EE .UNINDENT .UNINDENT .sp The magnitude and likelihood threshold values might be: .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.profile.global.magThresh = 6.0 RegFilters.profile.global.likelihoodThresh = 0.5 RegFilters.profile.America.magThresh = 5.0 RegFilters.profile.America.likelihoodThresh = 0.3 .EE .UNINDENT .UNINDENT .sp There might also be a depth filter for each profile. The following parameters might be used to configure the \fBglobal\fP profile with shallow events, and the \fBAmerica\fP profile with events from 0 to 100 km deep. .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.profile.global.minDepth = 0 RegFilters.profile.global.maxDepth = 33 RegFilters.profile.America.minDepth = 0 RegFilters.profile.America.maxDepth = 100 .EE .UNINDENT .UNINDENT .sp Finally, to avoid sending alerts for events outside of the network of interest for EEW applications, a \fBmaxTime\fP can be set. The \fBmaxTime\fP is the maximum delay in seconds between the magnitude creation time since the origin time. For the examples, on the \fBglobal\fP profile this parameter might be \(dq\-1\(dq in order to skip this filter, whereas it could be set to 60 seconds for \fBAmerica\fP\&. However, each of the \fI\%Virtual Seismologist\fP and \fI\%Finite\-Fault Rupture Detector\fP algorithms have their own default thresholds superseding \fBmaxTime\fP defined in \fI\%sceewlog\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.profile.global.maxTime = \-1 RegFilters.profile.America.maxTime = 60 .EE .UNINDENT .UNINDENT .SH MAGNITUDE ASSOCIATION .sp The magnitude association is similar than the scevent preferred\-origin selection. The magnitude association evaluation is activated with the next configuration key\-value pair: .INDENT 0.0 .INDENT 3.5 .sp .EX magAssociation.activate = true .EE .UNINDENT .UNINDENT .sp The following priorities are available: .INDENT 0.0 .IP 1. 3 typeThresh .IP 2. 3 likelihood .IP 3. 3 Authors .IP 4. 3 StationMagNumber .UNINDENT .sp and they can be listed on the next key\-value: .INDENT 0.0 .INDENT 3.5 .sp .EX magAssociation.priority = magThresh,likelihood,authors,stationMagNumber .EE .UNINDENT .UNINDENT .sp The priority decreases in the order of the parameters. .sp The \fImagThresh\fP prority is a list of minimal magnitude to be allowed for each type of magnitude: .INDENT 0.0 .INDENT 3.5 .sp .EX magAssociation.typeThresh = Mfd:6.0,MVS:3.5,Mlv:2.5 .EE .UNINDENT .UNINDENT .sp For one specific update of an event, its magnitude type\-value must be equal or higher than the listed ones to continue the evaluation. Otherwise, the evaluation ends and the evalution does not continue. .sp The authors can be also used and their priority depends on the position on which they are listed. For example: .INDENT 0.0 .INDENT 3.5 .sp .EX #if magAssociation.priority contains authors then #the next parameter must contain valid magnitude authors\(aq names magAssociation.authors = scvsmag@@@hostname@, \e scvsmag0@@@hostname@, \e scfd85sym@@@hostname@, \e scfd20asym@@@hostname@, \e scfdcrust@@@hostname@ .EE .UNINDENT .UNINDENT .sp In this list of authors the highest value is for \fIscvsmag\fP and for this particular example this author has a value of 5. The author value reduces after each comma separator. For the same example \fIscvsmag0\fP is 4, \fIscfd85sym\fP is 3, and so. The author is evaluated for every event update. If the author for a particular update has a higher o equal priority than an already evaluated and sent alert, then the evaluation continues, otherwise, whether the author is listed or not, the evaluation ends. .sp If likelihood is listed on priorities then this is evaluated against with a previous update that has been sent out as alert. Only when there is a first event update the likelihood is not evaluated. In case that an update has been sent out as an alert, if the current likelihood is higher or equal than the previous one, then it goes to the next priority evaluation, otherwise, the update is discarted. .sp For the \fIstationMagNumber\fP evaluation is necessary to have a similar list of Magtype and min number of stations used to quantify the magnitude value. For example: .INDENT 0.0 .INDENT 3.5 .sp .EX magAssociation.stationMagNumber = Mfd:7,MVS:4 .EE .UNINDENT .UNINDENT .sp In this example for the mag type \fIMfd\fP is necessary to at least have 7 stations to pass this evaluation, otherwise, the evaluation ends. For \fIMVS\fP must be at least 4 stations that have been used to qunatify the magnitude, otherwise, the valution ends. .SH FIREBASE CLOUD MESSAGING .sp EEW messages are controlled by the parameters Magnitude Association and Regionalized Profiles. Notifications are sent using the \X'tty: link https://firebase.google.com/docs/cloud-messaging/migrate-v1?hl=es-419'\fI\%HTTP v1\fP\X'tty: link' [9] when topic notification option is enabled and it requires the following python libraries: .INDENT 0.0 .INDENT 3.5 .sp .EX google requests google\-auth\-oauthlib firebase\-admin .EE .UNINDENT .UNINDENT .sp Further information on the Firebase Cloud Messaging interface can be found in \X'tty: link https://firebase.google.com/docs/cloud-messaging'\fI\%Firebase Cloud Messaging\fP\X'tty: link' [8]\&. This interface is activated in the module configuration file with the option: .INDENT 0.0 .INDENT 3.5 .sp .EX FCM.activate = true .EE .UNINDENT .UNINDENT .sp When this is enable then two options are possible: .INDENT 0.0 .IP 1. 3 For \fBsending push notification to a topic\fP: .UNINDENT .INDENT 0.0 .INDENT 3.5 .sp .EX FCM.topicnotification = true .EE .UNINDENT .UNINDENT .sp In this case the configuration file defined in \fIFCM.dataFile\fP must be provided and containing the firebase configuration. Additionally, the python libraries mentioned above must be installed. The configuration file includes the path to a service JSON (see the Firebase project console \X'tty: link https://console.firebase.google.com/u/0/project/_/settings/serviceaccounts/adminsdk'\fI\%Service JSON File\fP\X'tty: link' [10]), the broadcasted topic (notification topic), the project ID string (see \X'tty: link https://console.firebase.google.com/u/0/project/_/settings/general/'\fI\%Project ID\fP\X'tty: link' [11]), and it controls (enable or disable) notification to Android, iOS and a legacy notification format. Below is an example how this file, referenced in the \fIFCM.dataFile\fP, looks like: .INDENT 0.0 .INDENT 3.5 .sp .EX [TOPICS] topic=eqAlerts [SERVICEFILE] servicefile= /opt/fcm/credentials/projectServiceFile.json [PROJECTID] projectid = myappid [ENABLED_OS] android = true ios = true [SUPPORT_OLD_FORMAT] oldformat = true [EVENT_INFO] save_evtinfo = true collection_name = eqscollection .EE .UNINDENT .UNINDENT .sp The parameters in this configuration file are defined as follows: .sp \fB[TOPICS]\fP .INDENT 0.0 .IP \(bu 2 \fBtopic\fP: The name of the Firebase Cloud Messaging topic that mobile applications subscribe to. Alerts sent to this topic will be broadcast to all subscribed devices. .UNINDENT .sp \fB[SERVICEFILE]\fP .INDENT 0.0 .IP \(bu 2 \fBservicefile\fP: The absolute path to the Firebase Service Account private key JSON file. This file is required to authenticate the module with the Google/Firebase API. .UNINDENT .sp \fB[PROJECTID]\fP .INDENT 0.0 .IP \(bu 2 \fBprojectid\fP: The unique identifier of your Firebase project. .UNINDENT .sp \fB[ENABLED_OS]\fP .INDENT 0.0 .IP \(bu 2 \fBandroid\fP: Boolean flag (\fBtrue\fP or \fBfalse\fP) to enable or disable sending push notifications to Android devices. .IP \(bu 2 \fBios\fP: Boolean flag (\fBtrue\fP or \fBfalse\fP) to enable or disable sending push notifications to iOS devices. .UNINDENT .sp \fB[SUPPORT_OLD_FORMAT]\fP .INDENT 0.0 .IP \(bu 2 \fBoldformat\fP: Boolean flag (\fBtrue\fP or \fBfalse\fP). If set to \fBtrue\fP, the notification payload will include a legacy string format in the \fBmessage\fP field to support older versions of the mobile application. .UNINDENT .sp \fB[EVENT_INFO]\fP .INDENT 0.0 .IP \(bu 2 \fBsave_evtinfo\fP: Boolean flag (\fBtrue\fP or \fBfalse\fP). If set to \fBtrue\fP, earthquake event parameters and their updates will be saved to a Firestore database. .IP \(bu 2 \fBcollection_name\fP: The name of the Firestore collection where the event information will be stored. This parameter is only used if \fBsave_evtinfo\fP is enabled. Documents within this collection will use the Event ID as the document name. .UNINDENT .INDENT 0.0 .IP 2. 3 For creating an \fBeew message dictionary\fP: .UNINDENT .INDENT 0.0 .INDENT 3.5 .sp .EX FCM.eewmessagecomment = true .EE .UNINDENT .UNINDENT .sp In this case this message contains the EQ origin information. It will be added as a comment type: \fIeewmessage\fP and text will be the message dictionary. In addition to this, the comment will be sent to the messaging system so that any other module can listen to this comment. .SH HEADLINE CHANGE FOR CAP1.2 XML ALERTS .sp The converted CAP1.2 xml alert messages contain a headline. The default headline is: .INDENT 0.0 .INDENT 3.5 .sp .EX @AGENCY@ Magnitude X.X Date and Time (UTC): YYYY\-MM\-dd HH:mm:s.sssZ. .EE .UNINDENT .UNINDENT .sp An alternative headline format might be preferred. The following alternative format can be selected: .INDENT 0.0 .INDENT 3.5 .sp .EX @AGENCY@/Earthquake Magnitude X.X, XX km NNW of SOMECITY, SOMECOUNTRY .EE .UNINDENT .UNINDENT .sp The aternative format supports both spanish and english languages. The spanish version is: .INDENT 0.0 .INDENT 3.5 .sp .EX @AGENCY@/Sismo Magnitud X.X, XX km al SSO de SOMECITY, SOMECOUNTRY .EE .UNINDENT .UNINDENT .sp The alternative format can be enable as follows: .INDENT 0.0 .INDENT 3.5 .sp .EX CAPheadlineChange = true .EE .UNINDENT .UNINDENT .sp The alternative format requires to specify the language and the corresponding file listing the world cities \fI\%CitiesFile\fP\&. The language can be selected as follows: .INDENT 0.0 .INDENT 3.5 .sp .EX #Uncomment the next line to select English AlertTextLanguage = en\-US #Uncomment the next line to select Spanish #AlertTextLanguage = es\-US .EE .UNINDENT .UNINDENT .sp The file listing the world cities \fI\%CitiesFile\fP must have the following format: .INDENT 0.0 .INDENT 3.5 .sp .EX city,country,lon,lat Tokyo,Japan,139.6922,35.6897 Jakarta,Indonesia,106.8451,\-6.2146 Delhi,India,77.23,28.66 Mumbai,India,72.8333,18.9667 Manila,Philippines,120.9833,14.6 Shanghai,China,121.4667,31.1667 Sao Paulo,Brazil,\-46.6339,\-23.5504 .EE .UNINDENT .UNINDENT .sp Both an english and a spanish version are provided in \(dq@DATADIR@/sceewlog/world_cities_english.csv\(dq and \(dq@DATADIR@/sceewlog/world_cities_spanish.csv\(dq. .SH REFERENCES .IP [1] 5 \X'tty: link http://www.seismo.ethz.ch/en/knowledge/earthquake-data-and-analysis-tools/EEW/Virtual-Seismologist/index.html'\fI\%http://www.seismo.ethz.ch/en/knowledge/earthquake\-data\-and\-analysis\-tools/EEW/Virtual\-Seismologist/index.html\fP\X'tty: link' .IP [2] 5 \X'tty: link https://pypi.python.org/pypi/python-dateutil/'\fI\%https://pypi.python.org/pypi/python\-dateutil/\fP\X'tty: link' .IP [3] 5 \X'tty: link http://activemq.apache.org/'\fI\%http://activemq.apache.org/\fP\X'tty: link' .IP [4] 5 \X'tty: link http://www.seismo.ethz.ch/en/knowledge/earthquake-data-and-analysis-tools/EEW/earthquake-early-warning-display-eewd/'\fI\%http://www.seismo.ethz.ch/en/knowledge/earthquake\-data\-and\-analysis\-tools/EEW/earthquake\-early\-warning\-display\-eewd/\fP\X'tty: link' .IP [5] 5 \X'tty: link http://www.eew.caltech.edu/research/userdisplay.html'\fI\%http://www.eew.caltech.edu/research/userdisplay.html\fP\X'tty: link' .IP [6] 5 \X'tty: link https://pypi.python.org/pypi/stompy/'\fI\%https://pypi.python.org/pypi/stompy/\fP\X'tty: link' .IP [7] 5 \X'tty: link http://lxml.de/'\fI\%http://lxml.de/\fP\X'tty: link' .IP [8] 5 \X'tty: link https://firebase.google.com/docs/cloud-messaging'\fI\%https://firebase.google.com/docs/cloud\-messaging\fP\X'tty: link' .IP [9] 5 \X'tty: link https://firebase.google.com/docs/cloud-messaging/migrate-v1?hl=es-419'\fI\%https://firebase.google.com/docs/cloud\-messaging/migrate\-v1?hl=es\-419\fP\X'tty: link' .IP [10] 5 \X'tty: link https://console.firebase.google.com/u/0/project/_/settings/serviceaccounts/adminsdk'\fI\%https://console.firebase.google.com/u/0/project/_/settings/serviceaccounts/adminsdk\fP\X'tty: link' .IP [11] 5 \X'tty: link https://console.firebase.google.com/u/0/project/_/settings/general/'\fI\%https://console.firebase.google.com/u/0/project/_/settings/general/\fP\X'tty: link' .SH CONFIGURATION .nf \fBetc/defaults/global.cfg\fP \fBetc/defaults/sceewlog.cfg\fP \fBetc/global.cfg\fP \fBetc/sceewlog.cfg\fP \fB~/.seiscomp/global.cfg\fP \fB~/.seiscomp/sceewlog.cfg\fP .fi .sp .sp sceewlog 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 magTypes Type: \fIlist:string\fP .sp The list of magnitude types handled by sceewlog Default is \fBMVS, Mfd\fP\&. .UNINDENT .INDENT 0.0 .TP .B generateReportTimeout Type: \fIint\fP .sp Timeout after which a report is generated. The timer is started on magnitude reception and restarted whenerver a new magnitude is received for the same event. Default is \fB5\fP\&. .UNINDENT .INDENT 0.0 .TP .B CitiesFile Type: \fIstring\fP .sp CSV file that contains the location of cities. It is mandatory when changeHeadline or FCM is true. Default is \fB@ROOTDIR@/share/sceewlog/world_cities_english.csv\fP\&. .UNINDENT .INDENT 0.0 .TP .B EEW.comment Type: \fIboolean\fP .sp Save a comment for each EEW alert sent out through ActiveMQ or FCM. The comment is part of the Magnitude object and stored on the Comment table of the SC\-DB. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B EEW.script Type: \fIstring\fP .sp Executes an external script for each EEW alert that are sent out. The script must be defined with full file path, and it must be executable. It receives all EEW parameters in arguments as follows: magID=.. type=M.. author=.. magnitude=.. lat=.. lon=.. depth=.. nstorg=.. nstmag=.. ot=.. When the module is started, the script is tested with argument test=1. An example of a script preparing a data file for posting on social media is provided with $SEISCOMP_ROOT/bin/eew2file. An example of a script that can be adjusted to run Shakemap from EEW solutions is provided with $SEISCOMP_ROOT/bin/eew2shakemap. .UNINDENT .INDENT 0.0 .TP .B CAPheadlineChange Type: \fIboolean\fP .sp Change the headline in the cap1.2 XML alert. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B AlertTextLanguage Type: \fIstring\fP .sp Language for the string text on headline (cap1.2 XML) or FCM near location. Default is \fBen\-US\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.activate Type: \fIboolean\fP .sp Send email notifications. Default is \fBtrue\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.smtpserver Type: \fIstring\fP .sp URL of the smtp server to send the report files to. .UNINDENT .INDENT 0.0 .TP .B email.port Type: \fIint\fP .sp Port where the SMTP server accepts connections. Default is \fB25\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.usetls Type: \fIboolean\fP .sp Whether to use TLS when connecting to the smtp server. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.usessl Type: \fIboolean\fP .sp Whether to use SSL when connecting to the smtp server. Note, only \(aqemail.usetls\(aq or \(aquser.ssl\(aq can be true. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.authenticate Type: \fIboolean\fP .sp Whether the smtp server requires authentication (username + password). Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.credentials Type: \fIfile\fP .sp If the smtp server requires authentication you have to specify a file that contains username and password in the format: .sp username=your\-username .sp password=your\-password .sp Make sure that you set the file permission as restrictive as possible. .UNINDENT .INDENT 0.0 .TP .B email.senderaddress Type: \fIstring\fP .sp Email address that will appear as sender in the report email. .UNINDENT .INDENT 0.0 .TP .B email.subject Type: \fIstring\fP .sp Any string that should be prepended to the email\(aqs subject string. .UNINDENT .INDENT 0.0 .TP .B email.host Type: \fIstring\fP .sp Host as it is supposed to appear in the email\(aqs subject string. .UNINDENT .INDENT 0.0 .TP .B email.recipients Type: \fIlist:string\fP .sp A list of email addresses that receive the report emails. .UNINDENT .INDENT 0.0 .TP .B email.magThresh Type: \fIdouble\fP .sp Only send a notification email if the magnitude threshold is exceeded. Default is \fB0.0\fP\&. .UNINDENT .INDENT 0.0 .TP .B email.sendForAlertOnly Type: \fIboolean\fP .sp Only send a notification email if an alert was sent (activeMQ, FCM, or script). Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B report.activate Type: \fIboolean\fP .sp Save reports to disk. Default is \fBtrue\fP\&. .UNINDENT .INDENT 0.0 .TP .B report.eventbuffer Type: \fIint\fP .sp Unit: \fIs\fP .sp Time in seconds that events and the related objects are buffered. Default is \fB600\fP\&. .UNINDENT .INDENT 0.0 .TP .B report.directory Type: \fIdir\fP .sp Directory to save reports to. Default is \fB~/.seiscomp/log/ESE_reports\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.activate Type: \fIboolean\fP .sp Send Alerts through ActiveMQ msg broker. Default is \fBtrue\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.hostname Type: \fIstring\fP .sp Server name that runs the ActiveMQ broker. Default is \fBlocalhost\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.port Type: \fIint\fP .sp Port on which ActiveMQ broker accepts stomp messages. Default is \fB61618\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.username Type: \fIstring\fP .sp Username with which messages are sent. Default is \fByour\-ActiveMQ\-username\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.password Type: \fIstring\fP .sp Password with which messages are sent. Default is \fByour\-ActiveMQ\-password\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.topic Type: \fIstring\fP .sp ActiveMQ broker topic to send alerts to. Default is \fB/topic/your\-ActiveMQ\-topic\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.hbtopic Type: \fIstring\fP .sp ActiveMQ broker topic to send heart beats to. Default is \fB/topic/your\-ActiveMQ\-topic\fP\&. .UNINDENT .INDENT 0.0 .TP .B ActiveMQ.messageFormat Type: \fIstring\fP .sp ActiveMQ message format; can be either \(aqcap1.2\(aq, \(aqqml1.2\-rt\(aq, \(aqshakealert\(aq, or \(aqsc3ml\(aq. Default is \fBqml1.2\-rt\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.profiles Type: \fIstring\fP .sp Profile names for regionalized alert filter. Use comma for more than one profile. Default is \fBglobal\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.bnaFile Type: \fIstring\fP .sp Path of BNA file that contains closed polygons which is used for regionalized filters. Default is \fBnone\fP\&. .UNINDENT .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 \fBRegFilters.profile.*\fP \fIProfiles containing the profile\-specific alert filtering parameters.\fP .UNINDENT .UNINDENT .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 \fBRegFilters.profile.$name.*\fP $name is a placeholder for the name to be used and needs to be added to \fI\%RegFilters.profiles\fP to become active. .INDENT 0.0 .INDENT 3.5 .sp .EX RegFilters.profiles = a,b RegFilters.profile.a.value1 = ... RegFilters.profile.b.value1 = ... # c is not active because it has not been added # to the list of RegFilters.profiles RegFilters.profile.c.value1 = ... .EE .UNINDENT .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B RegFilters.profile.$name.magThresh Type: \fIdouble\fP .sp Magnitude threshold; can be any float value. Default is \fB0.0\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.profile.$name.likelihoodThresh Type: \fIdouble\fP .sp Likelihood threshold; can be between 0.0 to 1.0 (or \-1 to disable). Default is \fB0.0\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.profile.$name.minDepth Type: \fIdouble\fP .sp Minimum depth value; can be any float value but less than maxDepth. Default is \fB0.0\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.profile.$name.maxDepth Type: \fIdouble\fP .sp Maximum depth value; can be any float value but greater than minDepth. Default is \fB800.0\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.profile.$name.bnaPolygonName Type: \fIstring\fP .sp The polygon name must be one of the closed polygons that contains the ActiveMQ.bnaFile. If this is set to none, then the origin location will not be checked against any polygon. Default is \fBnone\fP\&. .UNINDENT .INDENT 0.0 .TP .B RegFilters.profile.$name.maxTime Type: \fIdouble\fP .sp Time difference between origin time and magnitude creation time (in seconds). If this parameter is setup to \-1, the time difference is not checked. Default is \fB\-1\fP\&. .UNINDENT .INDENT 0.0 .TP .B magAssociation.activate Type: \fIboolean\fP .sp Magnitude association and scoring. The score for each EQ update is the product of magnitude, likelihood, author and num. of arrivals. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B magAssociation.priority Type: \fIstring\fP .sp The priorities can be set as: magThresh, likelihood or authors. It can be all together or just one or two. Listed comma separated. Default is \fBmagThresh,likelihood\fP\&. .UNINDENT .INDENT 0.0 .TP .B magAssociation.typeThresh Type: \fIstring\fP .sp Set the minimum magnitude threshold values for each magnitude type configured in magTypes. Default is \fBMfd:6,MVS:3.5\fP\&. .UNINDENT .INDENT 0.0 .TP .B magAssociation.authors Type: \fIstring\fP .sp Set the magnitude authors in a list comma separated. This should be generally the app name followed by the hostname. Default is \fBscvsmag@@@hostname@,scfinder@@@hostname@\fP\&. .UNINDENT .INDENT 0.0 .TP .B magAssociation.stationMagNumber Type: \fIstring\fP .sp Set the minimum number of stations on which magnitude was quantified for every magnitude type. Default is \fBMfd:3,MVS:1\fP\&. .UNINDENT .INDENT 0.0 .TP .B FCM.activate Type: \fIboolean\fP .sp Enable or disable FCM for using the eews2fcm interface. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B FCM.topicnotification Type: \fIboolean\fP .sp Enable or disable FCM for topic notifications. It this case it is mandatory to provide the dataFile. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B FCM.eewmessagecomment Type: \fIboolean\fP .sp Enable or disable this option to create a message dictionary that will be notify to the messaging system and persist it in the DB. Default is \fBfalse\fP\&. .UNINDENT .INDENT 0.0 .TP .B FCM.dataFile Type: \fIstring\fP .sp The datafile must contain the authorization key and topic to send out a message preformated on the eews2fcm interface. Default is \fB/home/sysop/seiscomp/share/sceewlog/.fcmdatafile\fP\&. .UNINDENT .SH COMMAND LINE .SS Generic .SS Verbosity .SS Messaging .SS Reports .INDENT 0.0 .TP .B \-\-savedir path Directory to save reports to. .UNINDENT .SS Mode .INDENT 0.0 .TP .B \-\-playback Disable database connection. .UNINDENT .SH AUTHOR Swiss Seismological Service .SH COPYRIGHT 2020, SED .\" Generated by docutils manpage writer. .