Gempa application server for the web
GAPS provides a collection of Web-based client tools running in a Web browser anywhere on PCs, tablets or smartphones to interface with a SeisComP3 installation that operates the GAPS server. Through GAPS, operators gain insight into a remote SeisComP3 data aquisition and processing system and can interact with it. In full-screen mode, the modules are excellent for demonstrating the performance of the SeisComP3 server system in a show room.
When connecting to a GAPS server, the start page is shown. From there the start page the individual Web modules can be started. The start page is configurable. Customized logo images can be shown by setting the parameter apps.logoPath.
GAPS start page (full-screen mode, example from http://quakelink.gempa.de/).
Access of password-secured users with specific privileges can be granted. In this way authorized users can process data and commit the results to the SeisComP3 server system as if they were directly connected to a SeisComP3 system.
GAPS consists of 2 packages that should be installed for full functionality:
GAPS uses maps stored as tiles. High resolution maps can be imported from OpenStreetMap, created by the user or purchased from gempa GmbH. Contact info@gempa.de by email for the details.
In order to have GAPS functioning, the following modules must be configured and started:
Installing the GAPS server creates the data directory @DATADIR@/gaps/ which includes the template files for creating the websites. This data directory will be overwritten with every new installation. For manually customizing the websites copy the data directory to another location referred to by mediaDirectory and make the desired changes in the new directory.
New installations might provide new features. Therefore, overwriting the files and directories in mediaDirectory with the newly installed data directory may be required. Make sure to safe the manual changes before and apply them thereafter again.
The GAPS client modules include:
The modules can be configured individually (see section setup).
Common to the client modules are some map functions:
EQView provides remote access to maps and the list of detected and located events as well as to a preview of the seismograms. The colors of the event circles and the size represent depth and magntiude, respectively.
Maps with user-specific regions and event profiles can be defined as widgets. These maps can be selected and viewed by clicking on the widget shown along with the currently selected map. The regions of these maps and of the events therein can be customized based on coordinates, magnitude and event time.
The widget "Latest Event" show the details for the latest event within the currently active map widget. When clicking on that widget more event details and waveforms are shown. Showing the picks of P and S phases can be activated by configuration. In addition, the map is zoom around the event. The zoom level depends on the event magnitude.
EQView - event map (full-screen mode). Map panels (right) show configured areas which can be selected and enlarged. Circles show event locations. The colors indicate source depth, size indicates magnitudes. Corresponding values are given in the legend (lower left). The overview map (upper left) shows the position of the central map.
EQView - event list (full-screen mode). Seismograms (left panel) are shown for a selected event.
StationView provides information on the state of sensor stations based on a mapview and text boxes. The information include quality control parameters, e.g. delay, latency, gaps, spikes and offset as well as current ground motion and PGD, PGV and PGA on 0.3 Hz high-pass filtered seismograms for the past 10 seconds and 5 minutes (in brackets). Clicking on a particular station shows the parameters in a inset figure.
The maps allow zooming in and out. They may be centred around the most recent event. For dense networks, stations are clustered and only the number is given at the centre of the region. The region shown initially on the map can be customized.
StationView (full-screen mode) showing the location of stations (triangles) with measured ground motion (color), active triggers (bold red circle around station), recent earthquakes (circles) within the configuired area and information for one selected station (left panel).
The TracveView allows viewing of real-time data collected on the SeisComP3 GAPS server along with picks made on these data. The stations for which the seismograms are shown can be selected from the map of stations based on the region. The region shown initially on the map can be customized.
For showing the traces: 1. mark "Select stations" in the settings panel to the right, 2. select a region by drawing a rectangle on the map using the left mouse bottom, 3. click on "Show traces" in the settings panel to the right.
TraceView (full-screen mode) showing the stations (triangles) for which traces can be viewed as well as active detections (bold red triangles). The stations selected for showing traces are marked in yellow.
For adjusting seismogram filtering and zooming within in the trace window, select the parameters in the "Settings" panel. The panel can be accessed by moving the mouse arrow to the right edge of the TraceView window. The filter settings can be customzed (see setup). Use the left mouse button to shift the seismograms in time.
Return to the map window by clicking on "Show map" in the "Settings" panel.
TraceView (full-screen mode) showing the traces for selected stations filtered in the configured frequency band.
Use the OriginLocatorView for viewing and relocating of events. Users with granted permissions (see setup) working from allowed computers (see setup) can view the data and send back the results from data processing.
For example, everyone from any computer worldwide may have permission to view the data but only authorized staff may be permitted to commit the processing results such as picks and loctions to the server SeisComP3 system.
Detailed help on the OriginLocatorView can be accessed throught "Help" button on the upper right on all OriginLocatorView windows.
Individual events can be accessed by clicking on that particular event in the event list or in the event map. Access the event list and map by clicking on the list and map symbol on the upper right of the "Events" tab.
OriginLocatorView showing the list of events. The help module can be accessed throught "Help" bottom on the upper right.
OriginLocatorView showing the map of events. The help module can be accessed throught "Help" bottom on the upper right.
The "Locator" tab is accessed by clicking on an event in the event list or map. In the "Locator" tab the event can be relocated choosing the configured locator and locator profile. Phase picks can be selected or unselected. Clicking on "Picker" opens the picker window where existing picks of P and S phases can be reviewed and new picks can be made.
OriginLocatorView: Location tab.
The picker window can be accessed by clinking on the "Pick" button in the "Location" tab. In the picker window arrivals of P and S phases can be picked. Results are commited the the server by clicking on "OK". For zooming and shifting the data in time, use the mouse wheel and the left mouse button on the time axis of the traces.
OriginLocatorView: picker window.
The time window parameters controlling the amount of requested data can be changed in the Setup tab. The shorter the time window the faster the data will be loaded and processed. The new parameters will be valid during the browser session. To keep the time window parameters adjust the GAPS module configuration.
OriginLocatorView: setup window.
The user-friendly graphical tool scconfig can be used to configure GAPS. A subset of control parameters is described in this section but a complete list can be found in Configuration. More detailed help for all parameters can be found the configuration of the GAPS module in scconfig (mouse-over the respective parameter).
In order to bind a station to GAPS, e.g. showing its symbol in the station view, create a GAPS binding for that station with parameter enable set to true. Stations that have not been bound to GAPS will be removed from the inventory and therefore not shown.
The access control parameters define the privileges of users to connect to the GAPS server via the Webapps. Examples are given below.
scconfig: window for setting the access control parameters.
Control of remote client access. Provide IP and port to bind the http server to. Use 0.0.0.0 to bind to all interfaces. Either the port or the IP address may be omitted, e.g. "0.0.0.0" or ":1234". Leave empty to run without providing a http server.
Access only from the localhost of the server using port 8080 (default):
bind = 127.0.0.1:8080
Access only from all remote IP addresses using port 8080:
bind = 0.0.0.0:8080
Control of remote client access using https. See bind for the details. Port ":-1" rejects the usage of https.
Re-locating events and committing the results in the OringLocatorView is protected by username and password. Different roles can be assigned to the users.
The users allowed for remote client access and the encrypted password are provided in the users file:
users = @CONFIGDIR@/gaps/users
The users file contains the user details (name:encrpyted-password). Add one line per user e.g. for user sysop:
sysop:encrpyted-password
Create the encrypted password (encrypt-password). For encrypting the password it is recommended to apply a strong algorithm such as sha-256 or sha-512. The password encryption tool may depend on the Linux flavour.
When mkpasswd is available the command
user=sysop pw=`mkpasswd -m sha-512` && echo $user:$pw;
generates a line for e.g. user "sysop".
Alternatively use, e.g. on CentOS:
python -c 'import crypt,getpass; print(getpass.getpass("Name: ")+":"+crypt.crypt(getpass.getpass(),crypt.mksalt(crypt.METHOD_SHA512)))'
Different user properties can be assigned to the users. Currently, two properties, "staff" and "guest", are interpreted by GAPS:
The properties are provied in a file, e.g.:
userProperties = @CONFIGDIR@/gaps/access
Each line contains the user name and a list of properties in format "username:prop1,prop2,prop3". Those properties are used to grant access to specific functionalities in GAPS such as sending processing results back.
Example of the file @CONFIGDIR@/gaps/access for users sysop, user1 and user2 (one line per user):
sysop:staff
user1:staff
user2:guest
QuakeLink request URI. Used as a default for all web applications. e.g.:
quakelink = http://your_server:18080/events/query
The QuakeLink proxy connection initiated by GAPS to convert and forward single events from QuakeLink to the the browser, e.g.:
quakelinkProxy = ql://your_server:18010
quakelink and quakelinkProxy need to point to the same server address. Compare with the settings in sc2ql.
MBTiles tile database if gaps should serve tiles itself. Leave empty if mapURI is configured with a remote tile server.
tileDB = @DATADIR@/gaps/zoom12.mbtiles
Variables are set if SSL is used.
The location of maps stored as tiles as well as the zoom levels can be configured. Maps from OpenStreetMap or generated by the user can be included. High resolution maps can also be purchased from gempa GmbH. Contact info@gempa.de by email for the details.
Set the parameter apps.logoPath to show customized logo images.
scconfig: window for setting the map parameters.
Full URI for tiles. The tile server URL for all applications. Provide start values for zoom level {z}, latitude {y} and longitude {x}, e.g.:
locally stored maps:
apps.mapURI = "../tiles/{z}/{y}/{x}"
a remote server
apps.mapURI = "http://example.com:8080/tiles/{z}/{x}/{y}"
or OpenStreetMap server
apps.mapURI = "http://tile.openstreetmap.org/{z}/{x}/{y}.png"
Note
OpenStreetMap and probably other tile server expect the tile indexes as z, x, y whereas the built-in gaps tile server expects z, y, x.
Maximum zoom number for which the tiles source has available. The tiles on all zoom levels higher than mapMaxLevel will be loaded from mapMaxLevel level and auto-scaled.
Maximum allowed zoom level in the interactive map. The default value is 10. Set to higher value for increased zooming if provided by the maps server.
For StationView and TraceView the region of the initally shown maps can be configured:
# The minimum latitude of the region.
apps.mapRegion.minimumLatitude = -90
# The minimum longitude of the region.
apps.mapRegion.minimumLongitude = -225
# The maximum latitude of the region.
apps.mapRegion.maximumLatitude = 90
# The maximum longitude of the region.
apps.mapRegion.maximumLongitude = 225
Widgets in the EQView can be configured allowing specfic focusing on source regions and earthquakes therein with that exceed a given magntiude threshold.
scconfig: window for setting the EQView widget control parameters.
Set the parameter apps.logoPath to show customized logo images.
Controls which of the defined widgets profiles are shown, e.g.:
apps.eqview.widgets = world,europe,chile,indonesia
Properties of all widgets profiles defined in eqview.widgets.
Add one profile block per profile.
Example for widget profile europe, where all event with magnitudes greater than 2 are shown for Europe.
# The widget title as it appears in the widgets titlebar.
apps.eqview.widget.europe.title = Europe
# The minimum latitude of the region.
apps.eqview.widget.europe.minimumLatitude = 20
# The minimum longitude of the region.
apps.eqview.widget.europe.minimumLongitude = -20
# The maximum latitude of the region.
apps.eqview.widget.europe.maximumLatitude = 60
# The maximum longitude of the region.
apps.eqview.widget.europe.maximumLongitude = 40.0
# The time span to be shown in hours.
apps.eqview.widget.europe.timeSpan = 120
# The minimum magnitude to be shown.
apps.eqview.widget.europe.minimumMagnitude = 2.0
Provide gaps_mapregion to customize the region shown initially on the map. Set the parameter apps.logoPath to show customized logo images.
Filters used in TraceView can be configured. See the section Filter grammar for details on the possible filters in SeisComP3.
scconfig: window for setting the control parameters for OriginLocatorView and TraceView.
List of filters that are available in TraceView in the from "description;filter_chain","...",...
apps.traceview.filters = "0.7Hz - 2Hz;RMHP(10)>>BW_HLP(4,0.7,2.0)","4Hz - 8Hz;RMHP(10)>>BW_HLP(4,4,8)"
Configurable:
See the figure and filters in Trace View for details.
gaps inherits global options.
Type: boolean
Allow bind sockets to privileged ports. Default is false.
Type: host-with-port
IP and port to bind the http server to. Use 0.0.0.0 to bind to all interfaces. Either the port or the IP address may be omitted, e.g. "0.0.0.0" or ":1234". If set to an empty string the application will run without providing a http server. Default is 127.0.0.1:8080.
Type: host-with-port
IP and port to bind the https server to. Use 0.0.0.0 to bind to all interfaces. Either the port or the IP address may be omitted, e.g. "0.0.0.0" or ":1234". If set to an empty string the application will run without providing a https server. Default is 127.0.0.1:-1.
Type: file
Defines the users file for access control. The user file contains one line per user where each line is of format "username:encrypted_pwd". The encrypt a password mkpasswd can be used. It is recommended to apply a strong algorithm such as sha-256 or sha-512. The command "user=sysop pw=`mkpasswd -m sha-512` && echo $user:$pw" would generate a line for e.g. user "sysop". Default is @CONFIGDIR@/gaps/users.
Type: file
Defines the file used to read user properties. Each line contains the user name and a list of properties in format "username:prop1,prop2,prop3". Those properties are used to grant access to certain functionalities in gaps such as sending processing results back. There is currently only one property which is interpreted by gaps: "staff". Default is @CONFIGDIR@/gaps/access.
Type: boolean
Enables HTTP access logging to @LOGDIR@/gaps-http-access. Logfiles are created for 24h and kept for 7 days using log rotation. Default is false.
Type: string
Path to the template that generated index.html. Default is @DATADIR@/gaps/index.cs.
Type: string
Path to media files (index.html, .css, .js, .png, ...) served by GAPS. Default is @DATADIR@/gaps/apps.
Type: int
Unit: b
Minimum buffer size in bytes per acquisition threads. Default is 65536.
Type: int
Maximum number of acquisition threads. This corresponds to the maximum number of parallel acquisition requests from clients. Default is 10.
Type: int
Unit: s
Thread request timeout. If data of a thread has not been requested for more than n seconds the thread will be closed and finished. Default is 10.
Type: boolean
Disables usage of Websockets protocol. Useful, if traffic is tunneled through a Webserver that cannot handle Websockets. Default is false.
Type: string
The QuakeLink event request URI. This is used as a default for all web applications. Default is http://localhost:18080/events/query.
Type: string
The QuakeLink proxy connection initiated by GAPS to convert and forward single events from QuakeLink to the the browser. Required since Quakelink delivers only XML format but JSON format is needed. Default is ql://localhost:18010.
Type: path
Configured the MBTiles tile database if gaps should serve tiles itself. If mapURI is configured with a remote tile server, this is not required. Default is @DATADIR@/gaps/zoom12.mbtiles.
Type: string
Path to SSL certificate file
Type: string
Path to SSL private key file
Type: path
Alternative configuration parameter for @tileDB. Default is @DATADIR@/gaps/zoom12.mbtiles.
Type: path
Alternative path to geo features displayed on the map. The default paths are ~/.seiscomp3/bna and ROOTDIR/share/bna. To consider a BNA file for map display the corresponding configuration file (either map.cfg or gaps.cfg) in the respective bna directory or sub-directory must contain "apps.gaps=true".
Note
apps.* Configuration of available web applications.
Type: string
Full URL for tiles, e.g."http://example.com:8080/tiles/{z}/{y}/{x}". The tile server URL for all applications. Default is ../tiles/{z}/{y}/{x}.
Type: int
Maximum zoom number for which the tiles source has available. The tiles on all zoom levels higher than mapMaxLevel will be loaded from mapMaxLevel level and auto-scaled. Default is 10.
Type: int
Maximum allowed zoom level in the interactive map. Default is 14.
Type: string
Path of the server API for all applications. This parameter can be overridden in each application. Default is ../.
Type: string
Path of the server websocket API for all applications. If not explicitely configured then the serverAPI path will be used.
Type: string
Relative path to a logo (brand) image shown in web applications such as eqview and mapview/stationview. Give path relative to SEISCOMP_ROOT/share/gaps/apps. The image is scaled to the field dimension 157px x 38px preserving the aspect ratio. Default is share/images/gempa_logo.svg.
Type: boolean
Whether to derive event symol colors from event depth or from event age with respect to current time. Default is false.
Type: int
Unit: s
If event symbol colors are derived from the event age then the age must be recomputed at a certain interval. This number defines the interval in seconds to update the event colors. The lower the interval the more often the colors must be updated which can decrease performance. Default is 60.
Note
apps.mapRegion.* Configures the initial region to be shown e.g. in traceview and station view.
Type: double
Unit: deg
The minimum latitude of the region. Default is -90.
Type: double
Unit: deg
The minimum longitude of the region. Default is -225.
Type: double
Unit: deg
The maximum latitude of the region. Default is 90.
Type: double
Unit: deg
The maximum longitude of the region. Default is 225.
Type: boolean
Shows the selected widgets region rect in the central map. Default is false.
Type: boolean
Shows the spreading of P/S wave in the center-widget. Default is false.
Type: boolean
Show UTC time in the frontend. Default is false.
Type: boolean
If enabled then all waveforms of an event will be requested even if stations are not part of the local inventory. If disabled then only stations are allowed that are configured locally with bindings. Default is true.
Type: int
The minimum population of a city to be taken into account as nearest city to an event. Default is 100000.
Type: double
Unit: deg
The maximum distance of the nearest city from an event. Default is 20.
Type: boolean
Whether to show the latest event in the top left corner of the widget which is currently active as main widget. Default is true.
Type: boolean
Whether to show the latest overall event of all widgets. It will be shown in the top right corner above the widgets. Default is false.
Type: integer
Unit: hours
The time span for which the latest overall event will be selected. Default is false.
Type: string
Defines the available widgets. The first widget listed is taken as primary widget. Default is world.
Note
apps.eqview.referencePlace.* Defines a reference place / city which is used to compute the distance and azimuth from the event shown in the event details.
Type: string
The name of the place.
Type: double
Unit: deg
The latitude of the reference place.
Type: double
Unit: deg
The longitude of the reference place.
Note
apps.eqview.widget.* The configured widgets.
Note
apps.eqview.widget.$name.* $name is a placeholder for the name to be used.
Type: string
The widget title as it appears in the widgets titlebar.
Type: double
Unit: deg
The minimum latitude of the region.
Type: double
Unit: deg
The minimum longitude of the region.
Type: double
Unit: deg
The maximum latitude of the region.
Type: double
Unit: deg
The maximum longitude of the region.
Type: integer
Unit: hours
The time span to be shown in hours.
Type: double
The minimum magnitude to be shown.
Type: list:string
Event status code list that is accepted. Each item is a character (A,M,...) that maps to the type code in the QuakeLink summary format. To exclude types, a minus can be prepended to each code, e.g. "-X". That would accept all solutions except rejected. An empty list accepts everything.
Type: double
Unit: min
The pre-offset of the traces with respect to the onset. Default is 2.0.
Type: double
Unit: min
The post-offset of the traces with respect to the onset. Default is 5.0.
Type: boolean
Configures whether traces are aligned on first picked onset or on theoretical arrivals. Default is false.
Type: boolean
Configures if picks are shown in the waveforms. Default is false.
Type: boolean
Whether to give visual feedback if a new event has been set as latest in the widget. If enabled then the widget shakes for a short time when the latest event updates. Default is false.
Type: path
Path to an audio file played when adding a new event to the widget. Give path relative to $SEISCOMP_ROOT/share/gaps/apps, e.g. share/audio/alert.mp3. Preferred format: mp3.
Type: list:string
The list of filters available in traceview, format per item is "name;filter-string". Default is "0.7Hz - 2Hz;RMHP(10)>>BW_HLP(4,0.7,2.0)","1Hz - 3Hz;RMHP(10)>>BW_HLP(4,1,3)","2Hz - 4Hz;RMHP(10)>>BW_HLP(4,2,4)","4Hz - 8Hz;RMHP(10)>>BW_HLP(4,4,8)".
Type: boolean
Forces to use HTTP protocol instead of Websockets for trace transport. This can be important when tunneling GAPS through Apache where Websockets are not well supported. Default is false.
Type: double
Unit: s
Timespan for trace display. The default is 10min. Default is 600.
Type: string
Defines the default mapview mode that is used to color the station symbols. Valid values are "delay", "latency" and "groundmotion". Default is delay.
Type: boolean
Defines whether the station symbols should be clustered by default or not. Default is true.
Type: string
Defines an additional link that is rendered on the station detail page. It supports two placeholders: ${net} and ${sta} which are replaced during runtime.
Type: string
The name as displayed on the station panel for the custom station link.
Type: double
Unit: days
Number of days to preload if scolv is started. Default is 1.
Type: boolean
Show UTC time in the frontend. Default is true.
Type: boolean
Show distances in km instead of degree. Default is false.
Type: list:string
List of filters available in the picker. If @ is prepended to the name of the filter it will be selected as default filter. The format of each entry is "name;definition", e.g. "BP 0.7 - 2 Hz 3rd order;BW(3,0.7,2)"
Type: list:string
List of phases enabled for picking. Default is P,Pn,Pg,S,Sn,Sg,pP.
Type: double
Unit: s
The time span added to the left of requested data time window. Default is 300.
Type: double
Unit: s
The time span added to the right of the requested data time window. Default is 600.
Type: double
Unit: s
The default time window shown before the trace alignment. Default is 30.
Type: double
Unit: s
The default time window shown after the trace alignment. Default is 90.
Note
apps.scolv.ttt.* Travel time table related configuration. Travel time tables can be added via plugins. Built-in interfaces are libtau and LOCSAT. For each activated interface a list of supported models must be provided.
Type: list:string
The list of active travel time table interfaces. Default is libtau, LOCSAT.
Note
apps.scolv.ttt.$name.* $name is a placeholder for the name to be used.
Type: list:string
The list of supported model names per interface.
show help message.
show version information
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, eg scautopick -> scautopick2.
Load given plugins.
Run as daemon. This means the application will fork itself and doesn't need to be started with &.
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
Increase verbosity level (may be repeated, eg. -vv)
Quiet mode: no logging output
Limits the logging to a certain component. This option can be given more than once.
Use syslog logging back end. The output usually goes to /var/lib/messages.
Path to lock file.
Send log output to stdout.
Debug mode: --verbosity=4 --console=1
Use alternative log file.
Overrides configuration parameter connection.username.
Overrides configuration parameter connection.server.
Overrides configuration parameter connection.timeout.
Overrides configuration parameter connection.primaryGroup.
A group to subscribe to. This option can be given more than once.
Overrides configuration parameter connection.encoding.
Sets sending of a start- and a stop message.