Installation

RGSM software package

Obtain the gsm script from gempa and use it to install the RGSM package:

1. Add the RGSM packages to the list of packages:

   $ ./gsm setup
   

2. Update the package repository list and install the added package. RGSM is provided by the report-generators package:

   $ ./gsm update
   $ ./gsm install report-generators
   

Software dependencies

RGSM may require installing additional software packages. The packages and their installation depends on the installed Linux distribution. The install script install-report-generators.sh is provided for various Linux flavors in $SEISCOMP_ROOT/share/deps/[flavor]. It can be used for installing the software requirements in the same way as the SeisComP software requirements.

Use the seiscomp script to install the required software dependencies:

$ seiscomp install-deps report-generators

---

Setup

RGSM configuration

The module configuration parameters are stored in the configuration file rgsm.cfg located either in the directory @SYSTEMCONFIGDIR@ or in @CONFIGDIR@.

Configure the parameter smModule to set the application.

For shard:

smModule = shard

For sigma/autosigma:

smModule = sigma

Note

At the moment, either SHARD or SIGMA/AUTOSIGMA can use RGSM. To use it eventually for both modules you need to create an alias, for details see Alias documentation.

SHARD and SIGMA/AUTOSIGMA templates are placed in their respective directories: $SEISCOMP_ROOT/share/rgsm/[shard|sigma]/templates. Only templates within this directory are used by RGSM. The output report name is same as the template name just ending with ‘.pdf’. To set the templates use templateFiles, e.g., for a single template:

templateFiles = template.tex

RGSM allows to create multiple reports simultaneously by providing multiple templates, e.g., for generating multiple reports in different languages. Thus, just add additional templates separated by comma without any space character:

templateFiles = template_lang1.tex,template_lang2.tex,template_lang3.tex

Note

Currently SHARD only support exactly one template file as value for templateFiles. The name of the output report is fixed to incident.pdf.

For archiving created reports and all related files, set an archive directory via archiveDir. This will copy the content of the configured report directory (defined in the module config of SHARD or SIGMA/AUTOSIGMA) to the given path:

archiveDir = path/to/ArchiveDir

SHARD and SIGMA/AUTOSIGMA setup

RGSM can be called by a module or can be started via the command line.

Call by module

To enable RGSM as report-generation tool within SHARD or SIGMA/AUTOSIGMA, the corresponding module configuration needs to modified.

SHARD:

report.exportScript = @ROOTDIR@/bin/rgsm

SIGMA/AUTOSIGMA:

output.exportScript = @ROOTDIR@/bin/rgsm

Command line

It is possible to use RGSM on the command line. This allows a faster way of (re)producing reports for existing report-directories, without starting any application, e.g., to test new templates or debugging.

SHARD:

rgsm path/to/incidentDir [--templateFiles=templateName.tex --smModule=shard --debug]

SIGMA/AUTOSIGMA:

As SIGMA/AUTOSIGMA exports three arguments, RGSM needs to be called like this:

rgsm _ _ path/to/incidentDir [--templateFiles=templateName1.tex,templateName2.tex --smModule=sigma --debug]