Web Obs Manual

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 75

WebObs : An integrated web-based
system for networks management and
data monitoring in observatories
User and Administration Manual
Fran¸cois Beauducel and Didier Lafon
Institut de Physique du Globe de Paris Observatories
Release v2.1.2, April 2019
ii
Contents
Introduction vii
1 Installation 1
1.1 Overview .................................................. 1
1.2 System requirements ........................................... 1
1.2.1 System and package ........................................ 1
1.2.2 Software requirements ....................................... 2
1.3 Initial installation ............................................. 2
1.4 Upgrades .................................................. 3
1.5 qsys - query configuration ......................................... 3
1.6 Configuration files syntax ......................................... 4
1.7 WebObs tree ............................................... 5
1.8 License ................................................... 6
2 Reference 7
2.1 Overview .................................................. 7
2.2 Nodes: Elementary WebObs Objects ................................... 7
2.2.1 Create, edit or delete a NODE .................................. 9
2.2.2 Names and codes ......................................... 9
2.2.3 Lifetime and validity ........................................ 9
2.2.4 Grids memberships ........................................ 9
2.2.5 Geographic location ........................................ 10
2.2.6 Transmission ............................................ 11
2.2.7 Proc’s parameters and data status ................................ 11
2.2.8 Features .............................................. 13
2.2.9 Installation, information and access ................................ 13
2.2.10 Photos, diagrams and associated documents ........................... 13
2.2.11 Project ............................................... 13
2.2.12 Events ............................................... 13
2.3 Grids: networks of nodes ......................................... 14
2.3.1 Views ............................................... 15
2.3.2 Procs ............................................... 16
2.3.3 Forms ............................................... 16
2.3.4 Project ............................................... 16
2.3.5 Events ............................................... 16
2.3.6 TMap: GRIDS diagram ...................................... 17
2.4 Events Logging .............................................. 17
2.5 Web pages ................................................. 18
2.5.1 Main menu ............................................ 18
2.5.2 Home page ............................................ 18
2.5.3 Wiki pages ............................................. 18
2.5.4 Tools pages ............................................ 18
2.5.5 Application pages ......................................... 18
3 Built-in applications 19
3.1 The Gazette ................................................ 19
3.1.1 Overview .............................................. 19
3.1.2 Configuration ........................................... 19
3.1.3 Display/Edit Gazette ....................................... 20
iii
iv CONTENTS
3.2 GRIDMAPS and LOCASTAT: maps of georeferenced nodes ....................... 21
3.2.1 Overview .............................................. 21
3.2.2 GRIDMAPS ............................................ 21
3.2.3 LOCASTAT ............................................ 22
3.3 SEFRAN3/MC3: seismic chart and bulletin ............................... 23
3.3.1 Overview .............................................. 23
3.3.2 SEFRAN3 installation ....................................... 24
3.3.3 MC3 configuration ........................................ 27
3.3.4 Links with earthquake event catalogs ............................... 29
3.4 GENPLOT: generic time series ...................................... 29
3.4.1 Overview .............................................. 29
3.4.2 Configuration ........................................... 30
3.5 HYPOMAP: Earthquake hypocenter maps from seismic catalog .................... 31
3.5.1 Overview .............................................. 31
3.5.2 Configuration ........................................... 31
3.6 HELICORDER: Seismic helicorder .................................... 33
3.6.1 Overview .............................................. 33
3.6.2 Configuration ........................................... 33
3.7 RSAM: Realtime Seismic Amplitude Measurement ............................ 34
3.7.1 Overview .............................................. 34
3.7.2 Configuration ........................................... 34
3.8 GNSS: GPS time series, vectors and modelling .............................. 36
3.8.1 Overview .............................................. 36
3.8.2 Configuration ........................................... 36
3.9 EXTENSO: Extensometry time series and vectors ............................ 38
3.9.1 Overview .............................................. 38
3.9.2 Configuration ........................................... 38
3.10 TILT: Tiltmetry time series, vectors and modelling ........................... 39
3.10.1 Overview .............................................. 39
3.10.2 Configuration ........................................... 39
3.11 METEO: meteorological time series .................................... 40
3.11.1 Overview .............................................. 40
3.11.2 Configuration ........................................... 40
3.12 WATERS: chemical analysis ........................................ 42
3.12.1 Overview .............................................. 42
3.12.2 Configuration ........................................... 42
3.13 PROCS graph and data request ...................................... 43
3.13.1 Overview .............................................. 43
3.13.2 Description ............................................ 43
3.13.3 Configuration ........................................... 44
3.14 Data formats available for PROCS .................................... 44
3.14.1 Waveforms formats ........................................ 44
3.14.2 Generic time series ........................................ 45
3.14.3 Quakes catalogs .......................................... 46
3.14.4 GNSS solutions .......................................... 47
3.14.5 Other specific formats ....................................... 47
4 Administration 49
4.1 Users, Groups and Authorizations ..................................... 49
4.1.1 Overview .............................................. 49
4.1.2 Users table and Groups table ................................... 49
4.1.3 Resource tables .......................................... 50
4.1.4 Managing Users and Authorizations ............................... 50
4.1.5 Developing with Users and Authorizations system ........................ 50
4.1.6 Adding a new user ......................................... 50
4.2 PostBoard ................................................. 50
4.2.1 Overview .............................................. 50
4.2.2 Event names ............................................ 51
4.2.3 Managing PostBoard Subscriptions ................................ 51
4.2.4 Developing with Notifications ................................... 52
4.3 Scheduler ................................................. 52
CONTENTS v
4.3.1 Overview .............................................. 52
4.3.2 Configuration and Tables ..................................... 53
4.3.3 Jobs selection and execution ................................... 54
4.3.4 Scheduler manager ........................................ 54
4.3.5 Scheduler runs ........................................... 55
4.3.6 Scheduler status .......................................... 55
4.3.7 Scheduler command line ..................................... 56
4.4 WOC .................................................... 57
4.4.1 Overview .............................................. 58
5 Developments 59
5.1 Use PROC’s output graphics facilities .................................. 59
5.1.1 Graphs per time scale ....................................... 59
5.1.2 Graphs per event ......................................... 60
5.2 SUPERPROCS: Templates for applications development ........................ 60
5.2.1 Superprocs ............................................. 60
Appendix 61
Acknowledgments 65
vi CONTENTS
Introduction
Seismological and Volcanological observatories have common needs and often common practical problems for multi
disciplinary data monitoring applications. In fact, access to integrated data in real-time and estimation of mea-
surements uncertainties are keys for an efficient interpretation and decision making. But instruments variety, data
sampling, heterogeneity of acquisition systems lead to difficulties that may hinder crisis management. Since early
2001, we faced this problem in the Guadeloupe volcanological observatory and we developed an operational system
that attempts to answer these questions in the context of a pluri-instrumental observatory. Based on a single com-
puter server, open source scripts (Perl, Bash, Matlab with compiled binaries, Octave, Python) and a Web interface
(Apache), the system named WebObs proposes:
•an extended database for networks management, stations and sensors (maps, station file with log history,
technical characteristics, meta-data, photos and associated documents);
•web-form interfaces for manual data input/editing and export (like geochemical analysis, repetition deformation
measurements, ...);
•routine data processing with dedicated automatic scripts for each technique, production of validated data
outputs, static graphs on preset moving time intervals, possible e-mail alarms;
•acquisition processes, stations and individual sensors status automatic check for technical control.
In the special case of seismology, WebObs includes a digital stripchart multichannel continuous seismogram com-
patible with international standards (SEED) associated with EarthWorm 1and SeisComP3 2event database, event
classification database, automatic shakemaps and regional catalog with associated hypocenter maps accessed through
a user request form.
This system leads to a real-time Internet access for integrated monitoring and becomes a strong support for scientists
and technicians exchange, and is widely open to interdisciplinary real-time modeling. At the time of this document, it
has been set up in different observatories where it is used as one of the main operational tool: Guadeloupe, Martinique
(Lesser Antilles), La R´eunion (Indian Ocean), Java (Indonesia), and Paris (France).
1see http://www.isti.com/products/earthworm/
2see http://www.seiscomp3.org/
vii
viii INTRODUCTION
Chapter 1
Installation
1.1 Overview
$>
PROCs FORMs
NODEs
VIEWs
Apache HTTP Server
Perl Matlab
binaries Bash
Jobs
Requests
Scheduler
PostBoard
Clients : Consoles, Browsers, Mails
In/Out
Configurations + Logs
Objects
Procedures
Daemons
Environments
External Sources
RawData Data
Figure 1.1: WebObs big picture
1.2 System requirements
1.2.1 System and package
WebObs server can run on Linux and Mac OS X.
It has been successfully installed/tested on:
1
2CHAPTER 1. INSTALLATION
•Linux 3.13.0 , x86 64 , Ubuntu 14.04 LTS
•Linux 4.13.0 , x86 64 , Ubuntu 16.04 LTS
•Linux 2.6.32, i386 , Debian 2.6.32-48squeeze4
•Linux version 3.2.0-4-amd64, Debian 3.2.51-1
•Linux version 3.2.0-4-amd64, Debian 4.6.3-14
•Linux version 4.9.0-5-amd64, Debian 4.9.65-3
•Mac OS X 10.11.5, Darwin 15.5.0
WebObs (browser) clients have been successfully tested with:
•FireFox (up to FireFox 47)
•Safari
Download the WebObs latest Release and MatLab Runtime Compiler from:
http://www.ipgp.fr/˜beaudu/webobs.html
1.2.2 Software requirements
Required installations
The following softwares will be tested for existence by the setup installation procedure:
•Perl 5.14+ (setup will also check for additional Perl modules)
•Apache 2.2+
•Sqlite 3.7.9
•ImageMagick 6.6.9 (convert+identify)
•Mutt 1.5+
•MatLab MCR R2011b
Bundled software
The following lists softwares included in WebObs package:
•SeisComP3 (slinktool + arclink fetch)
•JavaScript extensions:
–JQuery
–flot
–markItUp
–MultiMarkDown
–overlib
1.3 Initial installation
You must have root privileges to execute WebObs installation.
Installation procedure:
•Choose/create your target WebObs directory, and cd to it. For demonstration purposes in this document we
will use /opt/webobs/ as the target WebObs directory.
•Download WebObs package and MatLab RunTime Compiler. For demonstration purposes in this document
we will use WebObs-2.1.2.tgz as the WebObs package.
1.4. UPGRADES 3
•Choose/create the system’s WebObs user+group (aka WebObs Owner) if you don’t want setup procedure
to create one itself.
The WebObs user, and its corresponding group, is the required WebObs administration account. It must have
a home directory. It will be the owner of the WebObs CONF,LOGS,DATA,WWW,OUTx directories. The Apache
http server user will be made a member of WebObs user’s group. The WebObs user can be used to launch the
WebObs Scheduler and Postboard daemons.
•Untar WebObs package. This will create/populate the WebObs version subdirectory: /opt/webobs/WebObs-
2.1.2.
•Run the setup procedure (again, with root privileges):
–must be called as /opt/webobs/WebObs-2.1.2/SETUP/setup
– setup will gather information/location from your system/environment, check for some dependencies (see
Requirements section above), build the WebObs structure, optionaly customize Apache’s WebObs Vir-
tual Host, set required system’s ownerships and access-rights, and populate your brand new WebObs
with ready to use demonstration data and templates.
–once completed, setup will display WebObs configuration (see qsys command below).
– WebObs now ready, you need to activate the scheduler,postboard and (re)start Apache http server.
1.4 Upgrades
You must have root privileges to execute WebObs upgrades.
The setup procedure used for Initial Installation, is also used to upgrade WebObs to a new release. It will automat-
ically detect that an upgrade is intended rather than a first time installation.
Upgrade procedure:
•Download WebObs package corresponding to the version you want to upgrade to.
•Untar WebObs package.
•Run the setup procedure (/opt/webobs/WebObs-2.1.2/SETUP/setup).
•setup reports Version changes and important information in the SETUP.CONF.README file. Please read
it carefully.
•setup will also, if you choose to do so, walk through executions of vimdiffs between your configuration files
and corresponding non-customized WebObs version configurations that were changed / added.
1.5 qsys - query configuration
qsys script, also automatically executed when setup ends, will display your base WebObs configuration.
qsys example
__ __ __
... oooo oWoo o ooo .. W \ V V / Id: ip gp
. oo .. . .. . .. . .. . .. o .. o . . W \ _ /\ _/ V er si o n: W eb Obs - 2. 0. 0
. oo . . .. . .. . .. . .. . . .. oW __ _
. oo . . .. . .. . .. . .. . .. W / - _ ) O wn er : w eb ob s [ w eb o bs ]
. W.. . . .. ... ... . .. . o ... . W \ ___ | Roo t: / o pt / w eb ob s
.W .... .. ... .. .. o .... .. .. . oWWW oo . W _ Con fi g: / opt / web ob s /CO NF / WEB OBS . rc
. W . . . . .. ... ... . .. o .. .. . W | | __ L og s: / o pt / w eb ob s / LO GS
W . .. . WW WWo . ... . W | ’ _ \
. W . Wo . . W xx x xx . ... W | _. _ _ / MC R: / us r / l oc al / M AT LA B / M AT L AB _ Com p il e r _R u nt i me / v7 ...
. W . WW W . Wx xx xxx W . .. .. . W _ __ Raw da ta: / opt / r aw da ta
. W . W WW W Wx xx x xx xx W . .. .. ... .. W / _ \ S ef ra n: / op t / se fr an
Wo . . o oW xxxx x xW xxx x xx xxx x o . .. ... .. W \ _ __ /
. x xx xxxx xxxx xxxW xxxx xxxx xW ... .. .. W _ HTT P: h ttp: // web ob s . ip gp
. x xxxx x xx xxx x xW WWW W xx x xx xW .. .. . oW | | __ / et c / ap ach e2 / s ite s - a va il abl e / w eb ob s
. W xx xx xxxx xWx xWWW WWW Wxxx xxW Wo .. W | ’_ \ run ni ng on A pache / 2. 2.22 ( Ubu ntu )
.oxxxxxxxxxxxxxWWWWWWWxxxxxxxWW |_.__/
. oWxxx xx xx xx xx xx WW WW WW WW xx xW W ___ Sch edul er: not runn ing
. o W x xx x xx x xx x x xW W WW W x W .. W ( _ - < P os t Bo ar d : no t r u nn in g
.. . oW W Wx x xW W WW o .. W / __ /
qs ys run 2014 -08 -08 12 :0 5:06
4CHAPTER 1. INSTALLATION
SEFRAN/
RAWDATA/
CONF/
DATA/
LOGS/
OUTG/
OUTR/
WWW/
CODE
DOC
WebObs-Version/
DOC/
CODE/
SETUP/
WebObs-Version.tgz
WebObs-Version.tgz.md5
MCR_R2011b_glnx*_installer.zip
MATLAB_Compiler_Runtime/
/etc/webobs.d
apache virtualhost Document Root
Figure 1.2: Overview of WebObs installed disk structure
1.6 Configuration files syntax
WebObs configuration files (*.rc, *.conf, or *.cnf) used to customize your installation and described in this document,
typically define one functionnal parameter (key) per line, made up of one or more associated values (fields). They
1.7. WEBOBS TREE 5
can share the same set set of syntactic rules for parsing/interpretation:
1) In order to be parsed/interpreted according to the following rules, the files must contain a so-called ’definition
line’ (identified with =in column 1) as the first interpreted line. This definition line is also used to further define
parsing, that comes in two (2) flavors:
=key|value one value per key (Perl’s equiv. $X{key}=>value)
=key|name1|...|nameN multiple named values per key (Perl’s equiv. $X{key}{name1}=>value)
2) Any text following a #is considered a comment and discarded.
3) Blank lines are discarded, leading and trailing blanks too.
4) Fields separator character, within interpreted lines, is |(pipe).
5) |and #characters that must belong to a field value may be ’escaped’ (ie. not interpreted as separator or comment
respectively) by prefixing them with a \.
6) Field value substitution (interpolation) is allowed in =key|value format:
${key}in value will be replaced with the value of the key |value pair of the current file.
$WEBOBS{key}in value will be replaced with the value of the WebObs main configuration key value.
1.7 WebObs tree
CONF/ configurations
WEBOBS.rc main WebObs configuration file
*.{rc,conf,cnf}other configuration files
FORMS/ FORMS definitions
formname/ definitions for FORM formname
PROCS/ PROCS definitions
procname/ definitions for PROC procname
VIEWS/ VIEWS definitions
viewname/ definitions for VIEW viewname
GRIDS2FORMS/ links from PROCs to FORMS
PROC.pname.formname ->../formname
GRIDS2NODES/ links from GRIDs to NODES
PROC.pname.nodename ->../../DATA/NODES/nodename
VIEW.vname.nodename ->../../DATA/NODES/nodename
CODE/ WebObs code
bin/ executables
cgi-bin/ Perl CGIs
css/ HTML Style Sheets
html/ static HTML pages
icons/ HTML icons, static images
js/ javascript
matlab/ matlab (+ compiled)
shells/ bash commands
tplates/ configurations templates
DATA/ data
DB/ built-in tools data
*.DAT
DEM/ Digital Elevation Model files
NODES/ NODES configurations and data
nodename/ nodename
*.txt system features descriptions
*.cnf configuration
*.clb calibration file
DOCUMENTS/ documents
FEATURES/ features
6CHAPTER 1. INSTALLATION
INTERVENTIONS/ events log
PHOTOS/ pictures
DOC/ documentations
LOGS/ tools, appl, daemons logs
OUTG/ batch Procs Outputs
PROC.procname/ PROC procname outputs
exports/
graphs/
maps/
events/
OUTR/ Procs Requests Outputs
20140720 084340 85.199.99.199 userX/ Dated Request
REQUEST.rc Request parameters
PROC.procname/ Requested Proc outputs
graphs/
1.8 License
Chapter 2
Reference
2.1 Overview
2.2 Nodes: Elementary WebObs Objects
A NODE is the central WebObs element associated with following attributes:
•a long name (NAME) and short name (ALIAS);
•an optional short description (TYPE);
•a lifetime period with start and end dates (both optional);
•an optional location (latitude, longitude, elevation) associated with a location map (graph), Google Maps and
Google Earth links;
7
8CHAPTER 2. REFERENCE
•optional text contents for ”informations”, ”installation” and ”access”;
•an optional sensor description associated with a calibration table of channels parameters;
•a list of user-defined features (also free text contents);
•attached documents, photos and diagrams;
•a project;
•events log associated with date and operator list;
•a list of associated grids (VIEWS and/or PROCS, see 2.3);
•a validity flag (for admin users);
•optional functional parameters when the NODE is associated to a PROC: data code (FID), network code
(FDSN), data format (RAWFORMAT) and source (RAWDATA), time zone (TZ), acquisition period and delay,
and a calibration file that describes each channel characteristics and history:
–date and time of validity;
–channel number, name, unit, code, S/N, offset, factor, gain, min/max values, azimuth, latitude, longitude,
elevation, depth, sampling frequency, dynamic, location code.
Examples of what a NODE can be:
•an instrumental station or a part of it,
•a site or place for data sampling or measurement,
•a place of any interest,
•a mobile equipment, an instrument, a building, a vehicle, ...
•a journal board, an event description (e.g. an historical earthquake), ...
NODES.rc
= ke y | va lu e
PAT H_ NO DES | $WE BOBS { RO OT _D AT A }/ NODES
SPATH_INTERVENTIONS|EVENTS
SPATH_PHOTOS|PHOTOS
SPATH_DOCUMENTS| DOC UM ENTS
SPATH_SCHEMES|SCHEMES
SPATH_FEATURES| FEA TU RE S
SPATH_THUMBNAILS| THUM BN AILS
PATH_EVENTNODE_TRASH| $WE BO BS { R OOT_D AT A }/ t rash / E VE NT NODE
PATH_NODE_TRASH| $WE BO BS { R OO T_ DA TA }/ tra sh / NOD ES
EVENTNODE_NOTEBOOK| NO
EVENTNODE_NOTIFY_DEFAULT| NO
# l is t of c a te gor ies ( v al id ke ys are : gr id , a lia s , f eatu re , auth or , remot e , s ta rt da te , en dd ate , ti tle , c om ment , not eb ook , o ut com e )
EVENT_SEARCH_CATEGORY_LIST| gr id , al ias , f eatu re , au tho r , r emo te , s ta rtda te , titl e , c omm en t , n ot eboo k , o utc om e
EVENT_SEARCH_MAXDISPLAY_LIST| 15 ,50 ,75 ,100
EVENT_SEARCH_DEFAULT| ali as
EVENT_SEARCH_DEFAULT2|comment
CGI _S HOW | s how NOD E . pl
CGI _S RCH | src hN ODES .pl
CGI _F ORM | f orm NOD E . pl
THUMBNAILS_ON| AL L
THUMBNAILS_PIXH| 10 0
THUMBNAILS_PIXV| 10 0
THUMBNAILS_EXT| jp g
FILE_NETWORKS| $WE BOBS { RO OT _C ON F }/ n et wo rk co de s . csv
FILE_NODES2NODES| $WE BO BS { ROOT _C ON F }/ n od es 2n od es . rc
FILE_TELE| $WE BO BS { R OO T_ CO NF }/ T RA NS typ es . conf
FIL E_ POS | $WE BOBS { RO OT _C ON F }/ P OS IT IO Nt ype s . conf
FILE_FILTER_NOTES| $ WE BO BS { P AT H _D AT A_W EB }/ N ote s _F ilt r e_ Sta t io ns . tx t
# node ’ s s tatu s ( thre s hold in %)
SQL_DB_STATUS| $WE BOBS { PA TH _D AT A_ DB }/ NODE SS TA TU S .db
STATUS_THRESHOLD_WARNING| 90
STATUS_THRESHOLD_CRITICAL| 10
STATUS_STANDBY_VALUE| -1
2.2. NODES: ELEMENTARY WEBOBS OBJECTS 9
2.2.1 Create, edit or delete a NODE
Modifying NODE is possible only through a GRID (see next section 2.3). Creation of new NODE or edition of
an existing NODE deserves to USERS with edit level for the associated GRID. Deletion of a NODE is reserved to
administrator level USERS.
2.2.2 Names and codes
Main code (ID)
Each NODE has a unique ID code in WebObs . The code can be any string of characters, but it is recommended
to use a comprehensive and rational code (see appendix 5.8) when creating a new NODE. Attribution of this unique
code deserves to USERS with administrator level when creating a new NODE. It cannot be modified after.
Name
The long NAME of a NODE is used for display purposes in tables and graphs. It cannot be empty. The NAME is
displayed in the main GRID’s table in front of the corresponding NODE.
Alias (short name)
The ALIAS is the short name of a NODE, used for display purposes in table and graphs. It cannot be empty. The
ALIAS is displayed in the main GRID’s table in front of the corresponding NODE.
Type
The TYPE of a NODE is an optional free string that will be used for any short description of the NODE. The TYPE
is displayed in the main GRID’s table in front of the corresponding NODE.
2.2.3 Lifetime and validity
Start/end dates
Start and end dates of a NODE define the period of activity of this NODE. Both or any of these two dates can
be undefined or incompletely defined, while respecting the ISO 8601 standard: Date values are ordered from the
most to the least significant: year, month and day; any number of values may be dropped from any of the date
representations, but in the order from the least to the most significant. For example, 1976 and 2005-04 are both
reduced precision valid dates.
The lifetime of a NODE has potential impact on processes that use this NODE or associated data.
Valid NODE
Independently of the lifetime period, a NODE can be valid or invalid. When invalid, a NODE is simply ignored by
most of the WebObs processes and invisible for standard USERS. Nevertheless, if a USER has an administrator level
, he will be able to see an invalid NODE in the lists and tables.
2.2.4 Grids memberships
A NODE can be associated with one or more GRIDS. See section 2.3.
10 CHAPTER 2. REFERENCE
2.2.5 Geographic location
A NODE can be georeferenced using latitude, longitude and elevation coordinates on Earth. When a NODE has valid
coordinates defined, a location map will be automatically built (see below and section 3.2.3), and it will appear on
associated GRID’s maps (see section 2.3).
WGS84 coordinates
Latitude and longitude must be in the WGS84 geodetic reference system, and expressed in decimal form, using
negative value for southern latitude and western longitude. Use the dot as decimal point (not coma).
In the NODE’s display page, coordinates are presented in different formats: DDD.ddddd (decimal degrees), DDD◦MM.mmm’
(degrees and decimal minutes) and DDD◦MM’SS.s” (degrees, minutes and decimal secondes).
The coordinates are displayed in the main GRID’s table in front of the corresponding NODE. Also, the Universal
Transverse Mercator (UTM) projection is computed and displayed in the NODE’s page.
Timestamp and type of coordinates
This optional information provides the timestamp (date) of coordinates, and a type of positioning from a list.
POSITIONtypes.conf
= ke y | va lu e
# De f i n itions of Posit i o n ning typ es
#
# Cl e : t ype us ed in s cripts , forms , dat aba se , ...
# No m : c or respo n di ng tex t str in g to be dis pla yed
#
# Cle | N om
0|unknown
1| ma p
2| GP S m eas .
Google Maps API link
Link to Google Maps API is available if the NODE has coordinates. The link will open a pop-up window. This
functionality is associated with some variables in the main configuration file WEBOBS.rc:
WEBOBS.rc (excerpt)
CGI_GOOGLE_MAPS| g o og le M AP S . p l
GOOGLE_MAPS_LINK|1
GOOGLE_MAPS_API| ht tp :/ / ma ps . g oo gl e . com / m aps ? file = api
GOOGLE_MAPS_API_KEY
GOOGLE_MAPS_LINK_INFO| See wi th Goo gle Maps ( ATTE NT ION : err or ~20 m )
GOOGLE_MAPS_ICON| / ic ons / gd ot . pn g
GOOGLE_MAPS_TYPE|G_HYBRID_MAP
GOOGLE_MAPS_WIDTH_VALUE| 50 0
GOOGLE_MAPS_HEIGHT_VALUE| 50 0
GOOGLE_MAPS_ZOOM_VALUE| 17
Google Earth KML link
Link to Google Earth KML file is available if the NODE has coordinates. The link will download a local KML file, which may
be open with local application Google Earth (if installed). This functionality is associated with some variables in the main
configuration file WEBOBS.rc:
WEBOBS.rc (excerpt)
GOOGLE_EARTH_LINK| 1
GOOGLE_EARTH_LINK_INFO| KML file for G oog le E art h ( AT TENT ION : error ~20 m )
IMAGE_LOGO_GOOGLE_EARTH|/ ic ons / go og le / g oo gl e_ ea rt h . gif
2.2. NODES: ELEMENTARY WEBOBS OBJECTS 11
Location map
A location map with 4 different scales is automatically made and updated by LOCASTAT application (see section 3.2.3 for
associated parameters), using the coordinates of the NODE.
2.2.6 Transmission
When a NODE represents, for instance, an instrumental station with data transmission, the type of transmission can defined
using a reference list (below) and other NODEs can be defined as intermediate repeaters or final acquisition point.
The transmission chain is displayed with dynamic links to associated NODEs. It appears also on the location map (see section
3.2.3) and the GRID maps (see section 3.2.2).
Type
Type of transmission is defined in a list of transmission type associated with plot line style, width and color.
TRANStypes.conf
# WEB O BS
#
# Trans m i s sion ty pes de f i n itions
#
# ke y : u sed i n { show , fo rm } NODE . pl and rea dno de . m
# name: name
# s ty le : l ine st yl e ( M at l ab st yle : - , - - , -. ,:)
# widt h : l ine wid th
# rg b : line color red , green , blue ( v alue s be t ween 0 and 1)
#
= key | name | s tyle | w idth | rgb
#
0| -| n one |0 |0 ,0 ,0
1| An alog R adio | -|1|0 ,0 ,0
2| Hard - wired | -.|1|0 ,0 ,0
3| Phone / GSM |:|1|0 ,0 ,0
4| La ser | - -|1|1 ,0 ,0
5| Wi reles s | -|.75|0 ,0 ,0
6| Sa telli te |:|2|0 ,0 ,0
Acquisition and repeaters
The transmission chain is described by defining a list of NODE’s ID, from station to acquisition.
2.2.7 Proc’s parameters and data status
When associated with a PROC (see section 2.3.2), data from a NODE is used to produce outputs. Several additional parameters
must be defined for this.
Network code
A NODE can be associated with a standard network code, from the International Federation of Digital Seismograph Networks
(FDSN) 1. This is mostly the case for permanent seismological stations. This code is mandatory when using Arclink or Seedlink
data requests (see sections 3.14.1 and 3.14.1).
The list of network codes is also described at IRIS 2.
The official FDSN codes list can be overwritten using a local configuration file CONF/networkcodes.csv.
Raw format
A list of possible data format that overwrites, if selected, the RAWFORMAT parameter in the PROC/*.conf. This allows to
associate different data format/source to the NODEs associated to a single PROC.
1see http://www.fdsn.org/
2see http://www.iris.edu/ds/nodes/dmc/services/network-codes/
12 CHAPTER 2. REFERENCE
Raw data source
A free text string that overwrites, if not blank, the RAWDATA parameter in the PROC/*.conf. This allows to associate different
data format/source to the NODEs associated to a single PROC.
FID
A FID code is a short string which may contain a functional code (or a coma-separated list of codes) that will be used by
associated PROCs. For example, it can be the official station code for a seismic station or a GNSS receiver, while the data
files will contain this code. It is generally set to the same string as the ALIAS.
Some PROCS are able to deal with a coma-separated list, as gnss: this allows to define multiple codes pointing to different
data, and associate them to a single station.
FID *
Some raw formats may need additional codes or parameters to process data from the NODE. It is possible to define specific
parameters with the prefix FID : they will be listed and editable below the main FID. Creation/edit of a FID SUBNAME is
reserved to USERS with administrator level.
Time zone
Time zone is the offset delay from UTC, expressed in hours. Examples: +0 is UTC, −4is Lesser Antilles time.
Acquisition period
Acquisition period defines the normal time interval between two data sample, expressed in days. Examples: 1/24 corresponds
to 1 sample per hour, 1/86400 is 1 Hz sampling. This value might be used to compute average acquisition performance rating
(see below).
Acquisition delay
This value defines the maximum delay allowed between the last available data and the present time, expressed in days. This
delay is used to determine the NODE’s status (see below).
Status and link to data
If the associated PROC is set to compute the NODE status, the following information is displayed:
•last status check timestamp;
•sampling rate performance (in %): number of valid samples over the last time period, compared to theoretical acquisition
period (see above);
•status (in %): existence of valid samples in the last time delay for all channels.
The status informations are displayed in the main GRID’s table in front of the corresponding NODE.
If the associated PROC produces output graphs, direct links to each outputs are available.
Channels parameters (calibration file)
For most of PROCS, it is mandatory to define a list of data channels. This can be done through a “calibration file” that
contains description and detailed parameters of the NODE’s data channels: date and time of validity, name, unit, S/N,
2.2. NODES: ELEMENTARY WEBOBS OBJECTS 13
functional code, gain and multiplier factors, offset, min/max values, sensor azimuth, location and depth, sampling frequency,
digital dynamic and “location code” (SEED standard). Each channel must have one or more series of parameters.
The date and time of validity applies until real-time or next line of parameters for this channel number.
Each PROC might be associated to a selection of channels. Active channels appear in bold font, while inactive appear in
gray.
2.2.8 Features
Each NODE can have user-defined features which are free text contents (HTML and Wiki syntax allowed) that appear in the
main table as a series of table cells.
List of user-defined features
Feature name is limited to short names and must avoid special characters. Edit the list of features to be displayed using the
NODE configuration form. Features with void content won’t be displayed for USERS without edit or admin rights.
Node-features-nodes association list
It is possible to associate a NODE’s feature to an other NODE as its feature’s children. An automatic link will be displayed in
the feature’s table cell before the text content of the feature. In the children NODE page, the parent feature will appear with
automatic name ”feature of” and a link to the parent NODE.
Configuring the node2node association list is made by editing a configuration file containing a 3-field definition (pipe delim-
ited):
nodes2nodes.rc (excerpt)
PARENT_NODEID| fea tu re name | CHI LD RE N_ NO DE ID
2.2.9 Installation, information and access
These 3 fields are free-length text content. Wiki syntax allowed.
2.2.10 Photos, diagrams and associated documents
Three different types of documents can be uploaded and associated to a NODE:
•Photos: any JPEG file that will be displayed as thumbnail with a link to full screen mode;
•Diagrams: any image or picture file (JPEG, GIF, PNG, PDF, ...) that will be displayed as thumbnail with a link to the
full resolution image;
•Documents: any file (PDF, DOC, TXT, ...) that will be downloadable and sometimes displayed through the navigator.
2.2.11 Project
A NODE may have one (and only one) PROJECT description: a free-length text file, accepting MultiMarkDown syntax, a list
of users and possible associated photos. Project is a special EVENT without date.
2.2.12 Events
A NODE can be associated to dated events. A NODE event has following characteristics:
•start date and time;
•end date & time;
•a title;
•a content of free-length text,
•author(s) from the list of WebObs users;
14 CHAPTER 2. REFERENCE
•selected feature (from the node’s feature list);
•sensor/data outcome flag;
•notebook number (optional);
•notebook forward flag (optional);
•associated photos (image files).
An event can include one or more sub-events (children). Event files accept the MultiMarkDown syntax. See EVENTS
LOGGING section (2.4) for a description of Nodes and Grids events coding.
2.3 Grids: networks of nodes
A GRID is a group of NODES. Each NODE can be associated to one or multiple GRIDS. There is two kind of GRIDS:
•A VIEW is a list of NODES we simply want to group to be seen or accessed together,
•A PROC is a list of NODES associated to a common data processing that produces outputs (graphs and/or elaborated
data), and/or optional editable data FORMS.
GRIDS are presented through a sorted table allowing access to dedicated page for each GRID with:
•purpose (text content);
•specifications: operator owner, number of NODES, type, optional external link;
•list of NODES: a complete table with alias, names, location, start/end dates, type, project, status (for active PROC);
...
•an interactive location map (if NODES have location coordinates);
•informations (text content);
•references (text content);
•a graphical representation of NODES links with associated GRIDS.
Text content sections are editable with Wiki syntax possibilities.
GRIDS.rc
= ke y | va lu e
# tit le for de f ault " al l g rids " dis p lay ( l i s tGRID S . pl )
SHOW_GRIDS_TITLE| Gri ds
# gri ds t able opt i ons
SHOW_TYPE|Y
SHO W_ OW NER |Y
# nod es t able opt i ons
DEFAULT_COORDINATES|latlon
DEFAULT_NODES_FILTER| all
DEFAULT_PROJECT_FILTER| on
# ===== do not edi t bel ow this line === ==
# ( p ar am et er s only for ba ck wa rd compa ti bil y purpo se )
CGI_SHOW_GRID| s how GRI D . pl
CGI_SHOW_GRIDS| list GRIDS . pl
PAT H_ GR IDS | $WE BOBS { RO OT _D AT A }/ GRIDS
SPATH_INTERVENTIONS|EVENTS
SPATH_PHOTOS|PHOTOS
SPATH_DOCUMENTS| DOC UM ENTS
SPATH_SCHEMES|SCHEMAS
SPATH_FEATURES| FEA TU RE S
SPATH_THUMBNAILS| THUM BN AILS
PATH_EVENTGRID_TRASH| $WE BO BS { R OOT_D AT A }/ t rash / E VN TRASH
DESCRIPTION_SUFFIX|_description.txt
PROTOCOLE_SUFFIX| _ pr oto col e . tx t
BIBLIO_SUFFIX| _ bi bli o gr ap hy . tx t
2.3. GRIDS: NETWORKS OF NODES 15
2.3.1 Views
A VIEW is a simple group of NODES. To create a new VIEW, go to any GRID table page (menu GRIDS, VIEWS or PROCS)
and click on the edit icon in the Name header of table, enter an unique short name and click Edit. This will open the
GRID configuration editor. The form allows to freely edit the parameters file (key/value pairs), to select the Domain and to
associate/disassociate NODES.
VIEW.DEFAULT template
= ke y | va lu e
# G e ne ri c V IE W t em p la te fo r u se w it h cgi - b in / f or mG R ID . pl
NAME| Gen er ic Vie w
OWNCODE|?
TYPE|
UR L | ht tp :/ / myv ie w . or g
COPYRIGHT|MyView
# n ode p ar am ete rs ( d is pl ay and map s )
NODE_NAME| no de
NODE_MARKER|^
NODE_SIZE| 15
NOD E_ RGB | re d
NODE_FONTSIZE| 12
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
DEM_SRTM1| NO
All the following parameters are valid for GRIDS, that is any VIEW or PROC (see the next section).
GRID name and attributes
•NAME: Character string for the GRID long name. This name will appear in the GRID page and maps of NODES.
•OWNCODE: Character string for the GRID’s owner name. This name will be displayed in the GRIDS tables and GRID
summary, if SHOW OWNER key is true in GRIDS.rc. For backward compatibility, the key might contains a short code with
corresponding long names in CONF/OWNERS.conf.
•TYPE: Character string giving a short attribute to the GRID, if SHOW TYPE key is true in GRIDS.rc.
•URL: Optional URL related to the GRID. Any valid URL is allowed, e.g. an external web link.
•COPYRIGHT: Optional character string for the copyright of the GRID.
NODES attributes
•NODE NAME: Short name of a generic NODE. This name will be used instead of “node” in tables and maps.
•NODE MARKER: Type of marker used to plot NODES on maps. See valid markers in table 5.3.
•NODE SIZE: Size of the NODE marker for maps (in points).
•NODE RGB: Color of the NODE marker for maps: it can be a color name string (see CODE/matlab/htm2rgb.m for a
list of standard colors), or a vector of 3 scalars (red,green,blue), each value between 0 and 1.
•NODE FONTSIZE: If not empty, font size to display NODE’s alias names on maps besides the marker.
Digital Elevation Model (DEM)
By default, WebObs will use SRTM/ETOPO global topographic database to plot maps of NODES. It is possible for each
GRID to define a specific DEM which might be more accurate or more appropriate to make maps.
•DEM FILE: is not empty, must be an absolute path filename. The file must be in Arcinfo format using latitude/longitude
coordinates and elevations in meters, by default.
•DEM TYPE: when set to UTM, considers the file in UTM projection (eastern/northern coordinates). The conversion might
take some time for large DEM, so latitude/longitude DEM is still preferred.
•DEM FORCED: by default, if the area to be plotted is larger than the user DEM limits, the DEM will be ignored. When
set to YES, this option forces the use of user DEM. This might lead to NaN gray areas on the map.
•DEM COPYRIGHT: optional character string for DEM copyright.
•DEM SRTM1: if no user defined DEM is set nor valid, set to YES to use SRTM1 (30m resolution) DEM instead of default
SRTM3 (90m).
16 CHAPTER 2. REFERENCE
The standard behavior of WebObs for DEM loading is, by order of priority:
1. use of user defined DEM if set and valid;
2. if DEM SRTM1 is true and number or tiles does not exceed SRTM1 MAX TILES value in WEBOBS.rc (default is 4 tiles),
then loading SRTM1 30m resolution DEM;
3. if number or tiles does not exceed SRTM MAX TILES value in WEBOBS.rc (default is 25 tiles), then loading SRTM3
90m resolution DEM;
4. if ETOPO1 database has been properly installed and configured (see PATH DATA DEM ETOPO in WEBOBS.rc), then use
of ETOPO1 1.8km resolution global DEM;
5. last, use of ETOPO5 9km resolution DEM (included in the WebObs distribution).
2.3.2 Procs
A PROC is a list of NODES that are associated to a specific and common data processing called SUPERPROC. It has the
same basic parameters as VIEWS (see previous section 2.3.1) plus additional settings that depend on the process you want
to achieve. WebObs proposes some built-in SUPERPROCS (see chapter 3), each of them are specific. There is on default
SUPERPROC called ’genplot’ which is a simple plot of time series data (see section 3.4).
To create a new PROC, go to any GRID table page (menu GRIDS, VIEWS or PROCS) and click on the edit icon in the Name
header of table, select “PROC: Generic time series” in the Grid type list, enter an unique short name and click Edit. This
will open the PROC configuration editor. The form allows to freely edit the parameters file (key/value pairs), to select the
Domain, optional FORM and to associate/disassociate NODES.
2.3.3 Forms
A FORM is a web interface for manual data input, edit, display and export. A FORM is an optional tool of a PROC that
defines a specific database format that contains data from associated NODES. Some SUPERPROCS are working specifically
with FORM databases.
2.3.4 Project
A GRID may have one (and only one) PROJECT description: a free-length text file, accepting Wiki syntax. Project is a special
EVENT, see EVENTS LOGGING for a description of Project.
2.3.5 Events
A GRID can have events: free-length text files with timestamp. An event can include one or more sub-events (children). Event
files accept the Wiki syntax. See EVENTS LOGGING section for a description of Nodes and Grids events.
2.4. EVENTS LOGGING 17
2.3.6 TMap: GRIDS diagram
2.4 Events Logging
Nodes and Grids can have EVENT. These events are free timestamped text files (Wifi syntax being supported), editable
by users having at least Write authorization on the corresponding Node or Grid. Events live in specific repositories (known
as INTERVENTIONS), and are managed thru functions of the CODE/cgi-bin/WebObs/Events.pm module and CODE/cgi-
bin/vedit.pl . Their filenames reflect both their Node or Grid membership and their timestamp.
An event may also have attached images (PHOTOS) and/or sub-events: both are collectively referred to as EVENT EXTEN-
SIONS. Subevents are themselves events, thus building up a tree structure for each event.
Events base directories (interventions)
$GR IDS { PAT H_ GR ID S }/ g ridty pe / g ri dn ame / $GR IDS { SPAT H_I NTE RVE NTI ON S }/
$NO DES { PAT H_ NO DE S }/ n odena me / $ NODE S { SPA TH_ INT ERV EN TIO NS }/
Events ’trash’ directories (for deleted events)
$NODES{PATH_EVENTNODE_TRASH}
$GRIDS{PATH_EVENTGRID_TRASH}
Events files and extensions naming conventions
eve n t_fi le : = even t . tx t
event_extensions := ev ent /
event : = n am e_ YY YY - MM - DD _HH - MM { _v } | n am e_ YY YY - MM - DD _N A { _v }
name := { g ridn ame | no dena me }
v:= so - calle d vers ion number ( a u toma t icall y ge nera ted to make e vent name un ique )
NA : = " NA " f or u n kn ow n / un d ef in e d HH - MM
Special event file: the Project
on ly one allowed p er Node or Grid :
project_file : = na me_ Pro jet . tx t
Unfolded example for node NODEA INTERVENTIONS
$NO DES { PAT H_ NO DE S }/ NOD EA / $NO DES { S PA TH _I NTE RVE NTI ONS }/
NODEA_Projet.txt
NODEA _20 01 -01 -01 _20 -00. txt E ven t 2001 -01 -01 _20 -00 f ile
NODEA _200 1 -01 -01 _20 - 00/ Event 2001 -0 1 -01 _20 -00 e xt en si on s
PHOTOS / Event 2001 -01 -01 _20 -00 photos
18 CHAPTER 2. REFERENCE
*. [ jpg , p df ]
THU MB NA ILS /
NODEA _20 02 -02 -02 _02 -02. txt sub Even t 2002 -02 -0 2 _02 -02
NODEA _20 02 -02 -02 _02 -02/ s ubE vent 2002 -02 -02 _02 -02 e xten sion s
PHO TOS / sub Ev en t 200 2 -02 -02 _02 -02 phot os
*. [ jpg , p df ]
THU M BNAI LS
NODEA _20 03 -03 -03 _03 -03. txt sub subEve nt 2003 -03 -03 _03 -03
NODEA _20 10 -02 -02 _22 -30. txt E ven t 2010 -02 -02 _22 -30
2.5 Web pages
2.5.1 Main menu
2.5.2 Home page
2.5.3 Wiki pages
2.5.4 Tools pages
2.5.5 Application pages
Chapter 3
Built-in applications
3.1 The Gazette
3.1.1 Overview
The GAZETTE is the observatory’s logbook and calendar. It is a collection of articles in a relational DB table. An article is
defined by:
•a Start and an End timestamp,
•a Category (from a predefined/editable list),
•a list of Users (WebObs-registered and additional),
•a Place,
•a Subject.
The GAZETTE has its own html interfaces for visualization and edition, implemented in CODE/cgi-bin/WebObs/Gazette.pm
and CODE/cgi-bin/Gazette.pl modules.
3.1.2 Configuration
The GAZETTE is defined by a configuration file, whose location is pointed to by the main WebObs configuration variable
GAZETTE CONF.
Among other parameters, GAZETTE CONF file points to the Gazette DataBase (DB NAME) and the Gazette categories
definitions (CATEGORIES FILE).
The GAZETTE also uses the WebObs authorization mechanism with one resource associated to each category, plus one
generic resource representing all categories. These resources belong to the authorization ’misc’ type (authmisc table), and are
identified as ”GAZETTEcategoryKey ” (eg. GAZETTEMissions, GAZETTEField).
WEBOBS.rc (excerpt)
GAZETTE_CONF| $ { R OO T_ C ON F } / G az e tt e . rc
Gazette.rc
= ke y | va lu e
DB_NAME| $WE BO BS { P AT H_ DA TA _D B }/ G az ette .db
CATEGORIES_FILE| $WE BO BS { R OO T_ CO NF }/ G aze tte _cat ego ries . conf
BANG|2001
TITLE |Gazette
FUTURE_YEARS|2
ACT IV E_ GID |DUTY
EMPTY_SELECTION_MSG| No m at ch fo un d
CALENDAR_WEEKNUMBER| VER TI CAL
SHOW_BYDATE_ONGOING|TEXT
CALENDAR_TRUNCLENGTH| 25
DEFAULT_VIEW| cal en da r
DEFAULT_DATE| thi sw ee k
DEFAULT_CATEGORY|
19
20 CHAPTER 3. BUILT-IN APPLICATIONS
Gazette categories.conf
# Gaze tte a r ticle s categ o r ies
#
# - Key : valu e used by scrip ts , fo rms field s , database , ...
# AT T : a s in gl e wor d wit h NO sp eci al c ha ra cte r nor sp ac e
# AT T : r es er ve d k eys = " AL L "
# Key is also used as pre fix for au th or iz at io n resou rc e na mes ( GAZETT E_ ke y )
# - Nam e : lo ng na me for user i nterf a c e
# - RGB : col or of te xt dis pl ay ( HTM L / CS S f or ma t )
# - R GB light : c or re sp ond in g colo r u sed as backg ro un d
# - Aut o : c atego r y is a u tomati c ( n ot sele c t able in form )
# - F orma t : any s tring fr om : ndol , ndlo , ldon , dlon , andol , or adon
# encod in g fiel ds or de r of a ppear ance , w here :
# n = name ( opera t or ), d = date , o = c omment , l = p lace , a = othe rs
#
# A ll owed m odifica ti on s :
# - mod i fy Name , R GB or L evel val ues
# - add new keys
#
# Forbidden:
# - mod i fy / dele te e x istin g K eys ( or corre s p o n ding Key s must be u p date d in
# the da tab as e fil e )
# - dupli c a te r e serve d Keys , or dele te them
#
= Ke y | Name | RGB | R GB li gh t | Au to | F orma t
AL L | All | \# 0 00 00 0|\ # 7 F 7F 7F | 1
Duty| Duty S cien tist |\# EFC700 |\# F6E 27F |0| ndo l
Mis si ons | Staff M iss ions |\# D D55 55 |\# FFD4D4 |0| ndlo
Holiday| Off / Holi day | \# D D5555 |\# EDA9A9 |0| ndol
Field | Field work | \#00 BB00 |\#7 F DC7F |0| ldon
Meeting| Mee ti ng / O ffici al s |\#007 F7 F |\#7 F BEBE |0| dlon
Media | Med ias |\ #555 5 FF |\# D4D4FF |0| dlon
Out re ach | Outre ach |\# 5555 FF |\# D4D 4FF |0| dlon
Tea ch ing | Teach ing |\# 5555 FF |\# A9A 9FE |0| dlon
Visitor| Vi sito rs |\# B200FF |\# D87FFE |0| andol
Tra in ing | Stude nts Trai ning |\# B200 FF |\# FF 7FF F |0| adon
Bui ld ing | Bui ld ings | \# 77 77 77 |\ # CCF F66 |0| l don
Misc| Misc | \#7 777 77 |\# BA BA BA |0| dlon
Event | Eve nts |\# E D7C 3F |\# DE8F65 |1| ldon
The GAZETTE also includes holidays definitions that can be adapted to any country using a specifications file pointed to by
FILE DAYSOFF in the main WebObs configuration WEBOBS.rc .
WEBOBS.rc (excerpt)
FILE_DAYSOFF| ${ ROO T_ CO NF }/ H ol id ay s . conf
Holidays.conf (example)
# List of some i n t e rnation a l pub l ic h olida y s
#
# Confi gu ra ti on fil e read by subfu nc ti on " r eadFer ie s " in W ebObs :: Dat es
# Fi le defin e d by the WEBO B S .rc key FILE_D A Y S OFF
#
# - EXP : e x p ressio n us ed by the Li nux funct i on ’ date - d " EXP "’ to d e t ermin e the d ate
# with pos si ble p ar am eters :
#$Y = c urren t year
#$PQ = E aste r Su nday
#$PQ n = n d ays fr om East er S unda y
# - Name : n ame of the d ay
#
#
# EXP | N am e
$Y -01 -0 1 | New Y ea r
$PQ 1|Easter Monday
$P Q 39 | A sc en sion
$P Q 50 | P en te cost Mon day
$Y -08 -1 5 | Assomp tion
$Y -11 -0 1 | All S ain ts ’ Da y
$Y -12 -2 5 | Chris tm as
3.1.3 Display/Edit Gazette
CODE/cgi-bin/Gazette.pl is the html interface used to request and display the Gazette. The greyed banner of the page is a
selection form used to specify what and how Gazette articles should be displayed:
•What : Date or Date-range selection
– via a monthly calendar
– using predefined periods
•What : Category and Filter
3.2. GRIDMAPS AND LOCASTAT: MAPS OF GEOREFERENCED NODES 21
Figure 3.1: Examples of GRID’s maps created by GRIDMAPS.
•How : Presentation
– Calendar: a calendar-type weekly table,
– List by categories: a list sorted by categories,
– List by date: a list sorted by chronological start-date,
– iCalendar: iCal format text,
– dump: reserved for administrators, raw DB-table display
The banner also displays a ’Create Article’ button to trigger the edition of a new article.
Note: ’Event’ category is not editable through html interface.
Developer’s note: A Gazette display html code can also be imported into other pages using the WebObs/Gazette.pm Show
function. See description in Gazette.pm perldoc and Welcome.pl page as an example.
3.2 GRIDMAPS and LOCASTAT: maps of georeferenced nodes
3.2.1 Overview
Any NODE may be associated with a location with geographic coordinates. A PROC might use these coordinates for a specific
processing, e.g. for tilt or gnss deformation modelling, or to produce dedicated maps. There is also two built-in applications
that will use these coordinates: GRIDMAPS and LOCASTAT.
3.2.2 GRIDMAPS
When a NODE is associated to a GRID, WebObs will automatically produce maps indicating these NODES.
Configuration
Each GRID map is depending on two configuration files: one is common for all grids to define the basemap parameters:
GRIDMAPS.rc
= ke y | va lu e
22 CHAPTER 3. BUILT-IN APPLICATIONS
NAME|Networks
# --- ba semap opti o ns
# p aper size ( m ax imum wid th / heig ht )
PAPERSIZE_INCHES| 10
# dens ity ( in pix els per i nch ) for P o stScri p t to PN G c o n verti o n
DP I | 100
# b ase ma p DEM re nde ring opti ons ( see C OD E / ma tla b / de m .m d ocum entat ion )
LINEWIDTH| 1. 5
LANDCOLORMAP| land color
SEACOLORMAP| seac olor
COLOR_LIGHTENING|2
LIGHT_AZIMUTH| -45
LIGHT_CONTRAST|1
# overs a m p ling in case of too s mall ima ge
OVERSAMPLING| 50 0
# mini mum size of map a roun d NO DES
MIN_SIZE_KM|1
# maxi mum X/Y ra tio in c ase of a u tomat i c si z ing arou n d N ODES
MAX_XYRATIO| 1.5
BOR DE R_ ADD | 0. 1
DEM_SRTM1|N
# --- co ntour lin es
CONTOURLINES|Y
CONTOURLINES_RGB|.5,.5,.5
CONTOURLINES_MINOR_LINEWIDTH| .1
CONTOURLINES_MAJOR_LINEWIDTH|1
CONTOURLINES_LABEL|Y
# adds t r a nsmiss i o n l ine s betwe e n NOD ES ( if def ined )
PLOT_TRANSMISSION| Y
# list of GRI D keys ava i lable fo r edi t in re q uest
REQUEST_GRID_KEYLIST| NOD E_SI ZE , NODE_ RGB , N OD E_ FO NT SI ZE , N ODE _M ARK ER
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } g ridma ps -
SUBMIT_RESOURCE| gri dm aps
and the other is the configuration file of the GRID itself to define the parameters associated to NODES (see for example the
VIEW example in section 2.3.1).
Activation
GRIDMAPS is set by default when installing WebObs . It should be active at the first scheduler start. Parameters are as
follows:
jid: gridmaps
res: gridmaps
xeq1: $WEBOBS{JOB MCC}gridmaps
interval: 86400
logpath: gridmaps
valid: Y
You may check if it runs correctly in the Scheduler Runs page (see Section 4.3).
3.2.3 LOCASTAT
The location map appears in each NODE page if coordinates are defined. The map is automatically made and updated by
LOCASTAT application. Maps are updated when the map timestamp is older than NODE’s configuration file. So to force
the update of a location map, you may modify any parameter in the NODE configuration, typically the coordinates values or
positioning date.
The map contains 4 maps at different scales, all centered on the NODE position, from left to right with a progressive zoom
effect. Basemaps are built from the free worldwide topography data SRTM 1and specific colormap and rendering methods. It
is possible to specify a user-defined DEM (Digital Elevation Model) for the highest resolution scale map (right frame).
LOCASTAT.rc
= ke y | va lu e
# - -- wide - s ca le l eft fram e
FRAME0_WIDTH_KM| 10 0
# in term edia te - sca le middle - to p fra me
1see http://www2.jpl.nasa.gov/srtm/
3.3. SEFRAN3/MC3: SEISMIC CHART AND BULLETIN 23
Figure 3.2: Example of NODE’s map created by LOCASTAT.
FRAME1_WIDTH_KM| 30
FRAME1_SCALE_KM| 10
# - -- inte rmedi at e - sca le middle - b ottom fra me
FRAME2_WIDTH_KM|5
FRAME2_SCALE_KM|2
FRAME2_RESAMPLING| 200
# - -- high - r es olut i on rig ht fra me ( in U TM )
FRAME3_WIDTH_KM| 1. 5
FRAME3_SCALE_KM| .5
FRAME3_RESAMPLING| 400
FRAME3_SRTM1| NO
# - -- optio na l user - d ef ined DEM f rame ( righ t ) => a pp li es to a ll node s
# DEM grid file na me ( A rc Info f ormat )
FRAME3_DEM_FILE| $ WE BO BS { P AT H_D ATA _DE M } / e xa mp led em . as c
# DE M c o o rdinat e sys tem : U TM or L ATLON
FRAME3_DEM_TYPE| UT M
COP YR IG HT2 | MyD EM
DP I | 80
LINEWIDTH| 1. 5
COL OR MAP | lan dc olor
COLOR_LIGHTENING| 1. 2
LIGHT_AZIMUTH| -45
LIGHT_CONTRAST|1
SEA CO LOR | [0. 7 ,0.9 ,1]
PLOT_TRANSMISSION| Y
3.3 SEFRAN3/MC3: seismic chart and bulletin
3.3.1 Overview
The SEFRAN3 is a graphical interface to operate seismic data flux, manual and semi-automatic detection of events, and
earthquake catalog bulletin management.
The name “SefraN” is a contraction of Sefram Num´erique; it comes from a 70’s paper strip-chart recording instrument from
the French factory SEFRAM R
, used during decades in French observatories. Starting 2001, the system has been replaced by
a numerical simulation using local data files archives in SUDS format. SEFRAN3 is the third version of SefraN which now
uses data flow from SeedLink protocol.
A second tool called “Main Courante” hereafter named MC3, is a database of seismic events that is linked to SEFRAN3
interface and possibly to external earthquake catalogs like a local SeisComP3 or any FDSN-webservice compatible database
like EMSC or USGS.
24 CHAPTER 3. BUILT-IN APPLICATIONS
Real-time
LATENCY_SECONDS
UPDATE_HOURS
DATASOURCE (delay)
frozen
archive archive update
DATASOURCE (protocole2)
realtime update
DATASOURCE (protocole1)
BROOMWAGON_DELAY_HOURS (1)
BROOMWAGON_UPDATE_HOURS
BROOMWAGON_DELAY_HOURS (2)
BROOMWAGON_UPDATE_HOURS
Figure 3.3: Schematic diagram of SEFRAN3 main parameters.
The SEFRAN3 works with a fixed selection of channels (up to 15) coming from a single server source, that will be displayed
together as time series using 2 different time scales (normal and high) that simulate the paper speed. SEFRAN3 has 4 different
GUI:
1. Main page showing hourly thumbnail images of seismic signals for a given period of time. Identified events are shown
as overlaying colored tags. Bottom part of the page is showing realtime state of each channel with some statistics on
the data quality. There is two display modes:
•real-time automatic refreshing page, for the last X hours/days of data;
•any date selection for one or more days.
2. One hour display of full-resolution image in a wide window that can be spanned and scrolled through time.
3. A form showing a single event at high-speed time resolution of seismic signals, with possibility of editing data and
submitting to the database.
4. A detailed table of events list with date selection, filters, and dynamic graphs.
Notice: SEFRAN3 is using extensively the network connection (for data flux) and external programs like arclink fetch (from
SeisComP3), slinktool (from IRIS) and convert (from ImageMagick). If you experience any trouble, check first the network,
the data availability on servers, and the third-party programs. You might add the variable DEBUG|Y in the configuration file to
make the logs more verbose.
3.3.2 SEFRAN3 installation
SEFRAN3 is based on 1-minute images of seismic traces. It works within a loop that will end after a minimum duration run.
Each loop will scan the existing images on disk, and make new images (real-time first, then look at older periods for gaps) or
update them using broom wagons that check the data completeness after some time delay. There is also a short delay of few
seconds to take into account the data flux lateness from real-time, and a longer delay to switch from SeedLink data request
(convenient for real-time data flux) to ArcLink data request (convenient for archived data). Figure 3.3 is a summary of main
parameters.
Configuration files
To configure a new SEFRAN3, copy the template files SEFRAN3.conf and SEFRAN3 Channels.conf to, for example,
MYSEFRAN.conf and MYSEFRAN Channels.conf.
MYSEFRAN Channels.conf file sets the channel list. Each channel is defined by its alias (a short code used for display), the
stream string (used for the data request), the sensitivity factor (to convert counts to m/s), the filter (median, trend or spline
removal), the peak-to-peak signal amplitude, and the color. A good conduct is to order the channels from North to South,
and give different colors for specific regions. There is no limit to the number of channels, but a maximum of 15 channels is
recommended for a normal screen resolution.
MYSEFRAN.conf file is the main configuration file. It defines a lot of things like output paths, server address and all
parameters of graphical outputs and SEFRAN3 behavior.
SEFRAN3 Channels.conf
# SEFR AN3 t e mplat e chan n nel file
#
3.3. SEFRAN3/MC3: SEISMIC CHART AND BULLETIN 25
# Defin i t ion of t he SEFR A N3 c h annel s :
# - Ali as : chan n el ali as code ( for dis p lay )
# - Str ea m : cha nn el str eam full n ame ( Netwo rk . S tati on . LocI d . Chan ne l )
# - S en s it i vi t y : s en s it i vi ty f ac tor ( in c oun ts pe r m / s)
# - Filte r : app l yes a fi lter to the si gnal :
# [ X ]: c ons t an t o ff set val ue [ X ] ( in c oun t )
# med ia n : m ed ian v alue correc ti on ( f or me rl y ’ auto ’)
# tre nd : line ar det re nd corr ect io n
# sp [ X ]: s pl ine f il te r u si ng [ X ] s ec ond s i n te rva l p oin ts
# ([ X ] is a p osi t iv e i nte g er )
# [ ft ][ fn ] [ N ] ,[ F ] , [ S ]: d i gi t al fi l te r s
# ft = ’ lp ’ ( l owpass ) , ’ hp ’ ( h ig hpass ) ,
# ’bp ’ ( b an dp ass ) or ’ bs ’ ( b an dstop );
# fn = ’ bu ’ ( B ut te rw or th ), ’ be ’ ( Bess el ) ,
# ’c1 ’ or ’ c2 ’ ( Ch ebyshe v ty pe I or II );
# N = p os it iv e int eg er ;
# F = f r eq u en cy ( in Hz ) , u se [ FL , F H ] f or ’ bp ’
# and ’bs ’ typ e ;
# S = s t op ban d at t en u at i on / r ipp le ( in dB ) for
# C he bys hev only .
# - PP : d ef ine th e s ign al a mp l it u de ( pe ak - to - peak , in m / s )
# - RGB : de fine the si gnal col or ( HT ML for mat : he xa or sta n dard na me )
# A T T ENTIO N : for he xa form at use double - qu ote "# FF0 000 " to a voi d co m ment !
#
#
# Ali as S t ream Sensi t i vity Filt e r PP RGB
CO YC G . COYC .00 . LH Z 5.9 44 420 E +0 9 hp bu3 , 0. 2 5 e -5 " # 008 80 0"
FD F G . FD F .00 . LH Z 2 .51 65 80 E +0 9 m ed ia n 5e -5 " # 00 88 00 "
SS B G . SS B .00 . LH Z 5 .97 78 20 E +0 9 m ed ia n 5e -5 " # FF 00 00 "
MB O G . MB O .00 . LH Z 4 .99 83 80 E +0 9 m ed ia n 5e -5 " # FF 00 00 "
NO UC G . N OUC . 00 . LH Z 5.9 31 53 0 E +09 m ed ia n 5e -5 " # FF0 000 "
# NOUC G. NO UC . 00. LHZ 5.93 15 30 E +09 h pbu3 , 0.2 5e -5 "# F F0 00 0 "
PP TF G . P PTF . 00 . LH Z 5.6 80 76 0 E +09 m ed ia n 5e -5 " # FFA 500 "
# PPTF G. PP TF . 00. LHZ 5.68 07 60 E +09 h pbu3 , 0.3 5e -5 "# F FA 50 0 "
RE R G . RE R .00 . LH Z 5 .64 38 60 E +0 9 m ed ia n 5e -5 " # FF A5 00 "
TA M G . TA M .00 . LH Z 3 .88 56 00 E +0 9 m ed ia n 5e -5 " # 00 00 88 "
UN M G . UN M .00 . LH Z 5 .61 54 90 E +0 9 m ed ia n 5e -5 " # 00 00 88 "
SEFRAN3.conf
= ke y | va lu e
############################################################
# SEFR AN3 c o n f igurati o n fi le
############################################################
TITRE | S EF RAN3 : GEO SC OP E W orld Sei sm ic it y
BANG|2014
ROOT| $WE BO BS { S EF RAN_R OO T }/ sefr an3
CHANNEL_CONF| $WE BO BS { ROOT _C ON F }/ SEFR AN3 _C han ne ls . conf
CS S | SE FRAN3 . cs s
BIGARROWS| YE S
PAT H_ WEB | $WE BOBS { SEF RA N_R OO T_A LI AS }/ sef ra n3
PAT H_ TMP | / tmp / sef ra n3
# sub - d ir ecto ries : n ot m odif iabl e a ft er a f ir st run !
PATH_IMAGES_MINUTE|minute
PATH_IMAGES_HOUR|hour
PATH_IMAGES_HEADER|header
# --- Data s ourc e and f orma t
# c om bi ned f orma t : D AT AS OU RC E | pr ot ocole1 ; p ro to col2 ; delay
DAT AS OU RCE | sli nk :// $ { S EE DL I NK _S E RV ER } ; arc li nk : // $ { ARC LIN K _S ER V ER }? use r =$ { A RCL INK _US ER }; ${ A RC LIN K _D EL A Y_ HOU R S }
# n otes :
# pro toc ole 1 is re al - time d ata
# pro t ocole2 is arch i ved data
# de la y i s t im e lim it ( in h ou r ) to sw itc h f ro m p ro t oc ole 1 t o p rot o co l e2
# prot oc ol es can be slink , arclin k , fdsn ws or file ( minis ee d )
# examples:
# D AT AS OUR CE | sli nk :// r tse rv er . ipg p . fr : 18 00 0; arc li nk :// e ida . ip gp . fr : 18 00 1? us er = s ef ra n3 ; 12
# D AT AS OUR CE | sli nk :// r tse rv er . ipg p . fr : 18 00 0; fds nw s :// htt p :// rtpriv - cd d. ipgp . fr / fds nw s / data sele ct /1/ q ue ry ?;2
# late ncy d elay for r ealti m e d ata
LATENCY_SECONDS|${ SEE DL IN K_ DE LA Y_ SE CO ND S }
# s ee dL in k serv er : sou rc e of real - time dat a ( n ee ded to di sp la y the sta tus t able )
SEEDLINK_SERVER| rts erv er . i pgp . fr : 18 000
SEEDLINK_SERVER_TIMEOUT_SECONDS| 30
# f or b a ck wa r d c omp a tib i li t y o nl y ( t o be u se d f or de f au lt D AT A SO U RC E if ne ede d ) !
SEEDLINK_DELAY_SECONDS| 30 0
ARCLINK_SERVER| eida . ip gp . fr :18 00 1
ARCLINK_USER|sefran3
ARCLINK_DELAY_HOURS| 12
# cle a ns o v e rlaps in dat a st reams
CLEAN_OVERLAPS|1
# - -- Run - tim e param ete rs
# mov i ng t ime win dow whic h is p roces s e d
UPDATE_HOURS|6
26 CHAPTER 3. BUILT-IN APPLICATIONS
# m i ni mu m b ea t o f the m ai n loo p ( in s e co nd s )
BEAT|2
# minimu m loop runti m e befo re exit
MIN_RUNTIME_SECONDS| 60 0
# ma x imum numb er of p r ocess e d ima ges in a s i ngle run
MAX_IMAGES_IN_RUN| 10
# --- B r o omwago n : reproc e ss i m ages if needed , aft er a while
BROOMWAGON_ACTIVE| 0
# mini m um age ( s ) of an ima ge to be c o nside r e d ( in hou r )
# m ultip l e broo m w agon a llow e d in a coma - separ a t ed list
BROOMWAGON_DELAY_HOURS| 2 ,1 2
# time w indo w wh ich will be proce s s ed
BROOMWAGON_UPDATE_HOURS|1
# thre s h old p a r ameter s
BROOMWAGON_MAX_DEAD_CHANNELS|1
BROOMWAGON_MAX_GAP_FACTOR| 0.2
# ext ra s e conds of s igna l ne eded for f i lter s
FILTER_EXTRA_SECONDS|0
# - -- Assoc ia te d " Main C ou ra nte " ( seism ic bul le ti n )
MC3 _N AME | MC 3
MC3_EVENT_OPACITY| 0.4
DISPLAY_LAST_MC|2
DISPLAY_LAST_MC_HOURS| 1
# main p age ref r ech ( in real - time mode )
DISPLAY_REFRESH_SECONDS| 60
REF_NORTC|1
# max n umbe r of days ( in a page )
DISPLAY_DAYS|7
# --- Ma in graphi c al pa r a meters
# pixel - per - in ch fo r all PNG im ages out p ut
VALUE_PPI| 10 0
# im age heig h t ( in inc hes ): 7.8 m eans 780 pixe ls at 100 pp i
HEIGHT_INCH| 7.8
# eq u i valen t pap er spe ed in inc h es per minu te
VALUE_SPEED| 1.2
# p ap er h igh - s pe ed ( i n / mn )
VALUE_SPEED_HIGH| 4. 8
# inte rt ra ce : 1 mea ns no ove rlap , 0. 8 m ean s 20% ove rl ap
INT ER TR ACE | 0. 8
TRACE_LINEWIDTH|1
# to ob tain bett er PNG , i mage s are overs a m pled
PRINT_OVERSAMPLING_FACTOR|2
# l abe ls fo r m in ute - i ma ge ( in p i xe ls )
LABEL_TOP_HEIGHT| 23
LABEL_BOTTOM_HEIGHT| 55
XTICK_INTERVAL_SECONDS|1
XTICK_LABEL_INTERVAL_SECONDS| 10
# - -- Hou rl y thumbn ai ls ( s izes in pix el s )
HOURLY_WIDTH| 90 0
HOURLY_HEIGHT| 90
HOURLY_CONVERT_GAMMA| 0.4
LASTHOUR_WIDTH| 32 0
NOTES | $WE BO BS { P ATH _USE RS_ HTML }/ S ef ran 3 _N ot es . ht m
MENU_FILE| $ WE BO BS { P AT H_U S ER S_ H TM L }/ S ef ran 3_M enu . htm
TIME_INTERVALS_CONF| $WE BO BS { ROOT _C ON F }/ S EFR AN3 _Ti meI nt erv als . conf
TIME_INTERVALS_DEFAULT_VALUE|6
# chan nel s tatus thre s hold
STATUS_OFFSET_WARNING| 2
STATUS_OFFSET_CRITICAL|5
STATUS_NOISE_WARNING| 1e -6
STATUS_NOISE_CRITICAL| 5e -6
STATUS_DELAY_WARNING| 300
STATUS_DELAY_CRITICAL| 864 00
Activation
To activate the SEFRAN3, add a new job in the scheduler, for example with following parameters:
jid: mysefran
res: mysefran
xeq1: $WEBOBS{JOB MCC}sefran3
xeq2: MYSEFRAN
interval: 600
logpath: mysefran
valid: Y
3.3. SEFRAN3/MC3: SEISMIC CHART AND BULLETIN 27
After activation, check that it runs correctly in the Scheduler Runs page (see Section 4.3).
To access the main SEFRAN3 page, use the following URL (can be set for instance in the menu bar):
/cgi-bin/sefran3.pl?header=1&s3=MYSEFRAN
Further options are available to access all display possibilities. See perldoc CODE/cgi-bin/sefran3.pl.
3.3.3 MC3 configuration
MC3.conf
= ke y | va lu e
###############################################################################
# MC 3 Main Cou r ante c o nfigura t i o n para m eters
###############################################################################
TITLE | M ain Cou ra nte Sei sm ic ity
BANG|2014
ROOT| $WE BO BS { S EF RAN_R OO T }/ m c3
PAT H_ WEB | $WE BOBS { SEF RA N_R OO T_A LI AS }/ mc3
EVENT_CODES_CONF| $WE BO BS { ROOT _C ON F }/ M C3 _C od es . conf
DURATIONS_CONF| $WE BO BS { ROOT _C ON F }/ MC3_ Du ra tio ns . con f
AMPLITUDES_CONF| $WE BO BS { R OO T_ CO NF }/ M C3 _Am pli tud es . co nf
TABLE_HEADERS_CONF| $WE BOBS { RO OT _C ONF }/ MC3_ He ad er s . conf
PATH_SC3_QML|
PAT H_ TMP | $WE BOBS { SE FR AN _R OO T }/ tmp
PATH_TMP_WEB| $WE BO BS { S EF RA N_ ROO T_ ALI AS }/ tmp
PAT H_ FI LES | fil es
PATH_IMAGES|images
FILE_PREFIX| MC_
FRAME_WIDTH| 600
WINDOW_LENGTH_MINUTE|5
IMAGES_MAX_CAT| 60
# defa ult t able int e rval d ispla y ( in day s )
DEFAULT_TABLE_DAYS| 30
# l oc al t ime zon e : u sed onl y f or dat e / hour selec tio n ( d is pl ay and s ta tis tic s ) - dat a alw ay s rema in in U TC !
SELECT_LOCAL_TZ|0
DEFAULT_SELECT_LOCAL|N
NOTES | $WE BO BS { P ATH _USE RS_ HTML }/ M C3 _N ote s . ht m
FILTER_POPUP| $WE BO BS { P AT H_ US ER S_ HTM L }/ M C3 _F il ter _P op Up . htm
# e x terna l c atalo g vis it li nk ( for mely US G S_URL )
VIS IT _L INK | <A h re f = " ht tp : // ww w . ems c - cs em . or g / E a rt hq u ak e /" t ar ge t = " _ bl an k " > <B > E MSC </ B > </ A >
# VISIT _L IN K | <A hre f =" ht tps :// e ar th qu ak e . usgs . gov / e arthqu ak es / map " t arget =" _ blan k " >< B > USGS </B ></ A >
# U SG S_ URL | h tt ps :// e arth quak e . usg s . go v / ear thqu akes / map
AUTOPRINT|0
PRINTER|
CS S | MC3 . css
P_WAVE_VELOCITY|6
VP_VS_RATIO|1.75
# s et to 0 to k ee p th e S - P v alu e whe n c ha n gi ng P - p ha se
NEW_P_CLEAR_S|1
# de fault ampli t ude value for new even t : s ee MC3_A m p l itude . conf fo r valid key s
DEFAULT_AMPLITUDE|AVERAGE
# de fault ty pe val ue for new eve nt : se e MC3_Co d es . conf for v ali d keys
DEFAULT_TYPE|UNKNOWN
# s mall rul er pa ra me te rs ( o bs olete )
RULER_DISPLAY|0
RULER_LENGTH| 60
RULER_TICKS|5
RULER_TICKS_LABEL| 10
RULER_POS_DX|0
RULER_POS_DY| -50
# shakemaps
SHAKEMAPS|0
SHAKEMAPS_PATH| $WE BO BS { S EF RA N_ ROOT }/ B3
SHAKEMAPS_URN| $WE BOBS { UR N_ SE FR AN }/ B3
TREMBLEMAPS_PROC| B3
# Cit i es for ev ent l ocati o n
# --------------------------------------------
CITIES| $WE BO BS { ROOT _C ON F }/ C ities . conf
CITIES_PLACE| Guad el oupe
#for MC2 compatibilty
PATH_DESTINATION_SIGNAUX| $WE BO BS { S EF RAN_R OO T }/ A _D ep ou il le r
WEB_DESTINATION_SIGNAUX| $WE BOBS { SEF RA N_R OO T_A LI AS }/ A _D ep ou il le r
HYPO_USE_FMT0|
HYPO_USE_FMT1| $WE BOBS { OV PF HY P_ PA TH }
DISPLAY_LOCATION_DEFAULT|1
28 CHAPTER 3. BUILT-IN APPLICATIONS
LOCATION_MIN_PHASES|4
# === == S e isCom P 3 dat a base p a r ameter s === ==
SC3_EVENTS_ROOT| $WE BOBS { SE FR AN _R OO T }/ sc3_ ev en ts
# 4 - lett er prefi x of e v ents ID
SC3_EVENTS_ID_PREFIX|abcd
# time win d ow to scan n ew eve nts (in days )
SC3_UPDATE_DAYS| 15
SC3 _U SER | SC 3
# c om ma sep arat ed lis t of unw ant ed e vent typ es ( not im por ted in MC 3 )
SC3_EVENT_TYPES_BLACKLIST| not e xi st in g
# c omma s e parate d list of unwan t ed event typ es for disp l a ying loca t ion in MC3
SC3_EVENT_TYPES_NOLOCATION| ou tsi de of netw ork inte rest , not l ocat able
# wo2 s c3 m o dule param e ters
WO2SC3_HOSTNAME| loc al host
WO2SC3_PORT| 300 03
WO2SC3_MOD_ID|1
WO2SC3_MOD_TYPE|1
# = ==== FDS N WebSe r v ice eve nt par a m eters == ===
# Uses SC3_E V E N T_TYPES _ B L ACKLIST , S C 3 _ E V E N T _ T Y P E S_NOLOCATION and SC3_U P D A T E_DAYS
# D efa ul t s er ve r ( w hen onl y o ne )
FDSNWS_EVENTS_URL| h tt ps :/ / e ar thq ua ke . usg s . gov / fds nw s / eve nt /1 / q uery ?
# We b Servic e opti ons for cata log sear ch : a rea of interest , ma g n itude of in t erest
FDSNWS_EVENTS_SEARCH|minmagnitude=6
# WebSe r v ice o p tion s for event d e tail s retr i e val : inc lude a rriva l s
FDSNWS_EVENTS_DETAIL| i nc lud eal lma gnit ude s = false & i nc lu dea ll ori gin s = fal se
# Extra EM SC FDSN even ts s erve r ( may h ave m ore th an one )
FDSNWS_EVENTS_URL_EMSC| ht tp s :// e ar th qu ak e . us gs . gov / fd snws / eve nt / 1/ q uery ?
# We b Servic e opti ons for cata log sear ch : a rea of interest , ma g n itude of in t erest
FDSNWS_EVENTS_SEARCH_EMSC|minmagnitude=5&maxmagnitude=6&minlatitude=11&maxlatitude=19&minlongitude=-64&maxlongitude=-59
# WebSe r v ice o p tion s for event d e tail s retr i e val : inc lude a rriva l s
FDSNWS_EVENTS_DETAIL_EMSC| i nc lud eal lma gnit ude s = false & i nc lu dea llo ri gin s = fal se & i nc lu dea rr iva ls = true
MC3 Codes.conf
# WEB O BS
# Confi gura tion fil e for sei sm ic bulle ti n " Main Co ura nt e "
#
# In put to mc3 . pl and sefr a n3 .pl , to def i ne e vent s .
#
# ke y = Event - ty pe co de as recor d ed in file s
# [ Note : UN K NOWN and AUTO ar e R ESERV E D k e yword s ]
#
# Nam e = Ful l text of event - type as p resen t e d to user
#
# Color = A ss oc ia te d colo r in d is play / gra phs ... html hexa forma t # R RG GBB
#
# Md = how to comp ute d u rati o n magn i tude :
# 1 = requires duration and S-P
# 0 = r e quire s dura t ion onl y ( as sumes S - P = 0 if not def i ned )
# -1 = nev er c omput e
#
# asV T = weth er even t is c o unte d as VT in sei smic bulle t in
# 1 = yes
# 0 = no
#
# asR F = weth er even t is c o unte d as roc k fall in seis m ic b ullet i n
# 1 = yes
# 0 = no
#
# L ocat i o n = weth er l o catio n in fo will be d ispla y e d
# 1 = yes ( ex cept if SC 3 type in the S C 3 _ E V E N T _ T Y P E S _NOLOCATION l ist )
# 0 = no
#
# WO2S C3 = weth er S e isComP 3 eve n tID c r eatio n is c heck e d
# 1 = yes
# 0 = no
#
= ke y| Na me | Col or | B gC ol or | Md| as VT | asR F | Lo ca ti on | WO2 SC 3
#
UNKNOWN| Unk no wn e vent | \# 53 53 53 |\# FF FFFF | -1| 0|0|1|1
VOL CT ECT | Volca no - Tec toni c |\# FA8072 |\# FFFFFF | 0|1| 0|1| 1
VOLCLP| Vo lcan ic Long - Perio de |\# DC 143C |\# FFFFFF |0| 0|0|1 |1
VOL CT RE MOR | Volca nic Tre mor |\# F F45 00 |\# FFFFFF | - 1|0 |0| 1|1
ROC KF ALL | Rockf all / La ndsl ide |\#8 B4513 |\# FFFFFF | -1|0|1|0|1
TECT| Te cton ic |\# 228 B22 |\# FFFFFF |1| 0|1|1 |1
TELE| Te lese ism |\# AD FF2 F |\# FFF FFF |1| 0|0| 0 |0
TPHASE| T - Ph as e | \# 46 82 B 4 |\ # F FF F FF | - 1| 0| 0| 0 |0
SOUND | S ou nd |\#7 F FFD4 |\# FFF FF F | -1| 0| 0|0| 0
ANTHROP| An t hropo genic | \# F FD700 |\# FFFFFF |1| 0|0| 1|0
AUTO| AUT OM AT IC | \# 80 80 80 |\ # F6C ECE | - 1|0| 0|1| 0
COMMENT| Com me nt |\ # FF FF 22 | \# 66666 6| -1| 0| 0| 0| 0
MC3 Amplitudes.conf
# WEB O BS
# Config u r a tion f ile for MC3 a m plitud e sig n als d e finiti o n
3.4. GENPLOT: GENERIC TIME SERIES 29
#
# - Key = key for dat a base ( do no t m odif y or eras e )
# - Name = n ame for d i spla y
# - Value = n u meric a l va lue ( in sign al units , i. e . , m / s or coun ts ), wil l be
# used for am pli tud e even t selec ti on ( with ope ra tor s <= - >=)
#
# Key | N ame | Va lu e
WEAK| Weak |0
AVERAGE| Ave ra ge |500
STRONG| Str ong | 1000
OVERSCALE| Ove rs cale |2000
MC3 Durations.conf
# WEB O BS
# Config u r a tion f ile for MC3 s igna l dur a t ions d e finit i o n
#
# - Key = key for dat a base ( do no t m odif y or eras e )
# - Name = n ame for d i spla y
# - Sec = numb er of se c onds
#
# Key | N am e | Sec
s|seconds|1
mn | m inute s |60
h| hours | 36 00
d| da ys | 8640 0
3.3.4 Links with earthquake event catalogs
SeisComP3
EarthWorm
3.4 GENPLOT: generic time series
3.4.1 Overview
GENPLOT is the default superproc to plot time series from any source of data, particularly the time series formats (see section
3.14.2). GENPLOT is able to produce graphics and text outputs from data channels of associated NODES. All the outputs
will be processed for a list of preset time scales, which can be any of the following:
•a fixed duration (expressed in hour, day, week, month or year) until the present time (moving window);
•a window from a reference date until present time (extending window);
•all available data.
GENPLOT will produce, for each time scale:
•one graph per NODE showing separated subplot for each selected channel;
•one summary graph combining all NODES on each channel subplot using different colors.
The plotted channels for the per-node and summary graphs are both configurable using respectively NODE CHANNELS and
SUMMARY CHANNELS. Titles and line and marker style can also be configured:
•set PERNODE TITLE and/or SUMMARY TITLE to customize the title;
•set PERNODE LINESTYLE and/or SUMMARY LINESTYLE to a line specification string, a combination of two com-
ponents:
–a line type (see possible values in table 5.4),
–a marker symbol type (see possible values in table 5.3),
to choose between drawing markers and/or line and define their style; note you might specify a marker only with no
line, then only the markers are plotted;
•the line width and marker size can be different for each time scale using respectively LINEWIDTHLIST and MARKER-
SIZELIST, that should both define a size to use (in pt) for each of the timescales defined in TIMESCALELIST, coma
separated values;
•colors are chosen automatically by the proc: for the summary graph it will be one color per node, for the per-node graph
it will be one color per channel.
30 CHAPTER 3. BUILT-IN APPLICATIONS
3.4.2 Configuration
Some parameter keys of GENPLOT are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
GENPLOT template
= ke y | va lu e
# Gene ric PROC tem p late
# It can be used f or inst an ce wi th s up er pr oc genp lo t ( gene ri c t ime seri es ).
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / g enplo t . m for fur ther i nf or ma ti on .
# long n ame of the P ROC
NAME| Gen er ic tim e s erie s
# proc T YPE and O WNER
TYPE|
OWNCODE|?
# de fault r aw data fo rmat ( mi ght be over w r itten in ea ch node )
RAWFORMAT|
# raw data path ( m ight be o v e rwritte n in each n ode )
RAWDATA| $WE BO BS { ROOT _R AW D }/ m ypro c
# UR N link to dat a
URNDATA|/ raw data / my proc
DEM_SRTM1|N
# o pti ona l user - d ef in ed DE M ( Arci nf o forma t , l at / lon )
#DEM_FILE|$W EB OB S { P AT H_DAT A_DEM }/ h ighr esdem_la tlon . asc
# DEM_ TY PE | L AT LON
# D EM_ COPYRI GHT | DEM : myD EM
# time z one for o u tput s
TZ | 0
# addi tion nal e xt er na l lin k (s ): TEXT1 , URL 1 ; TEXT2 , URL2 ; ...
UR L |
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
# TIMES C A L E LIST v ali d su ffix : h ( ho ur ) , d ( day ) , w ( week ), m ( mon th ), y ( year )
# T I MESCALE L I S T res e rved word s are : all ( a ll a v ailab l e data ) , ref ( refere n ce d ate un til now )
TIMESCALELIST| 24 h , 01 y
DECIMATELIST| 1 , 1
CUMULATELIST| 1 , 1
DATESTRLIST| -1 , -1
MARKERSIZELIST| 6 ,2
LINEWIDTHLIST| 2 ,1
STA TU SL IST | 1 ,0
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND|$WEBOBS{JOB_MCC} genplot $SELFREF -
SUBMIT_RESOURCE|myproc
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST|NAME
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# --- no de p arame t e rs
NODE_NAME| no de
NODE_SIZE| 10
NOD E_ RGB | Re d
NODE_FONTSIZE| 10
NODE_MARKER|s
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
# --- pa ge f o rmat and outpu ts
# op t ional pap er siz e width , he ight in inc hes
PAP ER _S IZE |
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# land s c ape f orma t for al l o u tput s
LANDSCAPE| NO
# m aximu m nu mber of s ubplo t s in a stand a rd p age hei ght
PAGE_MAX_SUBPLOT|8
# makes a PDF file for ea ch gra ph (in a dditi o n to PNG , EPS and JPG thum b nail )
PDFOUTPUT| NO
# main logo file
LOGO_FILE| $WEBOB S { LOGO_D EF AU LT }
LOGO_HEIGHT| $WE BO BS { L OG O_ HE IG HT }
# main c o pyrig h t
3.5. HYPOMAP: EARTHQUAKE HYPOCENTER MAPS FROM SEISMIC CATALOG 31
COPYRIGHT|MyProc
# opti o nal s e c ondar y lo go fil e
LOG O2 _F ILE |
LOGO2_HEIGHT| $WE BO BS { L OG O_ HEIGH T }
# opti o nal s e c ondar y copyr i ght
COP YR IG HT2 |
# expo rts text data file s
EXPORTS| YE S
# --- da ta p roces s i ng and pl ot
# r emo ve s dat a pic ks us in g m ed ia n fil te r (% of m in / max v al ue s )
PICKS_CLEAN_PERCENT|0
# r epl ace s f lat sign al ( two cons ecut ive i de nti cal v al ue s ) by N aN
FLAT_IS_NAN| NO
# appl ies a me d ian f ilte r to th e d ata
MEDIAN_FILTER_SAMPLES| 0
# super i m pose a mo ving aver a ge on N sampl e s
MOVING_AVERAGE_SAMPLES|0
# set to YES to pl ot c o ntinuo u s li ne i gnor i n g g aps
CONTINUOUS_PLOT| NO
# s et Y - a xi s w it h a l og s cal e
YLOGSCALE| NO
# - -- per nod e g r aphs
# coma s e parat e d list of ch a nnels to plot ( defa ult is al l c hanne l s )
NODE_CHANNELS|
# graph title
PERNODE_TITLE| {\ f on tsi ze {1 4} { \ b f $n o de _ al i as : $ n od e _n am e } ( $t i me s ca le ) }
# line styl e : combi n a tion of a ma rker and / or a li ne type ( see user ’ s manu a l )
PERNODE_LINESTYLE| -
# set to YES to subst r act the fi rst data v alue in al l p lot s
PERNODE_RELATIVE| NO
# - -- s um ma ry gra ph ( all n od es toge the r )
# co m ment this key to no t plo t the s ummar y g raph
SUMMARYLIST|
# coma s e parat e d list of ch a nnels to plot ( defa ult is al l c hanne l s )
SUMMARY_CHANNELS|
# graph title
SUMMARY_TITLE| {\ f on tsi ze {1 4} { \ b f$ { N AM E }} ( $ t im es c al e )}
# line styl e : combi n a tion of a ma rker and / or a li ne type ( see user ’ s manu a l )
SUMMARY_LINESTYLE| -
# set to YES to subst r act the fi rst data v alue in al l p lot s
SUMMARY_RELATIVE| NO
Time scales
3.5 HYPOMAP: Earthquake hypocenter maps from seismic catalog
3.5.1 Overview
3.5.2 Configuration
Some parameter keys of HYPOMAP are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
HYPOMAP template
= ke y | va lu e
# Gene ric PROC tem p late for su p e rproc hypo m ap
# Super f o rmat is ’ q uakes ’: see readfmtd a t a _ q u akes .m for comp a t ible R A W FORMA T def i ned
# in a s s ociate d NODE ’ s RAW F O RMAT fie ld
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / h ypoma p . m for fur ther i nf or ma ti on .
# long n ame of the P ROC
NAME| Eart hquak e hypo ce nter maps fr om seis mic cata log
# proc T YPE and O WNER code ( see O W NERS . conf for O W NCODE s )
RAWFORMAT|quakes
TYPE|
OWNCODE|?
# ra w data p ath
RAWDATA|
# UR N link to dat a
URNDATA|
# time z one for o u tput s
TZ | 0
# additionnal URL
UR L |
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
# TIMES C A L E LIST v ali d su ffix : h ( ho ur ) , d ( day ) , w ( week ), m ( mon th ), y ( year )
TIMESCALELIST| 01 y , 10 y , a ll
32 CHAPTER 3. BUILT-IN APPLICATIONS
DATESTRLIST| -1 , -1 , - 1
MARKERSIZELIST| 5 , 3 ,2
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
# addi tio na l s um mary g raphs keywo rd s ( comm a sepa ra ted )
SUMMARYLIST| Ant ill es , G uade lo upe , M ar ti ni qu e
# SUMMA RY LI ST | S ou frier e
SUMMARY_CHANNELS|
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND|$WEBOBS{JOB_MCC} hypomap $SELFREF -
SUBMIT_RESOURCE|hypomap
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST| NAM E , SUM MA RY LIST , L ATLIM , LONLIM , M AGL IM , DE PLI M , P LO T_ BG _ALL , B UB BL E_P LOT
# node p a ramete r s
NODE_NAME| no de
NODE_SIZE| 10
NOD E_ RGB | 1 ,0 ,0
NODE_FONTSIZE| 10
NODE_MARKER|o
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# v alue = 1 to prod uce EPS g r aphs
POS TS CR IPT |1
# v alue = 1 to exp ort tex t d ata fi les
EXPORTS|1
# main logo file
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
# seco n d ary logo file
LOG O2 _F ILE |
# main c o pyrig h t
COPYRIGHT| IP GP
# secondary copyright
COP YR IG HT2 |
# --- pr oc speci f ic pa r a meters
# for c atal o g dat a reque st
EVENTTYPE_EXCLUDED_LIST| no t e xist ing , n ot loc atab le , o ut si de o f n et wo rk in ter es t , s on ic bo om , d upli ca te , o th er e ve nt
EVENTSTATUS_EXCLUDED_LIST| auto matic
EVENTCOMMENT_EXCLUDED_REGEXP| AUT OMATI C
SC3_LISTEVT|
LATLIM| 13 ,1 9
LONLIM| -6 4 , -5 8
MAGLIM| 3 , 10
DEPLIM| -10 ,300
MSKLIM| 1 , 12
GAPLIM| 0 , 360
RMSLIM| 0 ,1
ERHLIM| 0 , 100
ERZLIM| 0 , 100
NPHLIM| 3, I nf
CLALIM| 0 ,4
QUALITY_FILTER| 0. 7
# fo r g rap h
MARKER_LINEWIDTH|1
PLOT_BG_ALL| .3
DEM_OPT| ’ W at er Ma r k ’ , 2 , ’ Fo nt Si z e ’ , 7
SHA PE _F ILE | $WE BOBS { PAT H_ DA TA_ SH AP E }/ a nt il les _f au lt s . bln
# S TA TIO NS_GR ID | VIEW .
# H yp ocen t er s w i th ou t i n di v id ual c ir cl e l in e (1 yes , 0 n o )
BUBBLE_PLOT|1
# -- Maps of area s : dupl i cate M A P _areana m e _ * keys to make s p ecifi c maps
MAP_Area1_TITLE| Area1 - L es ser A nt il les
# map li mits : lon0 ,lat0 , width ( in deg r ee ) or f o rmer lon1 , lon2 , lat1 , l at2 ( in degr ee )
MAP_Area1_XYLIM| -6 1 ,16 ,6
# m agnit u d e li mits ( for s ize sc ale only , not a f ilte r )
MAP_Area1_MAGLIM| 3 ,7
# depth l imit s ( fo r colo r sc ale only , not a f ilte r )
MAP_Area1_DEPLIM| -2 ,200
# 1 or 2 o p tiona l pro f ile ( s )
# Prof ile 1 ( bot tom ): c ente r l ati tud e , c ente r lo ngi tud e , a z imut h ( deg ree N orth ), lat e ral d i stanc e ( km ) , dept h ( km )
MAP_Area1_PROFILE1| -61.4651,16.5138 ,55,100,200
# Prof ile 2 ( ri ght ): sam e pa r a meters as profile1 , bu t d rawn on th e r ight si de of the map
# Co l ormap used : m ust spe c ify th e numb e r of c o lors
MAP_Area1_COLORMAP| je t (25 6)
# C olor refer en ce for m arke rs : ’ depth ’ ( defau lt ) or ’ time ’
MAP_Area1_COLORREF| ti me
3.6. HELICORDER: SEISMIC HELICORDER 33
# Optio n al time plot : give a list of p a r amete r s ( vers us time ) == > alp ha v e rsio n not full y fun c t ional
# M AP _Area1_ TIMEPLO T | lat itud e , lo ng itude , depth , m agni tu de , p rofi le1 , p ro fi le 2
3.6 HELICORDER: Seismic helicorder
3.6.1 Overview
3.6.2 Configuration
Some parameter keys of HELICORDER are common for all PROCS and GRIDS so are identical with the VIEW configuration
(see section 2.3.1).
HELICORDER template
= ke y | va lu e
# Helic o r der PROC tem p late
# M akes helicor de rs fro m node c hann els , u sing " even ts " outp ut type .
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / h el ic or der .m for fu rt her i nf or ma ti on .
# long n ame of the P ROC
NAME| Heli corde r
# proc T YPE and O WNER code ( see O W NERS . conf for O W NCODE s )
TYPE|
OWNCODE|?
RAWFORMAT|
# ra w data p ath
RAWDATA|
# UR N link to dat a
URNDATA|/ raw data / my proc
# time z one for o u tput s
TZ | 0
# additionnal URL
UR L |
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
# TIMES C A L E LIST v ali d su ffix : h ( ho ur ) , d ( day ) , w ( week ), m ( mon th ), y ( year )
TIMESCALELIST| 02 d
DECIMATELIST|1
CUMULATELIST|1
DATESTRLIST| -1
LINEWIDTHLIST|1
MARKERSIZELIST|4
STA TU SL IST |1
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } h el ic order $SE LF REF -
SUBMIT_RESOURCE| hel ic or der
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST| NAME , H EL IC OR DE R_ DU RA TION_D AY S , HEL ICORD ER _TURN S , HE LI CORDE R_ SCALE , HEL IC OR DE R_PAPE R_ CO LOR , H EL IC OR DE R_PAP ER _C OL OR , HEL IC OR DE R_ YT ICK_H OU RS , HEL IC ORDER _R ADIUS , HELI CO RD ER_ TR EN D
# node p a ramete r s
NODE_NAME| no de
NODE_SIZE| 10
NOD E_ RGB | 1 ,0 ,0
NODE_FONTSIZE| 10
NODE_MARKER|o
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
DEM_SRTM1|N
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# land s c ape f orma t for al l o u tput s
LANDSCAPE|Y
# v alue = 1 to prod uce EPS g r aphs
POS TS CR IPT |1
# v alue = 1 to exp ort tex t d ata fi les
EXPORTS|1
# main logo file
34 CHAPTER 3. BUILT-IN APPLICATIONS
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
# seco n d ary logo file
LOG O2 _F ILE |
# main c o pyrig h t
COPYRIGHT|MyProc
# secondary copyright
COP YR IG HT2 |
#STREAM_CHANNEL_SELECTOR|HHZ
# DATALINK_DE LAY _S ECO ND S |60 0
# - -- proc ’ s speci f ic pa r a meters
# mai n d u ratio n for a sing le grap h
HELICORDER_DURATION_DAYS|1
# num b er of tu rns per d u ratio n
HELICORDER_TURNS|24*2
# v er ti ca l s cale ( relat iv e to the sig nal s ta nd ard d ev ia tion )
HELICORDER_SCALE| 10 0
# back gr ou nd pap er co lor ( a cc epts htm l names , see C ODE / ma tl ab / htm 2r gb . m)
HELICORDER_PAPER_COLOR| #0 F0F 0F
# tr ace col or or colo r l ist
# H EL ICORDE R_TRACE_ COLOR | black , red , med iumbl ue , g re en
HELICORDER_TRACE_COLOR| whi te smoke
# yti ck l a bels
HELICORDER_YTICK_HOURS|2
# galva nome ter r ot ati on e ff ec t ( use 0 to u ns et )
HELICORDER_RADIUS| 1
# t race s t ren d effe c t
HELICORDER_TREND|N
# ve rtica l tim e d irect i o n
HELICORDER_TOPDOWN|N
# --- da ta p roces s i ng
# r emo ve s dat a pic ks us in g m ed ia n fil te r (% of m in / max v al ue s )
PICKS_CLEAN_PERCENT|0
# r epl ace s f lat sign al ( two cons ecut ive i de nti cal v al ue s ) by N aN
FLAT_IS_NAN| NO
# appl ies a me d ian f ilte r to th e d ata
MEDIAN_FILTER_SAMPLES| 0
3.7 RSAM: Realtime Seismic Amplitude Measurement
3.7.1 Overview
3.7.2 Configuration
Some parameter keys of RSAM are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
RSAM template
= ke y | va lu e
# RSAM P ROC temp l ate
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / rsa m. m for fur th er i nf or ma ti on .
# long n ame of the P ROC
NAME| Rea lt ime S eism ic Am pl it ude M ea su re me nt
# proc T YPE and O WNER
TYPE|
OWNCODE|?
# de fault r aw data fo rmat ( mi ght be over w r itten in ea ch node )
RAWFORMAT|
# raw data path ( m ight be o v e rwritte n in each n ode )
RAWDATA|
# UR N link to dat a
URNDATA|/ raw data / my proc
# additionnal URL
UR L |
# time z one for o u tput s
TZ | 0
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
# TIMES C A L E LIST v ali d su ffix : h ( ho ur ) , d ( day ) , w ( week ), m ( mon th ), y ( year )
TIMESCALELIST| 04 h , 24 h
DECIMATELIST| 1 , 1
CUMULATELIST| 1 , 1
DATESTRLIST| -1 , -1
MARKERSIZELIST| 2 ,1
LINEWIDTHLIST| .2 ,. 1
STA TU SL IST | 1 ,0
REF _D ATE | 2017 -0 7 -13 1 2:0 0:00
3.7. RSAM: REALTIME SEISMIC AMPLITUDE MEASUREMENT 35
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } rsam $SEL FREF -
SUBMIT_RESOURCE|rsam
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST| NA ME , R E F_ DA T E
# --- no de p arame t e rs
NODE_NAME| no de
NODE_SIZE| 10
NOD E_ RGB | Re d
NODE_FONTSIZE| 10
NODE_MARKER|s
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
#DEM_FILE|$W EB OB S { P ATH _DATA_ DEM }/ e xam pled em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
DEM_SRTM1|Y
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
# --- pa ge f o rmat and outpu ts
# op t ional pap er siz e width , he ight in inc hes
PAP ER _S IZE |
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# land s c ape f orma t for al l o u tput s
LANDSCAPE| NO
# m aximu m nu mber of s ubplo t s in a stand a rd p age hei ght
PAGE_MAX_SUBPLOT|8
# makes a PDF file for ea ch gra ph (in a dditi o n to PNG , EPS and JPG thum b nail )
PDFOUTPUT| NO
# main logo file
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
# main c o pyrig h t
COPYRIGHT| P ro ces si ng b y Tai sn e et al . / IP GP / E OS
# opti o nal s e c ondar y lo go fil e
LOG O2 _F ILE |
# opti o nal s e c ondar y copyr i ght
COP YR IG HT2 |
# ev e nts file to p lot in the b ackgro u n d of ea ch gra ph
#EVENTS_FILE|$W EB OB S { ROO T_C ON F }/ e ve nts _Wor ld . conf
# expo rts text data file s
# EXPO RTS | YES
# --- da ta p roces s i ng and pl ot
# r emo ve s dat a pic ks us in g m ed ia n fil te r (% of m in / max v al ue s )
PICKS_CLEAN_PERCENT|0
# r epl ace s f lat sign al ( two cons ecut ive i de nti cal v al ue s ) by N aN
FLAT_IS_NAN| NO
# appl ies a me d ian f ilte r to th e d ata
MEDIAN_FILTER_SAMPLES| 0
# super i m pose a mo ving aver a ge on N sampl e s
MOVING_AVERAGE_SAMPLES| 12 *6 0
# set to YES to pl ot c o ntinuo u s li ne i gnor i n g g aps
CONTINUOUS_PLOT| NO
# s et Y - a xi s w it h a l og s cal e
YLOGSCALE| YE S
# - -- per nod e g r aphs
# graph title
PERNODE_TITLE| {\ f on tsi ze {1 4} { \ b f $n o de _ al i as : $ n od e _n am e } ( $t i me s ca le ) }
# line styl e
PERNODE_LINESTYLE| -
# - -- s um ma ry gra ph ( all n od es toge the r )
# co m ment this key to no t plo t the s ummar y g raph
SUMMARYLIST| SOUR CEMAP
# coma s e parat e d list of ch a nnels to plot ( defa ult is al l c hanne l s )
SUMMARY_CHANNELS|1
# graph title
SUMMARY_TITLE| {\ f on tsi ze {1 4} { \ b f$ { N AM E }} ( $ t im es c al e )}
# line styl e
SUMMARY_LINESTYLE| -
# --- so urce mapp i ng
# n um ber o f map s w il l be N * N ( a ll ow ed valu es ar e 1 , 2 ,3 or 4)
SOURCEMAP_N|3
SOURCEMAP_COLORMAP| je t
SOURCEMAP_COLORMAP_ALPHA| 0 ,1
SOURCEMAP_CAXIS| 0 ,2 e - 5
SOURCEMAP_PLOT_MAX|Y
36 CHAPTER 3. BUILT-IN APPLICATIONS
3.8 GNSS: GPS time series, vectors and modelling
3.8.1 Overview
3.8.2 Configuration
Some parameter keys of GNSS are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
GNSS template
= ke y | va lu e
# Gene ric PROC tem p late for su p e rproc gnss
# Super f o rmat is ’ gnss ’: see r e a d f m tdata_gns s . m fo r c o m patibl e RAWFO R MAT d e fine d
# in a s s ociate d NODE ’ s RAW F O RMAT fie ld
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / gns s. m for fur th er i nf or ma ti on .
# long n ame of the P ROC
NAME| GNSS t im e series , v ec to rs and m od ell in g
RAWFORMAT| gipsy
RAWDATA| $WE BO BS { ROOT _R AW D }/ g ipsy
URNDATA| $WE BOBS { UR N_ RAWD }/ g ipsy
# time z one for o u tput s
TZ | 0
# addi tion nal e xt er na l lin k (s ): TEXT1 , URL 1 ; TEXT2 , URL2 ; ...
UR L |
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
TIMESCALELIST| 01 y , a ll
DECIMATELIST|
CUMULATELIST|
DATESTRLIST| -1 , -1
MARKERSIZELIST| 3 ,1
LINEWIDTHLIST| 1 ,.1
STA TU SL IST | 1 ,0
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
# summ ary g raphs
SUMMARYLIST| VECTORS , BAS ELIN ES , MOD ELLI NG , M OD EL TI ME
# fo r s c hedule r requ e sts
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } gnss $SEL FREF -
SUBMIT_RESOURCE| gipsy
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST| NA ME , S UM MA R YL IS T , V E CT O RS _ RE L AT I VE
DEM_SRTM1|N
# o pti ona l user - d ef in ed DE M ( Arci nf o forma t , l at / lon )
#DEM_FILE|$W EB OB S { P AT H_DAT A_DEM }/ h ighr esdem_la tlon . asc
# DEM_ TY PE | L AT LON
# D EM_ COPYRI GHT | DEM : myD EM
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
PAP ER _S IZE | 8 ,11
PP I | 100
LANDSCAPE|N
PLOT_GRID|N
FON TS IZE |8
POS TS CR IPT |1
EXPORTS|1
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
LOG O2 _F ILE |
COPYRIGHT| Pr oces sing by Bea uduc el et al ./ IPGP
COP YR IG HT2 |
NODE_NAME|station
NODE_MARKER|o
NODE_SIZE|6
NOD E_ RGB | 1 ,0 ,0
NODE_FONTSIZE|8
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# --------------------------------------------------------------------
# s p ecifi c proc ’s p a ramete r s
3.8. GNSS: GPS TIME SERIES, VECTORS AND MODELLING 37
# ma ximu m e rror on p ositi o n (in m) bef o re exclu d ing the da ta fr om gr a phs and cal c u l ations
FILTER_MAX_ERROR_M|1
PICKS_CLEAN_PERCENT|0
TREND_ERROR_MODE|1
# mini mum t ime win dow (in d ays ) nee d ed to co m pute a trend
TREND_MIN_DAYS|1
# I TRF r ef er en ce ( this is a s tring displ aye d on g ra ph title , n ot f un cti onal )
ITR F_ REF |ITRF08
# R e la tiv e ve l oc it y re f er e nc e E , N ,U ( m m / yr ) f ro m I TR F = c on sta n t tre nd
# subst r a cted to a ll data b efor e a ny oth er p r o cessi n g
VELOCITY_REF| 0 ,0 ,0
VELOCITY_REF_ORIGIN_DATE| 2000 -01 -01
# PERN ODE g raphs
PERNODE_LINESTYLE| o
PERNODE_TITLE| {\ f onts ize {14 }{\ bf$ node_a lias : $ node_ name - $ {ITR F_RE F }} ( $ time scal e )}
# SUMM ARY g raphs
SUMMARY_LINESTYLE| o
SUMMARY_TITLE| {\ f on ts ize { 14 }{ \ bf $ { NAME } - $ { ITR F_ RE F }} ( $ ti me sc al e )}
# BASE L I NES g raph s
# - d efau l t b ehavi o r : all pai rs of nodes , with po s sible n ode e x clusi o n and /or node refer e nce li st
BASELINES_EXCLUDED_NODELIST|
BASELINES_REF_NODELIST|
# - f ix ed pai rs : REF1 , S TA 1 ; RE F2 , S TA1 , ST A2 , ST A5
BASELINES_NODEPAIRS|
BASELINES_TITLE| {\ f on ts iz e {14 }{ \ bf $ { NAME } - B as el in es } ( $ ti me sc ale )}
BASELINES_UNIT| mm
BASELINES_YLABEL| $ref _n od e_ al ia s ( ${ BA SE LI NE S_ UN IT })
BASELINES_LINESTYLE|.-
# V EC TO RS : e xc lu di ng NO DES from gr ap hs and ca lcu la tio ns
VECTORS_EXCLUDED_NODELIST|
VECTORS_RELATIVE|N
# VEC T ORS : if VECT O R S _ R ELATIVE is Y , subst r a cts a refe r ence v ecto r in V E C TORS_VELOCIT Y _ R E F :
# - voi d ( defau lt ): automa t ic mean velo c ity ( aver age vec tor of a ll NODES )
# - NODE ’s FID na me or lis t of NO DES : use the ve l ocity vec t or (or m ean vel o city vect o r )
# - E ,N ,U : s et s f ix ed of fse t v al u es ( in mm / yr )
VECTORS_VELOCITY_REF|
VECTORS_RELATIVE_HORIZONTAL_ONLY|Y
VECTORS_TITLE| {\ f on ts ize { 14 }{ \ bf $ { NAME } - V el oc it y vec to rs } ( $ ti mes ca le )}
VECTORS_MIN_SIZE_KM| 10
VECTORS_MAX_XYRATIO| 1. 5
VECTORS_ARROWSHAPE|.15,.15 ,.12,.03
# defi nes a main targ e t ( lati tud e , longi t ude c o o r dinate s )
GNSS_TARGET_LATLON|
# MODE L L ING g raph
# excl u d ing N ODES from grap hs and calcu l a t ions
MODELLING_EXCLUDED_NODELIST|
# igno res v e rtica l comp o n ent
MODELLING_HORIZONTAL_ONLY|Y
# reco mp ut es relat iv e veloci ti es befo re m od el li ng ( inste ad of vect or s re su lts )
MODELLING_FORCE_RELATIVE|N
# m ode ll in g s ource : ’ is otro pic ’ ( forme rl y ’ mogi ’) or ’ pcdm ’ ( poin t Com po un d D is loc at ion Model )
MODELLING_SOURCE_TYPE| isot ro pic
# m isfi t norm c alcula ti o n : ’L1 ’ ( defa u lt ) or ’L2 ’
MODELLING_MISFITNORM| L1
# a p rior i hori z o ntal erro r ar ound the targ e t or g rid cen ter ( in STD , km ) , 0 = no a pri o ri
MODELLING_APRIORI_HSTD_KM|0
# se t a m inimu m er ror on di splac emen t s , a b solut e ( mm ) a nd r elati v e ( %) to a void NaN PDF when m isfi t is too high
MODELLING_MINERROR_MM| 5
MODELLING_MINERROR_PERCENT| 1
# indi c a tes the best sour ce s o lutio n on gra ph
MODELLING_PLOT_BEST|Y
# a dds r es id ua l arro ws ( data - m od el )
MODELLING_PLOT_RESIDUAL|Y
# nu mber of si gma ( STD ) to com p ute u ncerta i n t y int e rvals for best model
MODELLING_SIGMAS|1
# colo r ref e rence fo r mode l sp ace : ’pdf ’ or ’ volpdf ’ ( so u rce volu me sign x pdf , new d e faul t )
MODELLING_COLORREF|volpdf
MODELLING_COLORMAP| je t (25 6)
MODELLING_COLOR_SHADING| 0. 8
MODELLING_MAX_DEPTH|8000
MODELLING_BORDERS| 5000
MODELLING_GRID_SIZE| 51
MODELLING_TITLE| {\ f on ts iz e {14 }{ \ bf $ { NAME } - S ou rce m od el li ng } ( $ tim es ca le )}
# spec i fic pCDM para m eters for MO D E LLING
MODELLING_PCDM_ITERATIONS|5
MODELLING_PCDM_RANDOM_SAMPLING|100000
MODELLING_PCDM_NU| 0.25
MODELLING_PCDM_ALIM| 0 ,1
MODELLING_PCDM_BLIM| 0 ,1
MODELLING_PCDM_OXLIM| -45,45
MODELLING_PCDM_OYLIM| -45,45
38 CHAPTER 3. BUILT-IN APPLICATIONS
MODELLING_PCDM_OZLIM| -45,45
MODELLING_PCDM_HEATMAP_GRID| 50
MODELLING_PCDM_HEATMAP_SATURATION| 0.4
MODELLING_PCDM_HEATMAP_SMOOTH_SPAN| 5
MODELLING_PCDM_HEATMAP_SMOOTH_DEGREE| 1
MODELLING_PCDM_NEW_THRESHOLD|2
MODELLING_PCDM_NEW_LIMIT_EDGE_RATIO| 20
MODELLING_PCDM_NEW_LIMIT_EXTEND|1
MODELLING_PCDM_SUPPLEMENTARY_GRAPHS| N
# MODEL T IME : de fine s the movin g p eriods , m inim u m s amp lin g , m aximu m mo d els
# [ NOTE ] MOD E L TIME al ways uses an isot r opic so urce
MODELTIME_PERIOD_DAY| 30 ,1 5
MODELTIME_SAMPLING_DAY|2
MODELTIME_MAX_MODELS| 50
MODELTIME_TITLE| {\ f on tsi ze {1 4} { \ b f $n am e - S o ur ce b es t mo del t i me li n e } ( $ ti me s ca l e )}
3.9 EXTENSO: Extensometry time series and vectors
3.9.1 Overview
3.9.2 Configuration
Some parameter keys of EXTENSO are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
EXTENSO template
= ke y | va lu e
# Gene ric PROC tem p late for su p e rproc exte n so
# This PROC must be a ss oc ia te d wit h the FORM " EXTE NS O " w hich conta in s
# comp ati bl e dat a and nee ded com ple ment ary c on fig urat ion file s .
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / e xtens o . m for fur ther i nf or ma ti on .
NAME| Exte ns om etry time ser ies and vec tors
RAWDATA|
URNDATA|
TZ | -4
UR L |
# lis ts of param e t ers ( nu mber of coma - se p arated rows m ust be c onsist e n t )
TIMESCALELIST| 10 y , a ll
DECIMATELIST|
CUMULATELIST|
DATESTRLIST| -1 , -1
MARKERSIZELIST| 16 ,1 2
LINEWIDTHLIST| 2 ,1
STA TU SL IST | 1 ,0
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
# addi tio na l s um mary g raphs keywo rd s ( comm a sepa ra ted )
SUMMARYLIST|VECTORS
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND|
SUBMIT_RESOURCE|myproc
NODE_NAME| si te
NODE_MARKER|^
NOD E_ RGB | 1 ,0 ,0
NODE_SIZE| 10
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
MAP 1_ XY LIM | -61 .66805 , -61.6 597 2 ,16.03889 ,1 6.0 472 2
DEM_SRTM1|N
# o pti ona l user - d ef in ed DE M ( Arci nf o forma t , l at / lon )
#DEM_FILE|$W EB OB S { P AT H_DAT A_DEM }/ h ighr esdem_la tlon . asc
# DEM_ TY PE | L AT LON
# D EM_ COPYRI GHT | DEM : myD EM
# time z one for o u tput s
TZ | 0
# addi tion nal e xt er na l lin k (s ): TEXT1 , URL 1 ; TEXT2 , URL2 ; ...
UR L |
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
3.10. TILT: TILTMETRY TIME SERIES, VECTORS AND MODELLING 39
PP I | 100
POS TS CR IPT |1
EXPORTS|1
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
LOG O2 _F ILE |
COPYRIGHT| Pr oces sing by Bea uduc el et al ./ IPGP
COP YR IG HT2 |
# s p ecifi c PROC ’s p a ramete r s
FILTER_MAX_ERROR_MM| 10
ZON E1 _N AME |Zone Nord
ZONE1_NODELIST| FN W1 , DU P1 , D UP2 , D UP3 , FN O1
ZON E2 _N AME | Zon e Sud - Es t
ZONE2_NODELIST| NA P1 , F8 J1 , B LK1 , L CX1 , CS D1
ZON E3 _N AME | Zo ne Sud
ZONE3_NODELIST| DO L1 , DO L2 , P EY1 , F 302 , F3 03
VECTORS_EXCLUDED_NODELIST| BA T0 , H OU 1
VECTORS_ARROWSHAPE|.15,.1,.1,.04
VECTORS_VELOCITY_SCALE|0
VECTORS_MIN_SIZE_KM| .5
VECTORS_MAX_XYRATIO|2
3.10 TILT: Tiltmetry time series, vectors and modelling
3.10.1 Overview
3.10.2 Configuration
Some parameter keys of TILT are common for all PROCS and GRIDS so are identical with the VIEW configuration (see section
2.3.1).
TILT template
= ke y | va lu e
# Gene ric PROC tem p late for su p e rproc tilt
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / til t. m for fur th er i nf or ma ti on .
# long n ame of the P ROC
NAME| Til tm et ry time series , vec tors and mo delli ng
# proc T YPE and O WNER code ( see O W NERS . conf for O W NCODE s )
TYPE|
OWNCODE|?
RAWFORMAT|
# ra w data p ath
RAWDATA|
# UR N link to dat a
# URND ATA |/ rawd at a / mypro c
# time z one for o u tput s
TZ | + 0
# additionnal URL
UR L |
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
# TIMES C A L E LIST v ali d su ffix : h ( ho ur ) , d ( day ) , w ( week ), m ( mon th ), y ( year )
TIMESCALELIST| 24 h , 01 w
DECIMATELIST| 1 , 1
CUMULATELIST| 1 , 1
DATESTRLIST| -1 , -1
MARKERSIZELIST| 6 ,3
LINEWIDTHLIST| 1 ,1
STA TU SL IST | 1 ,0
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
# addi tio na l s um mary g raphs keywo rd s ( comm a sepa ra ted )
SUMMARYLIST| VECTO RS , MOD ELL IN G
SUMMARY_CHANNELS| 1 ,2 ,3
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } tilt $SEL FREF -
SUBMIT_RESOURCE|myproc
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST| NA ME , V E CT O RS _ EX C LU D ED _ NO D EL IST , M O D EL L IN G _EX C L UD E D_ N ODE L IST
# node p a ramete r s
NODE_NAME|station
NODE_SIZE| 10
NOD E_ RGB | 1 ,0 ,0
NODE_FONTSIZE| 10
NODE_MARKER|o
40 CHAPTER 3. BUILT-IN APPLICATIONS
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
COPYRIGHT| Pr oces sing by Bea uduc el et al ./ IPGP
LOG O2 _F ILE |
COP YR IG HT2 |
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# v alue = 1 to prod uce EPS g r aphs
POS TS CR IPT |1
# v alue = 1 to exp ort tex t d ata fi les
EXPORTS|1
PICKS_CLEAN_PERCENT|0
FLAT_IS_NAN| NO
# appl ies a me d ian f ilte r to th e d ata
MEDIAN_FILTER_SAMPLES| 0
TREND_ERROR_MODE|1
# defi nes the cha n nels
TILTX_CHANNEL|1
TILTY_CHANNEL|2
TEMPERATURE_CHANNEL|3
TILT_TARGET_LATLON|
PERNODE_TEMPERATURE_BACKGROUND|N
PERNODE_TEMPERATURE_COLOR| 1 ,.7 ,.7
MOTION_EXCLUDED_NODELIST|
MOTION_MIN_SIZE_KM| 10
MOTION_MAX_XYRATIO| 1. 5
MOTION_TIME_COLORMAP| jet (2 56 )
MOTION_DEM_OPT| ’ c ol or ma p ’ ,. 5* o n es (64 ,3 ) , ’ wa t er ma rk ’ , 2 , ’ in te rp ’ , ’ l eg en d ’
MOTION_TITLE| {\ f on t si ze {1 4 }{ \ b f $n am e } ( $ t im esc a le )}
VECTORS_TITLE| {\ f on tsi ze {1 4} { \ b f $n am e } ( $ ti m es cal e )}
VECTORS_EXCLUDED_NODELIST|
VECTORS_DEM_OPT| ’ w at er ma rk ’ ,2 , ’ i nt erp ’ , ’ l ege nd ’
VECTORS_VELOCITY_SCALE|
VECTORS_MIN_SIZE_KM| 10
VECTORS_MAX_XYRATIO| 1. 5
VECTORS_ARROWSHAPE| .1 ,.1 ,.08 ,.02
MODELLING_TITLE| {\ f on tsi ze {1 4} { \ b f $n am e } ( $ ti m es ca l e ) }
MODELLING_EXCLUDED_NODELIST|
MODELLING_MAX_DEPTH|5000
MODELLING_BORDERS| 2500
MODELLING_GRID_SIZE| 10 0
MODELLING_SIGMAS|1
3.11 METEO: meteorological time series
3.11.1 Overview
3.11.2 Configuration
Some parameter keys of METEO are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
METEO template
= ke y | va lu e
# Gene ric PROC tem p late for su p e rproc met eo
# Se e $W EBOBS { RO OT _CODE }/ matl ab / superp ro cs / mete o . m for da ta form at and fur th er i nf or ma ti on .
# long n ame of the P ROC
NAME| Mete or ol og ic al t ime s erie s
RAWDATA| $WE BO BS { ROOT _R AW D }/ c am pb ell
RAWFORMAT| cr1 0x asc
3.11. METEO: METEOROLOGICAL TIME SERIES 41
# proc T YPE and O WNER code ( see O W NERS . conf for O W NCODE s )
TYPE|
OWNCODE|?
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
TZ | 0
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
TIMESCALELIST| 24 h , 30 d , 01 y , 10 y , a ll
DECIMATELIST| 1 ,1 ,6 ,6 ,6
CUMULATELIST| 1/24 ,1 ,1 ,30 ,30
DATESTRLIST| -1 , -1 , - 1 , -1 , - 1
MARKERSIZELIST| 6 ,4 ,2 ,1 ,1
LINEWIDTHLIST| 1 ,1 ,1 ,1 ,1
STA TU SL IST | 1 ,0 ,0 ,0 ,0
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
#SUMMARYLIST|
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } met eo $ SE LFREF -
SUBMIT_RESOURCE|mymeteo
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST|NAME
# node p a ramete r s
NODE_NAME|station
NODE_SIZE| 15
NOD E_ RGB | 1 ,0 ,0
NODE_FONTSIZE| 10
NODE_MARKER|o
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# land s c ape f orma t for al l o u tput s
LANDSCAPE|N
# v alue = 1 to prod uce EPS g r aphs
POS TS CR IPT |1
# v alue = 1 to exp ort tex t d ata fi les
EXPORTS|1
# main logo file
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
# seco n d ary logo file
LOG O2 _F ILE |
# main c o pyrig h t
COPYRIGHT|MyProc
# secondary copyright
COP YR IG HT2 |
# --------------------------------------------------------------------
# s p ecifi c proc ’s p a ramete r s
RAIN_CHANNEL|6
RAIN_CUMSUM_DATA| NO
WIND_SPEED_CHANNEL|5
WIND_AZIMUTH_CHANNEL|4
WIND_ROSE_STEP| 10
XY_CHANNELS| 3 , 8
NODE_CHANNELS| 1 ,2 ,7 ,4 ,5 ,3 ,8
RAIN_ALERT_THRESHOLD| 50
RAIN_ALERT_INTERVAL|1
RAIN_ALERT_DELAY|3
RAIN_ALERT_RGB| 1 ,.3 ,.3
RAIN_ALERT_DELAY_RGB| 1 , .6 , .6
42 CHAPTER 3. BUILT-IN APPLICATIONS
3.12 WATERS: chemical analysis
3.12.1 Overview
3.12.2 Configuration
Some parameter keys of WATERS are common for all PROCS and GRIDS so are identical with the VIEW configuration (see
section 2.3.1).
WATERS template
= ke y | va lu e
# Gene ric PROC tem p late for su p e rproc wate rs
# This PR OC mu st be a ssoci a t ed with the F ORM " EAUX " which cont a ins c ompati b l e
# data a nd n eeded complem enta ry c on figu rati on file s .
# Se e $W EB OBS { ROO T_ CO DE }/ matl ab / s up er pr oc s / wa te rs . m for fur th er infor ma tio n .
# long n ame of the P ROC
NAME| Wat ers c hemic al an al ys is
# proc T YPE and O WNER code ( see O W NERS . conf for O W NCODE s )
TYPE|
OWNCODE|?
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
TZ | 0
# auto ref r esh of graph ic d ispla y
DISPLAY_AUTOREFRESH_SECONDS|3600
# lists of par a meters ( num ber of comma - sepa r a ted rows mus t be c onsist e n t )
TIMESCALELIST| 10 y , 50 y , a ll
DECIMATELIST|
CUMULATELIST|
DATESTRLIST| 10 ,10 ,10
MARKERSIZELIST| 4 , 2 ,2
LINEWIDTHLIST| 1 ,.5 ,.1
STA TU SL IST | 1 ,0 ,0
# defi nes a refe r ence date to us e w ith ’ ref ’ t imesc a l e in T I MESCALE L I S T
REF _D ATE |
SUMMARYLIST|
# e xecu tio n c om man d ( for ru npr oc she ll )
SUBMIT_COMMAND| $WE BO BS { JOB_ MCC } waters $SE LF REF -
SUBMIT_RESOURCE|waters
# list of keys e d itabl e in r eques t s
REQUEST_KEYLIST|NAME
# node p a ramete r s
NODE_NAME|spring
NODE_SIZE| 15
NOD E_ RGB | 0 ,1 ,1
NODE_FONTSIZE| 10
NODE_MARKER|s
# file for backgr o u nd time refe r e nced eve nts
EVENTS_FILE| $WE BO BS { R OOT_C ON F }/ even ts _W or ld . co nf
# - -- opti on al user - d efin ed DEM , in Ar cI nfo form at ( overwr it es SRTM / ET OPO d ef ault )
DEM _F ILE | $WE BOBS { PA TH_ DA TA _D EM }/ exam pl ed em . asc
# DE M c o o rdinat e sys tem : U TM or L ATLON
DEM _T YPE |LATLON
DEM_COPYRIGHT|
# gr a phica l dens ity for PNG out p uts ( in pi xel per in ches )
PP I | 100
# land s c ape f orma t for al l o u tput s
LANDSCAPE|N
# v alue = 1 to prod uce EPS g r aphs
POS TS CR IPT |1
# v alue = 1 to exp ort tex t d ata fi les
EXPORTS|1
# main logo file
LOGO_FILE| $WE BO BS { R OO T_ CO DE }/ i cons / i pgp / log o_ WO VS . png
# seco n d ary logo file
LOG O2 _F ILE |
# main c o pyrig h t
COPYRIGHT|MyProc
# secondary copyright
COP YR IG HT2 |
3.13. PROCS GRAPH AND DATA REQUEST 43
3.13 PROCS graph and data request
3.13.1 Overview
A dedicated form /cgi-bin/formREQ.pl allows to make user request to get any outputs (graphs and data) from PROCS
sharing the same set of time span and parameters, mostly independent from the SCHEDULER’s jobs. The identified USER
has to be authorized for reading on the PROC to perform a request on it.
3.13.2 Description
The form presents a list of available PROCS with empty check boxes. One or more PROCS can be selected, in that case a
parameter list might appear for each of selected PROC, allowing the user to change the values. Please note there is no validity
check of the values so a request may fail in case of invalid fields.
The main parameter to define is the date and time span: Start date and End date with time. Default is the last full month.
A list of preset dates is also available. The date and time must be in UT.
Also some output parameters can be defined:
•TZ: the output time zone, in hours. Will affect graphs and data exports.
•Date format: the format of dates for time series plots axis ticks label.
•Cumulate: time for cumulating data (when cumulative allowed in the PROC), in day. Use fraction or any arithmetic
formula if needed.
•Decimate: number of sample for decimation of the raw data (time series).
•Marker size: maker size in points (if the PROC uses markers).
•Line width: line width in points (if the PROC uses lines).
•PPI: resolution for PNG output images, in pixel per inch.
•Postscript: outputs the EPS vector graphic images (default is cheched).
•PDF: outputs a PDF version of images.
•Exports: outputs data (text files or others depending on the PROC).
After submit the request, each of the PROC will be submitted to SCHEDULER as specific jobs. The name of the job is made
from date and time of the request, hostname and user login name.
The run of each PROC can be followed on the scheduler runs page. If a job ends with success, a notification email is sent to
the user through the POSTBOARD. The email provides two links: a first to access the request results (graphs and exports)
through a web interface similar to the routine PROC graphs. The second link allows to download a .tgz archive containing all
images and files of the request.
44 CHAPTER 3. BUILT-IN APPLICATIONS
A dedicated page is also available to access request results: /cgi-bin/showREQ.pl. The page will show the user’s requests
and results (if the request job has ended successfully), or all the existing requests for ADMIN users.
3.13.3 Configuration
PROC.conf (excerpt)
SUBMIT_COMMAND|$WEBOBS{JOB_MCC} genplot $SELFREF -
SUBMIT_RESOURCE|myproc
REQUEST_KEYLIST| NA ME , S U MM AR Y _R EL A TI VE , P E RN O DE _ LI N E ST Y LE
The request form displays any PROC containing a not-empty SUBMIT COMMAND parameter in its configuration. This parameter
is the routine execution command line, ie. equivalent to the value of a XEQ1 in the SCHEDULER (see scheduler.pl doc) and,
as such, supporting $WEBOBS parameters substitution.
The SUBMIT RESOURCE is the optional routine execution mutex name (process lock) of as defined in SCHEDULER if the PROC
is one of the routine jobs. This is to avoid possible conflicts of simultaneous runs.
Optionally, the REQUEST KEYLIST parameter is used to specify a list of comma-separated keys of existing parameters, that will
be presented to the user so that (s)he will have a chance to overwrite corresponding values for request execution.
The user defined output parameters Date format,Cumulate,Decimate,Marker size and Line width correspond to table
values DATESTRLIST,CUMULATELIST,DECIMATELIST,MARKERSIZELIST and LINEWIDTHLIST, respectively.
The list of available preset values for PPI resolution, marker size and line width can be defined in WEBOBS.rc :
WEBOBS.rc (excerpt)
REQ_PPI_LIST|75,100,150,300,600
REQ_MARKERSIZE_LIST| 1 ,2 ,4 ,6 ,10 ,15 ,20
REQ_LINEWIDTH_LIST| 0.1 ,0.25 ,0. 5 ,1 ,1.5 ,2 ,3
To use the notification email facility, POSTBOARD must be running, and the special event formreq. must be defined and
valid (see WebObs Users Manager page).
3.14 Data formats available for PROCS
Formats are defined for a whole PROC in the RAWFORMAT PROC’s variable, or for individual NODE in the RAWFORMAT NODE’s
parameter which overwrites the PROC value. The RAWDATA PROC’s variable can be defined for all associated NODES, and
any individual NODE’s RAWDATA may overwrite it. A special variable $FID might be used and will be replaced by each NODE’s
value. For most of the formats, the Calibration File of each associated NODE will define the list of available channels and
associated parameters.
See the source codes CODE/matlab/readfmtdata.m help for more details.
3.14.1 Waveforms formats
These formats are standards in seismology for waveforms data, but they are also used for other types of geophysical sensors.
The standards use local files in specific format or dedicated protocol request from distant servers. Particularly, the full channel
stream must be defined for each NODE, i.e.:
NET network code FDSN NETWORK CODE NODE’s parameter
STA station code FID NODE’s parameter
CHA channel code calibration file “Chan. Code” channel parameter
LOC location code calibration file “LC” channel parameter
{miniseed}: miniSEED files
Single of multiple local files in miniSEED format. RAWDATA defines the filename(s) using standard bash syntax (accepts
wildcards). Some limitations may apply due to bash line size limit.
{seedlink}: SeedLink request
SeedLink protocol request from a distant or local server. RAWDATA defines the server with host:port. The format uses external
program slinktool defined by the WEBOBS.rc SLINKTOOL PRGM parameter. DATALINK DELAY SECONDS defines the delay in
seconds from real-time for the last data.
3.14. DATA FORMATS AVAILABLE FOR PROCS 45
{arclink}: SeisComP3 ArcLink request
ArcLink protocol request from a distant or local server. RAWDATA defines the server with host:port. Optional parameter
ARCLINK USER can be defined (default user is ’wo’). The format uses external program arclink fetch defined by the WE-
BOBS.rc ARCLINKFETCH PRGM parameter.
{combined}: SeisComP3 combined SeedLink/ArcLink request
The combined format will use SeedLink protocol for recent data and ArcLink protocol for data older than a delay. RAWDATA
must contain the string seedlinkhost:seedlinkport;arclinkhost:arclinkport;delayhours. It will use both external programs
defined in WEBOBS.rc SLINKTOOL PRGM and ARCLINKFETCH PRGM parameters.
{fdsnws-dataselect}: FDSN web-service dataselect request
Distant waveform request using the FDSN web-service protocol available at most of seismological data centers. RAWDATA must
contain the base URL, for example: http://service.iris.edu/fdsnws/dataselect/1/query? for IRIS.
{winston}: EarthWorm Winston wave server request
EarthWorm Winston wave server (WWS) protocol request from a distant or local server. RAWDATA defines the server with
host:port.
3.14.2 Generic time series
These formats will return time series of data channels, like the waveform formats do but usually the data sampling frequency
is lower than for seismic waveforms, so it can be managed using data files stored in local directories. Number of channels
depends on the data and can be selected and calibrated using the NODE’s calibration file.
{ascii}: Generic ASCII text files
Attempt to read generic text files with regular data columns. RAWDATA contains the full path and filename(s) using bash
wildcard facilities. The data files must be organized as regular columns of numbers (strings will produce a column of NaN),
any separator character, and the date and time must be defined as 3 (year, month, day) or 6 columns (year, month, day, hour,
minute, second) at some place (default is the 6 first columns). If there is no calibration file for a NODE, the header line will
be used to get the channel names.
For this format you may define optional additional FID * keys for each NODE to specify the format:
FID FS field separator character (default is semicolumn),
FID TIMECOLS index vector of columns defining date&time in order: year month day hour minute second,
FID NF number of data columns in the file, considering all non-numeric as separator (default is automatic),
FID HEADERLINES number of header lines (default is 1).
Generic ASCII format example 1: time + data channels 1 to 3.
Da te ; P_ 0; SO 2_0 ; H2 S_0 ;
06/ 0 6/20 17 18: 00:0 0; 752 . 5795 2 9; -0.06 129 9; -0.031172;
06/ 0 6/20 17 18: 00:0 9; 724 . 4458 5 2; -0.07 151 5; -0.024938;
FID * parameters to read example 1 file.
FID_FS|;
FID_TIMECOLS| 3 ,2 ,1 ,4 ,5 ,6
FID_NF|9
FID_HEADERLINES|1
Generic ASCII format example 2: data channel 1 (all NaN) + time + data channels 2 to 4.
VM AB 01 /01/ 12 06:2 0:11 132 338 40 .6
VM AB 01 /01/ 12 06:4 0:11 135 337 40 .7
VM AB 01 /01/ 12 07:0 0:11 133 336 40 .6
FID * parameters to read example 2 file.
FID_FS|\t
FID_TIMECOLS| 4 ,3 ,2 ,5 ,6 ,7
FID_NF| 10
FID_HEADERLINES|0
46 CHAPTER 3. BUILT-IN APPLICATIONS
{sql-table}: SQL-table request
Request to a SQL database using external program mysql.RAWDATA must contain the full command that will return the data
in the text format yyyy-mm-dd HH:MM:SS data1 data2 data3 .... The command must include two variables $date1 and
$date2 that will be replaced by the timespan request. Example:
mysql -h host -u user -ppasswd -Ddatabase -N -B -e ’SELECT time,data1,data2,data3 from $FID WHERE time
between ”$date1” and ”$date2”;’
will make a request from the database at server host on the table $FID and return timestamp and data columns. The
calibration file must define these 3 channels in that order.
{cr10xasc}: Campbell Scientific CR10X ASCII files
Daily data files from data loggers CR10X archived in a specific directory structure. RAWDATA contains the main directory path,
in which files are stored in the following subpath and name: FID/YYYY/YYYYMMDD.DAT. Each file has the data format:
PRGM,yyyy,doy,HM,data1,data2, ... ,dataN, where PRGM is the program number, yyyy the 4-digit year, doy the day of
the year (ordinal day), HM the hour and minute with leading blanks, and the data.
Campbell CR10X format example
121 ,2013 ,365 ,2340 ,8 .6971 , - 20.168 ,0 ,91.3 ,22.48 ,0 ,8 26.42 , 12.514 ,99999 ,0 ,0
121 ,2013 ,365 ,2350 ,8 .7294 , - 20.016 ,0 ,88.4 ,20.02 ,0 ,8 26.43 , 12.521 ,99999 ,0 ,0
{t0a5}: Campbell Scientific T0A5 ASCII files
Daily data files from Campbell Scientific data loggers in the T0A5 output format, archived in a specific directory structure.
RAWDATA contains the main directory path, in which files are stored in the following subpath and name: FID/YYYY/-
FIDYYYYDDD.DAT. Each file has the data format: ”yyyy-mm-dd HH:MM:SS”,data1,data2, ... ,dataN.
Campbell T0A5 format example
"2014-01-11 00:00:00",68148,12.1,16.07,15.29,100,938,0.02,0.02,0,7.875425,98.67353,10.86884,0 ,0,0,0,0,0,0,0
"2 014 -01 -11 00: 10:00" ,68 149 ,12.1 ,1 5.96 ,1 4.76 ,100 ,9 38 ,0.021 ,0 .021 ,0 ,7.200668 , 101.9742 , 11.35311 , 0 ,0 ,0 ,0 ,0 , 0 ,0 ,0
{porkyasc}: USGS Porky ASCII files
Daily data files from USGS Porky data systems, archived in a specific directory structure. RAWDATA contains the main directory
path, in which files are stored in the following subpath and name: FID/YYYY/YYYYMMDD.DAT. Each file has the data
format: DD-MMM-YYYY HH:MM data1 data2 ... dataN.
USGS Porky format example
01 - JAN -2014 00 :00 00000 00 029 0 0013 03181 0000 1 -00998 -00998 -00998
01 - JAN -2014 00 :05 00001 00 040 0 0010 03182 0000 1 -00998 -00998 -00998
3.14.3 Quakes catalogs
These are specific formats for PROCS dedicated to earthquake catalogs. These formats returns a list of event with preset
channels, like Latitude, Longitude, Depth, Magnitude, etc... There is no calibration file (if it exists it will be ignored). It is
possible to link this format with a Main Courante (MC3) database using the NODE’s FID MC3 with the MC3 name. In that
case some information from MC3 might be associated to identified events.
An other specificity of these formats is that all catalogs from different associated NODES will be concatenated in a single data
matrix. This allows to merge for instance, a distance worldwide catalog like USGS (for large earthquakes), a local catalog
from a local network, and an historical catalog in an old-fashion file format.
{hyp71sum2k}: Quake Hypo71 summary lines year 2000 compatible
Single file in the HYPO71 ASCII format identified by RAWDATA with full filename and path. The standard format is com-
pleted by two last columns: SCode for a 5-letter identification code, and File for the waveform filename. Note the file is
column formatted, without any delimiter, there is no leading zeros but blanks, and the longitude value is positive towards the
West.
3.14. DATA FORMATS AVAILABLE FOR PROCS 47
HYPO71 format example
# DA TE ORIGI N L AT_N L ON_W DEP TH MAG NO GAP DMIN R MS ERH ER Z Q SCode Fil e
184 3020 8 144 0 00.00 16 -44.00 61 -10.00 000.00 8.00 00 000 00.0 0.00 00 .0 00.0 0 T E9GM
201 4100 5 181 9 07.34 14 -48.70 61 -10.33 -0.24 D 1.52 8 166 0.3 0. 26 0.6 0.8 C EB1 2 0141 005 _18 190 0 . mq0
{fdsnws-event}: Quake FDSN WebServices event request
Distant event data request using the FDSN web-service protocol available at most of seismological data centers. It accepts the
QuakeML 1.2 format only. RAWDATA must contain the base URL, for example: http://service.iris.edu/fdsnws/event/1/query?
for IRIS.
{scevtlog-xml}: Quake SeisComP3-xml files
Reads a files architecture created by the SeisComP3 scevtlog module. RAWDATA defines the path root where events are stored
in a subdirectory structure as YYYY/MM/DD/eventID/eventID.last.xml in the SC3ML format.
3.14.4 GNSS solutions
These are specific formats for PROCS dedicated to positioning data from GNSS (Global Network Satellite Systems) like GPS
or GLONASS. These formats returns preset channels: Eastern, Northern, Vertical and Orbit type.
{gipsy-tdp}: JPL GIPSY-OASIS TDP files
TDP (Time Dependant Parameter) files results of the JPL GIPSY-OASIS processing in IRTF. The format uses only the position
part of the data: Time Dinit Dfinal error STA c ssss where Time is GPS date in seconds past J2000, cis the component in
geocentric referential, ssss the station name. P.RAWDATA contains the path root directory where daily solutions files are stores
in a subdirectory structure as FID/YYYY/FID/YYYY-MM-DD.FID.tdp*.
GIPSY-OASIS TDP format example
4 76 7 12 0 00 . 00 0 0 1 7 97 . 11 4 60 4 00 0 00 1 79 7 .1 1 46 3 38 4 42 1 9 .7 51 E -0 7 ST A Z A BD 0
4 76 7 12 0 00 . 00 0 0 - 53 75 . 91 966 100 0 00 - 53 75 . 91 974 126 823 2 .2 97 E -0 6 ST A Y AB D0
4 76 7 12 0 00 . 00 0 0 2 9 20 . 34 9 71 8 00 0 00 2 92 0 .3 4 97 5 97 7 47 2 1 .3 77 E -0 6 ST A X A BD 0
{globkval}: MIT GAMIT-GLOBK VAL files
Single file output of Gamit-GlobK processing in ITRF referencing. P.RAWDATA defines the full path filename of the .VAL result
file which contains solution timeseries for each component and each station.
GAMIT-GLOBK VAL format example
Com b inat i on of ALL ne twor ks
ILA M_GP S to E Solu tion 1 + 3 2 19759 4.81 0 m
20 12 12 19 11 59 3219 7 594.8 0 990 0.00626 -0 .0018 3 0 .00 626
20 12 12 20 11 59 3219 7 594.8 1 087 0.00433 -0 .0009 0 0 .00 433
...
20 13 12 17 11 59 3219 7 594.8 1 866 0.00519 -0 .0079 9 0 .00 519
Wmean 32197 5 94.8 1 84 m +- 0.0003 from 340 dat a . W RMS 5.2 mm , NRMS 1.19
Slope 15.01 + - 0.84 mm /yr , WRMS 3.1 mm , NRMS 0.70 , dur 0.99 <> 2013. 41 yr
Com b inat i on of ALL ne twor ks
ILA M_GP S to U Solu tion 1 + -0.750 m
20 12 12 19 11 59 -0. 74977 0.0191 0 0 .01410 0.01 910
20 12 12 20 11 59 -0. 74919 0.0104 8 0 .01471 0.01 048
...
20 13 12 17 11 59 -0. 80060 0.0137 0 -0.02614 0.0 1370
Wme an -0 .7686 m + - 0 .000 6 f rom 340 dat a . W RMS 9.3 mm , N RMS 0.8 2
Slope -10.66 + - 2.20 mm /yr , WRM S 8.8 mm , NRMS 0.78 , dur 0.99 <> 201 3.4 1 yr
3.14.5 Other specific formats
These formats are basically time series but the channels are predefined.
48 CHAPTER 3. BUILT-IN APPLICATIONS
{teqc-qc}: TEQC Rinex quality check
{naqs-soh}: NAQS State of Health
{wodbform}: WebObs database forms
This format is not selectable. It becomes active automatically when a PROC is associated to a FORM and its specific database.
In that case the data columns are determined by the FORM type.
Chapter 4
Administration
4.1 Users, Groups and Authorizations
4.1.1 Overview
WebObs uses its own AUTHORIZATION system, in addition to the Apache Authentication system, to identify its HTTP
USERS and control their individual ACCESS-RIGHTS to WebObs RESOURCES (ie. logical entities refering to files, processes,
html-pages, whatever).
AUTHORIZATION system elements:
•a USERS TABLE that further identifies the USERS defined in the Apache Authentication files (eg. .htpasswd),
•a GROUPS TABLE that merely defines groups of USERS, to simplify (reduce number of) access-rights definitions,
•RESOURCES are fully identified as resourceType.resourceName,
•RESOURCES TABLES are the resourceType tables containing their own resourceName descriptions,
•aresourceName description defines the relationship uid-or-gid has access-rights,
•Supported access-rights are:
– R = 1 Read
– E = 2 Edit = Read + Write
– A = 4 Admin = Edit + Create/Delete
4.1.2 Users table and Groups table
AWebObs USER is identified by its LOGIN (string) as also defined in the HTTP Authentication system. A row in the USERS
TABLE further defines a USER with the following information:
•LOGIN
•FULLNAME, the user’s name
•UID, a short identification string, usually the user’s name initials, to be used for access-rights and other functionnal
needs
•EMAIL, the email address (somebody@somewhere) used by the WebObs POSTBOARD system,
Two special UIDs are reserved for system use:
•?to identify a GUEST user (granted to undefined users for temporary/limited access to WebObs ),
•!to identify the WEBOBS OWNER.
Records of the GROUPS TABLE associate UIDs to GROUP names (aka GID). A GID must starts with a ’+’ sign. A USER
may be a member of more than one GROUP. A USER inherits all access-rights defined for the GROUP(s) it belongs to.
Four (4) special GROUPs are pre-defined in WebObs :+ADMIN,+DUTY,+OBSERVER and +VISITOR. They are
initially used to define access-rights to WebObs built-in tools and/or applications.
49
50 CHAPTER 4. ADMINISTRATION
4.1.3 Resource tables
The fully qualified name of a WebObs RESOURCE is resourceType.resourceName.
There are five (5) resourceType tables: authviews,authprocs,authforms,authwikis corresponding to the base WebObs ob-
jects and authmisc for any additional, unclassified, resourceNames definitions. They are already populated with resourceNames
related to WebObs built-in tools and applications.
The special resourceName ”*” stands for ”all resourceNames of this resourceType”.
resourceNames are strings, defined and documented by the developers of the WebObs tools or applications.
4.1.4 Managing Users and Authorizations
The USERS ADMIN page /cgi-bin/usersMgr.pl (built-in tool), initially restricted to the +ADMIN group, is used to create/-
modify/delete user and resources definitions.
USERS and RESOURCE TABLES have customization variables in the main configuration file WEBOBS.rc:
WEBOBS.rc (excerpt)
SQL_DB_USERS| $ { R OO T_ C ON F } / W E BO BSU S ER S . d b
SQL_TABLE_USERS| users
SQL_TABLE_AUTHPROCS| aut hp rocs
SQL_TABLE_AUTHVIEWS| aut hv iews
SQL_TABLE_AUTHFORMS| aut hf orms
SQL_TABLE_AUTHWIKIS| aut hw ikis
SQL_TABLE_AUTHMISC| aut hmisc
SQL_TABLE_GROUPS|groups
4.1.5 Developing with Users and Authorizations system
The WebObs::Users perl module is the built-in interface to the USERS/AUTHORIZATIONS objects and functions system.
Detailed programming information can be found in its ’perldoc’ documentation, such as:
•global variables USERS, USERIDS and CLIENT
•the special ’path-like’ specification for resourceNames
•functions: allUsers, clientHasRead, clientHasEdit, clientHasAdm, listRNames
Developers may add/define/use their own resourceName(s) for their specific needs.
4.1.6 Adding a new user
Registration of a new user is done in 3 steps:
1. new user must fill the form (see screenshot 4.1) by connecting to WebObs interface and click ’Cancel’ when asked to
login. The data (with encrypted password) will be stored as a new pipe-separated line in the file DATA/DB/reglog
and an e-mail will be sent to user and WebObs owner;
2. using Users Admin interface, administrator adds the user (see section 4.1.2);
3. add manually the encrypted password as a new line to the file CONF/htpasswd; this activates the Apache user.
4.2 PostBoard
4.2.1 Overview
WebObs tools and applications may wish to send (email) alerting/warning/information messages to WebObs USERs when
detecting special processing conditions or other events. Deciding who needs/wishes to receive such messages, and actually
sending them, should be as easy as possible from the developers point of view; furthermore, WebObs administrators should be
able to easily filter/choose which users should receive what, based on operationnal needs, authorizations concerns, and even
user’s choice of being (or not being) alerted.
The WebObs POSTBOARD system (notifications/subscriptions) addresses these needs. Elements of POSTBOARD architec-
ture:
4.2. POSTBOARD 51
Figure 4.1: Registration form for new users.
•Tools and applications simply and unconditionnaly send identified messages (NOTIFICATIONS) to POSTBOARD
•NOTIFICATIONS basically look like ”eventname|senderId|message”
•POSTBOARD is a daemon that tries to match the eventname of the NOTIFICATIONS it receives against active
SUBSCRIPTIONS that tell it what to do: either send a mail to a UID (or GID), or trigger a command, or both
•a SUBSCRIPTION is a row in the WebObs NOTIFICATIONS TABLE with the following fields:
eventname identifying the SUBSCRIPTION to match NOTIFICATIONS sent to POSTBOARD
validity indicating active/inactive
uid UID or GID to whom mail the NOTIFICATION
subject subject of the mail being sent
attachment optional, path of a file to attach to mail
action optional, a command to be executed
4.2.2 Event names
Event names identify and associate NOTIFICATIONS to SUBSCRIPTIONS:
•eventname = string[.[string]]
•string.string is known as the majorname.minorname form of an event-name
•majorname.minorname identifies a single subscription named majorname.minorname AND
•amajorname. subscription, if defined as such (don’t forget the ending dot!), will also match all majorname.minorname
notifications This is the way to define common mail/action to a set of notifications.
•some eventnames are already defined for internal WebObs usage. These reserved eventnames are : eventnode ,
formreq. , scheduler.alert , scheduler.warning , submitrc.
Example: a WebObs application may issue (notify) NOTIFICATIONs identified with myevent eventname; The SUBSCRIP-
TION myevent,Y,UID,mysubject,-,- is registered in the NOTIFICATION TABLE; the following mail will eventually be sent
by POSTBOARD when the application notifies ”myevent||the application message” :
mail for myevent notification
From: webobs@webobsaddr
To : UID ’s mai ladd r
Subject: [ W EBOBS _I D ] m ys ub ject
User - A gent : Mu tt /1.x. xx (20 00 -01 -01)
the app l icat ion mes sage
4.2.3 Managing PostBoard Subscriptions
The USERS ADMIN page /cgi-bin/usersMgr.pl (built-in tool), initially restricted to the +ADMIN group, is used to create/-
modify/delete the POSTBOARD SUBSCRIPTIONs in the NOTIFICATIONS TABLE.
52 CHAPTER 4. ADMINISTRATION
CODE/cgi-bin/postboard.pl is the Perl daemon.
CODE/shells/postboard is the command line interface to start/stop, query status and even send NOTIFICATIONs to POST-
BOARD. Usage: postboard [start|stop|status|kill|notify]
POSTBOARD also has customization variables in the main configuration file WEBOBS.rc:
WEBOBS.rc (excerpt)
SQL_DB_POSTBOARD|${SQL_DB_USERS}
SQL_TABLE_NOTIFICATIONS|notifications
POSTBOARD_NPIPE| / tmp / WEB OB SNP
POSTBOARD_MAILER|mutt
POSTBOARD_MAILER_OPTS| - nx
POSTBOARD_MAILER_DEFSUBJECT|WebObs notification
4.2.4 Developing with Notifications
The WebObs::Config perl module exports the notify function to be used to send NOTIFICATIONS to POSTBOARD. The
notify.m module plays the same role from MatLab code.
Detailed programming information can be found in CODE/cgi-bin/postboard.pl perldoc documentation, such as:
•the WebObs::Config::notify function syntax,
•eventnames naming conventions,
•notification string syntax: event-name|sender-id|message and automatic timestamp ,
•message component interpretation and special keywords,
•the special submitrc. eventname,
•POSTBOARD MAILER considerations,
•subscription’s ACTIONs considerations
4.3 Scheduler
4.3.1 Overview
The SCHEDULER is the daemon that controls the execution of WebObs batch JOBS. It has been developed to meet the
following needs that, for some of them, would have been more difficult to tackle, or simply have required as much development,
with a regular crontab architecture:
•schedule execution of a jobs based on the elapsed time since their previous execution,
•manage parallel executions of jobs,
•implement a mutually exclusive locking mechanism between jobs execution,
•implement a simple checking of CPU load to accept or delay jobs execution,
•centralize and normalize the jobs definitions, also with run-time parameters substitutions,
•standard output and error archiving and consultation,
•centralize reporting/history with housekeeping and HTML interface,
•accept dynamic jobs submission in addition to regular jobs,
•use WebObs POSTBOARD for errors/warnings and end-of-jobs notifications,
•provide both command line and HTML interfaces to JOBS and EXECUTIONS management
The SCHEDULER daemon is CODE/cgi-bin/scheduler.pl whose execution is controlled with the command line interface
CODE/shells/scheduler.
4.3. SCHEDULER 53
4.3.2 Configuration and Tables
The main configuration file WEBOBS.rc holds the CONF SCHEDULER variable that points to the SCHEDULER’s config-
uration file used to customize its execution environment. Default configuration file is scheduler.rc :
scheduler.rc
BEAT|2 # int erna l pr oces sing loop f requ ency in seconds
MAX_CHILDREN| 10 # m axi mu m n um ber of s i mu l ta n eo u sl y s ta r te d jo bs
PORT| 7761 # com mand s ’ int erp re ter udp p ort n um be r
SOCKET_MAXLEN| 1500; # com mands ’ i nt er pr et er max com ma nd s ize
SQL_DB_JOBS| $WEBO BS { ROO T_CO N F }/ WEBO BSJO BS .db # sqli te data base for JOBS and RUN S tables
DAYS_IN_RUN| 30 # nu mbe r of days J OBS are k ept in RUNS t abl e
DITTO_LOG_MAX| 500 # contr ols re peat ing me ssag es in log
DITTO_NTF_MAX| 10 00 # c on tr ol s r ep ea ti ng mes sa ge s n ot if ie d
CANCEL_SUBMIT| 60 0 # max s ec on ds sub mit te d JOB S w ait in Q ueue
CLEANUP_RUNS| 999 , zombie # how to tag z ombie RUN S ( u nkno wn end of job )
LOADAVG1_THRESHOLD| 0. 7 # ma x 1 - se c cp u l oad t hr es ho ld to s ta rt J OBS
LOADAVG5_THRESHOLD| 0. 7 # ma x 5 - se c cp u l oad "
LOADAVG15_THRESHOLD| 0.7 # ma x 1 5 - se c cp u l oa d "
LMI SS _B IAS | 10 # sec on d s to d el ay c an di d at e s on l oad - t hr e sh o ld
EMI SS _B IAS |4 # sec ond s to del ay c andi dates on enq busy
PAT H_ STD | $WE BOBS { RO OT _L OG S }/ j ob slogs # roo t pat h for al l STDO UT and STDE RR of JOB S
PAT H_ RES | $WE BOBS { RO OT _L OG S }/ res # dire ct or y to hold JO BS r es ou rces ( locks )
JOBS TABLE
JOBS to be scheduled are uniquely identified with a JID and defined into the JOBS TABLE by the following fields:
JID JOB’s ID unique string
VALIDITY flag indicates wether JID is eligible for execution
RESOURCE name a string identifying a mutually exclusive jobs lock
XEQ1, XEQ2 and XEQ3 3 components of the actual command that is started for JOB’s execution
INTERVAL required elapsed time (seconds) between two executions of the JOB
LOAD THRESHOLD max CPU LOAD value to allow execution of the JOB
LOGS PATH path of the JOB’s STDOUT and STDERR files
LAST START TIMESTAMP (not editable)
RESOURCE syntax
A RESOURCE is simply identified by its freely choosen name (a string not containing double-dash, ie –). It may also be a set
of individual resources (a ’+’ separated list of names): all of these individual resources must be simultaneously free for the job
to be executed.
XEQ1, XEQ2, XEQ3 syntax
XEQ1, XEQ2 and XEQ3 will be concatenated, in this order, to build the actual JOB command to be executed. Those fields
have no special meanings for execution, except XEQ2 for LOGPATH (see below), and only one is obviously required to build
a valid command; but they may ease maintenance and lisibility.
They all accept variables interpolation: ie. they may specify any number of variable names from the main configuration file
WEBOBS.rc, coded as $WEBOBS{variableName}.
JOBS LOGS PATHS syntax
JOBs can redirect/build their own STDOUT and STDERR, however the following rules are implemented as a default behavior
in the SCHEDULER:
•All JOBS outputs as a whole will be placed into the common $SCHED{PATH STD}directory,
•JOBs’ specific LOGPATH definitions are relative to this common directory
The following table shows LOGPATH syntax (left) and its full interpretation (right), where any subdirectories will be dynam-
ically created if needed, and pid is the JOB’s PID (ie. KID) :
name $SCHED{PATH STD}/name.std{out,err}
name/ $SCHED{PATH STD}/name/pid.std{out,err}
name/name/out $SCHED{PATH STD}/name/name/name/out.std{out,err}
(null) $SCHED{PATH STD}/pid.std{out,err}
54 CHAPTER 4. ADMINISTRATION
The following two redirection rules apply to any one of the above syntaxes:
>name (the default) overwrites previous file with same name
>>name appends to previous file with same name
The following TAGS are also available in the name(s) you supply for easier specification of unique log files:
{TS}replaced with job’s start-timestamp
{RTNE}replaced with job’s XEQ2 string, with any blanks (spaces) chars changed to underscores.
4.3.3 Jobs selection and execution
The SCHEDULER continously scan the JOBS TABLE to find CANDIDATES for execution: ie those VALID JOBS whose
LAST RUN TIMESTAMP is now older than their INTERVAL.
JOBS may also be submitted for immediate execution from the command line, or from another application, regardless of their
INTERVAL normal delay and of their VALIDITY flag. Submitted JOBS are automatically CANDIDATES and placed in a JOB
REQUEST QUEUE (JOBRQ) where they can stay no more than $SCHED{CANCEL SUBMIT}seconds.
The SCHEDULER then scans all CANDIDATES, starting with the JOBRQ, to actually start (execute) JOBS that fullfill their
CPU LOAD THRESHOLD and RESOURCE (lock) conditions. JOB execution’s command is the concatenation of the JID’s
XEQ1, XEQ2 and XEQ3 strings, in this order, and with ${WEBOBS}variables interpolation. Started JOBS are placed into
a RUNQ for monitoring and future end-of-job processing, and in the RUNS TABLE for reporting/history.
CANDIDATES that are not moved to the RUNQ because they don’t fullfill their CPU LOAD THRESHOLD and RESOURCE
(lock) conditions, will automatically be candidates again on the next scheduler’s beat; to avoid unnecessary overload and
reporting, the scheduler may delay these jobs from being candidates again by a small amount of seconds. Delay to be used
are defined by $SCHED{LMISS BIAS}for CPU LOAD THRESHOLD condition and $SCHED{LMISS BIAS}for RESOURCE
busy condition. Set these to 0 to disable delay.
JOBS are started as independent, parallel processes, children of the SCHEDULER, in their own process group; from there
on they are known as KIDS. The SCHEDULER doesn’t forget its KIDS once it forked them ! It waits for their termination
(non-blocking wait) to perform housekeeping and reporting about execution (mainly unlocking RESOURCEs, saving return
code and elapsed time to update the RUNS TABLE).
The precision at which JOBS are scheduled/executed is $SCHED{BEAT}seconds.
Scheduler’s job RESOURCEs, used as a locking mechanism between scheduled jobs, may be shared with external processes:
thus it is possible to also synchronize execution of scheduler’s jobs with non-scheduler machine’s activities and/or conditions.
The Scheduler’s commands ENQ and DEQ are the unique scheduler’s entry points to the locking mechanism.
Command line submit syntax
•JOBS may be submitted, for immediate execution, to the SCHEDULER using CODE/shells/scheduler and its submit
command
•specifying the JOB comes in two flavors:
–JID=<job’s id from JOBS TABLE >; Example: scheduler submit JID=myjob
–as a string defining the JOB, with the following comma-separated keywords:
∗XEQ1: , XEQ2: and XEQ3: to specify the JOB’s command
∗LOGPATH: optional, to specify the directory, relative to $SCHED{PATH STD}, for JOB’s STDOUT and
STDERR
∗RES: optional, JOB’s RESOURCE (lock)
∗MAXSYSLOAD: optional, CPU LOAD THRESHOLD
∗UID: optional, UID to be used for end-of-job notification
–Example: scheduler submit ’XEQ1:perl,XEQ2:/path/to/jobtst.pl,RES:mylock,UID:DL’
Note: submitted JOBs are given a unique, negative, JID.
4.3.4 Scheduler manager
The SCHEDULER MANAGER CODE/cgi-bin/schedulerMgr.pl built-in page, initially restricted to the +ADMIN group, is
used to create/modify/delete JOBS of the JOBS TABLE.
4.3. SCHEDULER 55
4.3.5 Scheduler runs
The SCHEDULER RUNS CODE/cgi-bin/schedulerRuns.pl built-in page, initially restricted to the +ADMIN group, is used
to display the RUNS TABLE (one day at a time) along with its corresponding, zoomable TIMELINE chart, to better visualize
JOBs executions elapsed times and parallelism.
4.3.6 Scheduler status
Both the SCHEDULER MANAGER and SCHEDULER RUNS built-in pages show the STATUS of the SCHEDULER:
56 CHAPTER 4. ADMINISTRATION
where:
STARTED, PID, USER when, under which PID and who started the SCHEDULER
uTICK, BEAT internal frequency in microseconds and main SCHEDULER loop frequency
PAUSED wether SCHEDULER is in PAUSE mode (not scanning JOBs, = 1)
#JOBSTART, #JOBSEND number of started and ended JOBs since ’STARTED’
KIDS number of currently started JOBs (KIDS)
ENQs number of currently held JOBs’ RESOURCEs
Paths of main SCHEDULER’s files
4.3.7 Scheduler command line
The SCHEDULER command line interface is CODE/shells/scheduler.
shells/scheduler
me@ he re: / op t / we bo bs / CO DE / sh ell s$ ./ s ch ed ule r
Usa ge : ./ s ch ed ul er { enq | de q | flog | job q | kill | p ause | ps| qs | qu ie t | re sume | ru nq | s tart | sta tu s | stop | s ub mi t | ve rb os e }
CODE/shells/scheduler sub-commands :
start start, if not already active
stop stop, waiting for any active kids to end
pause hold execution (suspend jobs processing)
resume resume execution
enq enq a resource
deq deq a resource
kill forced stop, not recommended
verbose log verbosity on
quiet log verbosity off
status display status/indicators/settings
jobq display JOBRQ
runq display RUNQ
ps display executing KIDS trees
flog force log backup and cleanup
submit place a job on the JOBRQ, requiring additional arguments, either:
1) jid=n where n is the JOB’s ID from the JOBS TABLE
2) keyword:value[,keyword:value,...] where
keyword in [XEQ1,XEQ2,XEQ3,MAXSYSLOAD,LOGPATH,RES,UID]
example scheduler status
me@ he re: / op t / we bo bs / CO DE / sh ell s$ ./ s ch ed ule r s ta tu s
Pls wa it ...
STA TTIM E =20 14 -02 -05 06 :04:58
STA RTE D =20 14 -02 -05 06 :04:0 2
PID =6725
USER=root
uTICK = 1000 000
BE AT =2
LO G =/ o pt / w eb ob s / LO GS / sch ed ule r . lo g
JOBSDB =/ opt / web obs / CONF / WEBO BS JOBS .db
JO BS S TD io =/ op t / we bobs / L OG S / jo bs lo gs
JO BS R ES ou rc e =/ op t/ we bo bs / L OGS / res
PAUSED=0
#JOBSTART=2
# JOBS END =2
KI DS =0
EN Qs =0
example runq and ps
me@ he re: / op t / we bo bs / CO DE / sh ell s$ ./ s ch ed ule r run q
4.4. WOC 57
Pls wa it ...
RU NQ (1 4 0 72121 3 4.216 6 3)
kid =7567
OR G =R
ui d =
kid cm d =/ op t / we bo bs / COD E /cgi - bin / j ob tes te r . pl 40
re s =
ji d = -2
logfd =./
started=1407212135.2194
log fn = und ef
RU NQ (1 4 0 72118 9 0.245 1 2)
kid =7060
OR G =S
ui d =
kid cm d =/ opt / w eb ob s / CO DE / ma tl ab / bi n / lin ux - 64/ r un _m cc sef ra n3
res=sefran3
ji d = se fr an
logfd =./
sta rte d = 14072 1 1890. 4 6864
logfn = sef ra n3
me@ he re: / op t / we bo bs / CO DE / sh ell s$ ./ s ch ed ule r p s
PI D PG RP E LA PS ED % CP U % M EM CM D
27 69 276 9 02 : 41 :4 0 0. 0 0.1 / b in / b ash
70 50 70 34 04 :21 0.1 0.2 p erl s ched u ler . pl -v
70 60 706 0 04 : 19 0 .0 0.0 / bi n /sh / op t / we bo bs / COD E / ma tl ab / bi n / lin ux -64 / r un _m cc sef ra n3
70 68 706 0 04 : 18 6 .7 3.3 / o pt / w eb ob s / CO DE / m at la b / bi n / lin ux - 64/ s efr an 3
75 67 756 7 00 : 14 0.0 0 .0 / usr / bin / pe rl / o pt / w eb ob s / CO DE / cgi - b in / j ob te ste r . pl 40
4.4 WOC
WOC, the WebObs Console, is a command-line tool to query and update internal WebObs structures. Initially built as a
developer’s set of debugging tools and coding examples, WOC also contains some WebObs administrator’s tools.
WOC can be run in interactive mode, interpreting and executing woc-commands at the console’s WOC prompt, or batch
mode, executing a single woc-command passed as argument. WOC is also available from a WebObs html page thru the use
of woc.html + woc.js .
List of woc-commands :
%WEBOBS [key] dump %WEBOBS key or all keys
-%WEBOBS value query which %WEBOBS key(s) holds value
%OWNERS dump all %OWNRS
%DISCP [discp] dump %DISCP discp discipline or all
%USERS [login] dump %USERS login or all
authres list all auth resources
user login query DB USERS for login
newuser add a user
newgroup add a users group
deluser delete a user
delgroup delete a users group
grant auth grant access in auth table
auth login dump login authorizations
%NODES [key] dump %NODES key or all
proc [proc] dump PROC proc or all
form [form] dump FORM form or all
view [view] dump VIEW view or all
node [node] dump NODE node or list node names
newnode node as other define a new node as othernode
delnode node delete a node
nodegrids [node] list grids that reference node
nodedev [node] list features+devices for node (or all dev)
statnodes statistics on node+grids
readcfg file readCfg file
dbjobs list all jobs definitions
newjob add a job definition
dbruns list all jobs last run info
sys print system information
! cmd exec shell cmd (WebObs vars single-quoted for interpolation)
= expr exec perl expr (interactive mode only)
dd keys of main hashes and their occurence
58 CHAPTER 4. ADMINISTRATION
ddxref keys of main hashes + their occurence + cross-reference
help this help text
quit make a guess
WOC session example
WOC version 1.6, Apr2013
At WOC prom pt: comman d , ’ help ’ , or ’quit ’
<WOC > sta tnod e s
14 nod e d i rect ories
2 nodes have no gr id
GCSCC21 GCSREV1
0 no de has no pr oc
1 no de has no vi ew
ISBFDF0
<WOC > sys
Linux 3.2.0 -67 - ge neric # 101 - Ubu nt u SMP Tue Jul 15 17 :46 :1 1 U TC 201 4 GNU / L inux
Pe rl $^V = v5 . 14.2
$E NV { P ATH } = / us r/ lo ca l / sb in: / usr / lo cal / bi n: / usr / sbi n: / usr / bin: / sb in : / bin: / usr / g ames :
@I NC : / opt / w eb ob s / We bOb s - beta - 1. 6. 5/ C OD E /cgi - b in: / etc / pe rl : / usr / lo ca l / li b / perl / 5. 14 .2 : / usr / lo ca l / sha re / p erl / 5. 14. 2 : / usr / l ib / p er l5 : / usr / sh ar e / per l5 : / us r / lib / p er l / 5.14 : / us r / sh ar e / pe rl / 5.14 : / us r / lo ca l / lib / sit e_p erl : .
$POS I X::VE RSION = 1.2 4
POSI X::tz n ame = CET C EST
$E NV { TZ } =
/ et c / loc al tim e -> CET -1 C EST , M3 .5.0 , M10 .5. 0/ 3
local now: 201 4 -08 -05 08 :46:33 CE ST (+0200 ) 14 0722 1193 (140 722119 3)
UTC now: 2014 -08 - 05 06 : 46: 33 1407 21759 3
$E NV { L ANG } = en _U S .UTF - 8
Locale ( s) S uppor te d / Insta ll ed : e n_US = S /I; fr_ FR = S /I ;
UMASK 002
PI D 1 24 92 s ta rt ed 1 40 72 21 193 b y s om eo ne (10 00 /10 00) in / op t / we bo bs / CO NF
" We bObs - Par is " W ebObs - beta - 1. 6. 5 [/ et c / we bo bs . d - > / o pt / w eb ob s / CO NF ]
<WOC > q uit
By e .
4.4.1 Overview
Chapter 5
Developments
5.1 Use PROC’s output graphics facilities
To display PROC’s output graphics and data, WebObs uses a script named /cgi-bin/showOUTG.pl that can be used with
external data. Products must be images in PNG format, with a thumbnail in JPG format and optional EPS and TXT files.
The script proposes two different display formats:
1. per time scales: each image corresponds to a preset moving time window;
2. per dated events: each image is associated to a timestamp (date and time).
First, you must create a new PROC using the web interface with name MYPROC for example, and from any template (choose
Generic time series for instance). Then you will have to name and store image files by respecting some rules explained below.
Note that all files must be readable by the apache user (in WebObs automatic processes, the files are owned by the WebObs
owner and group-readable).
5.1.1 Graphs per time scale
To display graphs per time scale, the PROC must define the minimum following keys:
MYPROC.conf
= ke y | va lu e
NAME| My P RO C t it le
TIMESCALELIST| ts1 , t s2 , t s3
SUMMARYLIST| SUM MAR YA , S UM MA RY B
ts1,ts2,ts3 are 2-letter minimum length time scale keys (at least one key is needed, see Table 5.2 for valid keys and syntax).
SUMMARYA and SUMMARYB are optional short names for additional summary graphs (all nodes). You may also associate
NODES to this PROC if you want to show some per-node graphs. The outputs must be named and placed as:
/opt/webobs/OUTG/PROC.MYPROC/graphs/SUMMARY{A,B} {ts1,ts2,ts3}.{png,jpg,eps}
where .png are the full resolution images, and .jpg files (same name as .png) are the thumbnails. These two files are mandatory.
Optional .eps extension containing a vectorial image will give access to it through a link.
If you want to show individual associated node graphs, for instance from NODEID1, you name the files as:
/opt/webobs/OUTG/PROC.MYPROC/graphs/nodeid1 {ts1,ts2,ts3}.{png,jpg,eps}
Note the NODE’s ID must be written in lower case in the filename. .eps extension file is optional.
You can have one data export file for each summary and node output. The files must be placed as:
/opt/webobs/OUTG/PROC.MYPROC/exports/{SUMMARY*,nodeid1} {ts1,ts2,ts3}.txt
If the WebObs has been installed and configured by changing the default root path and subdirectories, you might look into
/etc/webobs.d/WEBOBS.rc for the following variables to define the paths:
$WEBOBS{ROOT OUTG}/PROC.MYPROC/$WEBOBS{PATH OUTG GRAPHS}
$WEBOBS{ROOT OUTG}/PROC.MYPROC/$WEBOBS{PATH OUTG EXPORTS}
59
60 CHAPTER 5. DEVELOPMENTS
5.1.2 Graphs per event
To display graphs per event, the PROC must define only one key:
MYPROC.conf
= ke y | va lu e
NAME| My P RO C t it le
for the page title.
Events must be referenced to a date (year, month, day) and will be presented sorted by month in one page per year, showing
the image thumbnails. One event can contain multiple images that will be shown together as thumbnails when clicking on
it. The last display level is the full scale image itself. There is no rule for eventID and images filenames (excepted the file
extensions):
/opt/webobs/OUTG/PROC.MYPROC/events/YYYY/MM/DD/eventID1/*.{png,jpg,eps,pdf,txt}
But it is better to use self-explanatory filenames since it will be displayed as popup windows on mouse over the thumbnails.
Optional extensions .eps,.pdf and .txt will give access to supplementary files through links. You must also define at least one
preferred image to be display as thumbnail on the main page, by creating a symbolic link to the .jpg file. The link basename
has no importance but the extension.
/opt/webobs/OUTG/PROC.MYPROC/events/YYYY/MM/DD/eventID1/link.jpg →maineventimage.jpg
5.2 SUPERPROCS: Templates for applications development
5.2.1 Superprocs
Appendix
Table 5.1: Data raw formats for PROCS
# WE BOBS Raw fo r mats defini t i on for PROC S and N ODES
#
# ke y : u sed i n r ea dfm tdat a .m , read nod e .m and { show , f orm } NO DE . pl
# supf mt : su p e rformat ( for d ispla y gro u ping )
# nam e : n ame for d is pl ay in { show , for m } NODE . pl
# FI D : a dd itio nnal FID _x ke ys
#
# U p date d : 2018 -09 -29
#
= ke y | su pf mt | na me | F ID
#
| | -|
ds v | ASCII | de limiter - se para ted values file | PR EPRO CES SOR , FS , TIMEC OLS , NF , HEAD ERLINE S
sql - t ab le | DB | S QL d a ta ba s e w it h s im pl e ta ble |
min is eed | MSEED | min iS EE D f ile |
see dl ink | MSEED | SEE DL in k d ata str eam |
arclink| MSE ED | S ei sC om P3 Ar cL in k d ata r eq ue st |
com bi ned | MSEED | Sei sC om P3 See dL in k / Ar cL in k d ata re qu es t |
fdsnws - d atase le ct | MSEED | FDSN Web S ervi ces data s ele ct |
winston| EAR TH WO RM | Eart hW orm W inst on Wave S erver d ata r eques t |
gipsy | G NSS | JPL GIPSY - O AS IS . t dp fi le |
gipsyx| GNSS | JPL G ip sy X . t dp fi le |
glo bk val | GN SS | MIT GAM IT / G LO BK VAL fil e |
usgs - r neu |GNSS|USGS RNEU file|
cr1 0x asc | CAM PBELL | C am pbell Sci en ti fic CR10X data f ile |
toa5| CAM PB ELL | Cam pb ell S cient if ic TOA5 d ata f ile |
tob1| CAM PB ELL | Cam pb ell S cient if ic TOB1 d ata f ile |
por ky asc | ASC II | USG S P orky d at a fil e | AF MA LA RM
hyp 71 su m2k | QUAKE | Q ua ke H ypo7 1 sum ma ry l ines | MC3 , MAG TY PE _DEFA UL T , M AG ER R_ DE FAU LT
fd snw s - eve nt | QUA KE | Qua ke FDS N W ebS er vi ce s eve nt r eq ue st | MC3 , M AG TY PE _DEFA UL T , MAGE RR_ DE FAU LT
scevtlog -xml| Q UA KE | Qua ke S eisC omP3 - xml fil es | MC3 , M AG TY PE _D EF AU LT , M AGE RR_ DE FAU LT
mc 3 | MC3 | Mai nCo ura nte dat aba se |
naqs - s oh | ASC II | NAQ S S tate of H ea lth | N AN OS TA TY PE
te qc - qc | A SCII | T EQC R inex Qu al it y C heck |
meteofrance| A SC II | M ete o - F ra nc e r ai ng a ug e |
mat - f ile | WO | M atl ab MA T - fi le |
Table 5.2: Time scale keys (xis an integer).
Key Time scale
xsx seconds
xnx minutes
xhx hours
xdx days
xwx weeks
xmx months
xyx years
xllast x data
rx reference to date REFx DATE
all all data
61
62 APPENDIX
Table 5.3: Marker type list
Symbol Marker
.Point
+Plus sign
*Asterisk
xCross
oCircle
sSquare
dDiamond (vertical rhombus)
^Upward-pointing triangle
vDownward-pointing triangle
>Right-pointing triangle
<Left-pointing triangle
pFive-pointed star (pentagram)
hSix-pointed star (hexagram)
Table 5.4: Line Style list
Symbol Line style
-Solid line
-- Dashed line
:Dotted line
-. Dash-dot line
Table 5.5: Some basic R,G,B colors
R,G,B Color
0,0,0 Black
1,1,1 White
1,0,0 Red
0,1,0 Green
0,0,1 Blue
1,1,0 Yellow
1,0,1 Magenta
0,1,1 Cyan
Table 5.6: Some built-in colormaps
Name Description
jet
hsv
landcolor
seacolor
white
gray
hot
cool
bone
pink
copper
spring
summer
autumn
winter
63
Table 5.7: Date string format list. “Datenum” column indicates if the format is valid for date/time string as key
value Number Datenum String Example Comment
-1 automatic default value
0OK ’dd-mmm-yyyy HH:MM:SS’ 01-Mar-2000 15:45:17
1OK ’dd-mmm-yyyy’ 01-Mar-2000
2’mm/dd/yy’ 03/01/00
3’mmm’ Mar
4’m’ M
5’mm’ 03
6’mm/dd’ 03/01
7’dd’ 01
8’ddd’ Wed
9’d’ W
10 ’yyyy’ 2000
11 ’yy’ 00
12 ’mmmyy’ Mar00
13 ’HH:MM:SS’ 15:45:17
14 ’HH:MM:SS PM’ 3:45:17 PM
15 ’HH:MM’ 15:45
16 ’HH:MM PM’ 3:45 PM
17 ’QQ-YY’ Q1-96
18 ’QQ’ Q1
19 ’dd/mm’ 01/03
20 ’dd/mm/yy’ 01/03/00
21 ’mmm.dd,yyyy HH:MM:SS’ Mar.01,2000 15:45:17
22 ’mmm.dd,yyyy’ Mar.01,2000
23 OK ’mm/dd/yyyy’ 03/01/2000
24 ’dd/mm/yyyy’ 01/03/2000
25 ’yy/mm/dd’ 00/03/01
26 ’yyyy/mm/dd’ 2000/03/01
27 ’QQ-YYYY’ Q1-1996
28 ’mmmyyyy’ Mar2000
29 OK ’yyyy-mm-dd’ 2000-03-01 ISO 8601
30 OK ’yyyymmddTHHMMSS’ 20000301T154517 ISO 8601
31 OK ’yyyy-mm-dd HH:MM:SS’ 2000-03-01 15:45:17
64 APPENDIX
Table 5.8: Suggestion for NODE ID code: NDTSSSS
Letter Code Comment
N= Network IIPGP
GOVSG
MOVMP
ROVPF
PPVMBG
D= Domain SSeismology
DDeformations
GGeophysics
CChemistry
IImagery
MMeteorology
PPhenomenology
AAcquisition
DT = Technique SB Broad-band
SZ Short-period
DC Continuous GPS
DT Tilmetry
DD Distancemetry
DE Extensometry
GM Magnetometry
GE Electric
CS Hot Springs Analysis
CG Gas Analysis
CD DOAS
MW Weather station
PJ Journal Phenomenology
PE Eruption
AT Transmission
AB Buildings
Acknowledgments
A 15-year history summary.
Episode I. The WebObs project was born in September 2000 when Fran¸cois Beauducel has been assigned to the Guadeloupe
volcanological observatory in Lesser Antilles. First ideas of an integrated monitoring and management system have risen
thanks to fruitful discussions with Christian Ant´enor-Habazac,Jean-Christophe Komorowski and St´ephane Acounis. Quickly
(and dirtily) developed in about a year of sparse hours, a first version of WebObs was presented in Paris on January 2002
[2], containing most of the present content: station files, networks, automatic graphs for seismic, deformation, geochimia and
weather stations, shared calendar... During the first two years of the project, there was a single developer, moreover, a scientist
during its overtime work and not a dedicated computer specialist!
Episode II. From August 2002 to December 2005, Didier Mallarino was the first computer engineer who invested a part of its
time to improve the codes and configuration files, especially by developing more robust and flexible Perl GCI scripts [3,4,1].
In 2004, a version of WebObs has been partially duplicated and adapted for a public website (CDSA).
Episode III. From 2006 to 2010, some code improvements where made by a second computer engineer Alexis Bosson:
particularly, the system was internationalized and a first effort was made to integrate WebObs with observatory acquisition
chain seismology standards [5]. During these years, the system worked in a relatively stable production state, and it was
adapted and partly installed in different observatories: Paris (thanks to Fran¸cois Truong [6]), Addis-Abeba (thanks to Alexandre
Nercessian), Martinique (thanks to Jean-Marie Saurel and Benoˆıt Costes), Montserrat (thanks to Alexis Bosson and Roderick
Stewart) and later in 2012 at La R´eunion (thanks to Patrice Boissier and Philippe Kowalski).
Episode IV (A New Hope). In 2012, WebObs obtained its first dedicated funding support from the French Ministry of
Ecology, thanks to Steve Tait,Arnaud Lemarchand and Pierre Agrinier. A very significant contribution has been made by
Didier Lafon, the first computer engineer working 100% on the project. Taking advantage of 10 years of production feedback,
he reassessed the whole coding concept, improved and standardized the codes, made library modules and administration tools,
wrote technical documentation, put all this under a versioning control system and built the first Linux installation package.
This allowed to install a first alpha and beta version at Merapi observatory (thanks to Ali A. Fahmi), then the same codes
in Guadeloupe, Martinique and La R´eunion observatories, and start a real collaborative development. During this last period,
we welcomed additional contributors, as developers or end-users: Xavier B´eguin,Jean-Marie Saurel,Stephen Roselia,Patrice
Boissier,Laura Henriette, and of course all the observatory teams under the direction of Jean-Bernard de Chabalier,Val´erie
Clouard,Andrea Di Muro,Nicolas Villeneuve,C´eline Dessert,Aline Peltier,Roberto Moretti.
Episode V. In October 2018, WebObs code has been released on https://github.com/IPGP/webobs.
65
66 ACKNOWLEDGMENTS
Bibliography
[1] F. Beauducel. Surveillance op´erationnelle des volcans fran¸cais : d´eveloppements r´ecents `a la Guadeloupe. G´eosciences
BRGM, 4:64–68, 2006.
[2] F. Beauducel and C. Ant´enor-Habazac. Quelques ´el´ements d’une surveillance op´erationnelle... In Observatoires Vol-
canologiques. Institut de Physique du Globe de Paris, 2002.
[3] F. Beauducel, C. Ant´enor-Habazac, and D. Mallarino. WEBOVS : Integrated monitoring system interface for volcano
observatories. In IAVCEI General Assembly, Chile, 2004.
[4] F. Beauducel, C. Ant´enor-Habazac, and D. Mallarino. WEBOVS: Integrated monitoring system interface for volcano
observatories. In European Seismological Commission Annual Workshop, Saint-Claude Guadeloupe. IAVCEI / IPGP, 2005.
[5] F. Beauducel, A. Bosson, F. Randriamora, C. Ant´enor-Habazac, A. Lemarchand, J.-M. Saurel, A. Nercessian, M.-P. Bouin,
J.-B. de Chabalier, and V. Clouard. Recent advances in the Lesser Antilles observatories Part 2 : WebObs - an integrated
web-based system for monitoring and networks management. In European Geophysical Union General Assembly, Vienna,
April 2010.
[6] F. Truong, X. Lalanne, and A. Chulliat. MAGIS: The information system of IPGP magnetic observatories. In Proceedings
of the XIIIth IAGA Workshop on Geomagnetic Observatory Instruments, Data Acquisition and Processing, June 9-18 2008,
Golden, USA, 2009.
67

Navigation menu