toast

Software for tsunami simulation and verification.

Module Configuration

etc/defaults/global.cfg

etc/defaults/toast.cfg

etc/global.cfg

etc/toast.cfg

~/.seiscomp/global.cfg

~/.seiscomp/toast.cfg

toast inherits global options.

Note

Modules/plugins may require a license file. The default path to license files is @DATADIR@/licenses/ which can be overridden by global configuration of the parameter gempa.licensePath. Example:

gempa.licensePath = @CONFIGDIR@/licenses

forecastZones

Type: list:string

Registration of forecast zones.

impactReports

Type: list:string

Registration of impact reports. The first element of the list defines the initial sort order.

incidentMinimumMagnitude

Default: 0.0

Type: float

Minimum magnitude to create an incident for events received by messaging. If the magnitude of an event is smaller, no incident is created by TOAST.

incidentMaximumDepth

Default: 100.0

Unit: km

Type: double

Maximum depth to create an incident for events received by messaging. If the depth of an event is deeper, no incident is created by TOAST.

isoInterval

Default: 30

Unit: min

Type: int

Interval for arrival lines (has to be provided by simulation backend). TOAST displays the arrival lines as follows: full hour: solid line, half hour: dashed line, otherwise: dotted line.

liveTabs

Type: list:string

Registration of live tabs.

runupPercentiles

Default: median

Type: list:string

Registration of runup percentiles. The first element of the list defines the initial sort order.

processAutoMT

Default: false

Type: boolean

Enables/disables the usage of automatically generated moment tensors for event processing. By default only manual confirmed moment tensors will be taken into account.

sourceRegions

Type: list:string

Usually more than one grid file is avaibable for the same earthquake location and the automatic system does not know which one to choose. Use this option to define which bathymetry grid should used for automatic processing(Strg + N).

Registration of source regions. Each entry maps one or more regions to a bathymetry file. The entries are evaluated in FIFO order. If none of the entries matches the algorithm tries to select a fallback grid.

alwaysShowAdditionalOptions

Default: false

Type: boolean

Always show "Execute with additional options" dialog before running templates. If "false", then only after long click and selection.

confirmationRequired

Default: true

Type: boolean

Show "Additional confirmation required" dialog before running templates, or more precisely: before executing ClearSilver functions "save" and "addScript" in the templates.

startRegion

Type: list:double

Shows the rectangular region on the central map at the start of TOAST. Define the rectangle with a list of 4 values: latmin, lonmin, latmax, lonmax.

Note

displacementVectors.* Configure visualization settings for the coseismic displacement arrows (GNSS) in Map view. Note that if they are set using the dialog in TOAST, they are saved to the user configuration file at @CONFIGDIR@/toast.cfg and not to system configuration file at @SYSTEMCONFIGDIR@/toast.cfg.

displacementVectors.arrowHeadLength

Default: 12

Unit: px

Type: int

Length of the arrow head.

displacementVectors.arrowHeadWidth

Default: 8

Unit: px

Type: int

Width of the arrow head.

displacementVectors.arrowLineWidth

Default: 2

Unit: px

Type: int

Width of the arrow line.

displacementVectors.maxVisibleLength

Default: 300

Unit: px

Type: int

Length of the largest visible displacement arrow if screenDependingScaling is ‘true’.

displacementVectors.maxVisibleLengthVertical

Default: 200

Unit: px

Type: int

Length of the largest visible vertical displacement arrow if screenDependingScaling is ‘true’.

displacementVectors.minThreshold

Default: 0

Unit: mm

Type: int

Only arrows with a length larger than minThreshold are visible.

displacementVectors.scale

Default: 20

Type: int

Scaling factor for the arrows if screenDependingScaling is ‘false’.

displacementVectors.scaleVertical

Default: 20

Type: int

Vertical scaling factor for the arrows if screenDependingScaling is ‘false’.

displacementVectors.screenDependingScaling

Default: true

Type: boolean

If ‘true’, then the largest visible arrow is scaled to maxVisibleLength. If ‘false’, then the length of the arrows is fix with respect to the map and changes with zoom level.

displacementVectors.verticalScalingEnabled

Default: false

Type: boolean

If ‘true’, then the scaling of the vertical displacement arrows is independent of the scaling of the horizontal arrows.

Note

filter.* Define incident and simulation filters for the drop-down menu in the Database panel. These profiles are used automatically and need not be registered.

Note

filter.incidents.$name.* $name is a placeholder for the name to be used.

filter.incidents.$name.magnitude

Default: 0.0

Type: float

Minimum magnitude.

filter.incidents.$name.depth

Default: 6500

Unit: km

Type: float

Maxmimum depth.

filter.incidents.$name.timeSpan

Default: -1

Unit: s

Type: int

Show incidents not older than "timeSpan" seconds.

filter.incidents.$name.simulationCount

Default: false

Type: boolean

If set to true only incidents with simulations will be shown, if set to false vice versa.

filter.incidents.$name.observationCount

Default: false

Type: boolean

If set to true only incidents with picks will be shown, if set to false vice versa.

Note

filter.simulations.$name.* $name is a placeholder for the name to be used.

filter.simulations.$name.simulation

Type: list:string

Show only simulations of these simulation backends.

filter.simulations.$name.sortColumn

Default: Residual

Type: string

Sort table by this column.

filter.simulations.$name.descendingOrder

Default: true

Type: boolean

Sort table descending (true) or ascending (false).

filter.simulations.$name.maxNumberOfSims

Default: -1

Type: int

Limit the number of shown simulations.

filter.simulations.$name.calculationDuration

Default: -1

Unit: min

Type: int

Show simulations with a calculation duration of at least that time.

filter.simulations.$name.trigger

Default: all

Type: string

Show simulations with that trigger type. Three possible options: show only manually triggered simulations (manual), only automatically triggered simulations (automatic) or simulations of both types (all).

Note

forecastZones.* Define forecast zone profiles. Register the profiles at ‘forecastZones’. Note that forecast points have to be defined and registered at simulation backends like easywave2.

Note

forecastZones.$name.* $name is a placeholder for the name to be used and needs to be added to forecastZones to become active.

forecastZones = a,b
forecastZones.a.value1 = ...
forecastZones.b.value1 = ...
# c is not active because it has not been added
# to the list of forecastZones
forecastZones.c.value1 = ...

forecastZones.$name.filename

Type: string

Absolute filename without file extension

forecastZones.$name.whitelist.country

Type: list:string

List of countries to include when loading forecast zones.

forecastZones.$name.whitelist.exBoxID

Type: list:int

List of ExBoxIDs to include when loading forecast zones.

forecastZones.$name.blacklist.country

Type: list:string

List of countries to exclude when loading forecast zones.

forecastZones.$name.blacklist.exBoxID

Type: list:int

List of ExBoxIDs to exclude when loading forecast zones.

Note

impactReports.* Define impact report types for the Impact Reports tab. These profiles are used automatically and need not be registered.

Note

impactReports.$name.* $name is a placeholder for the name to be used and needs to be added to impactReports to become active.

impactReports = a,b
impactReports.a.value1 = ...
impactReports.b.value1 = ...
# c is not active because it has not been added
# to the list of impactReports
impactReports.c.value1 = ...

impactReports.$name.text

Type: string

Type selection box text

impactReports.$name.toolTip

Type: string

Tool tip shown when the mouse is over the selected type item

Note

liveTab.* Define Live tabs containing bulletin templates. Register the profiles at ‘liveTabs’.

Note

liveTab.$name.* $name is a placeholder for the name to be used and needs to be added to liveTabs to become active.

liveTabs = a,b
liveTab.a.value1 = ...
liveTab.b.value1 = ...
# c is not active because it has not been added
# to the list of liveTabs
liveTab.c.value1 = ...

liveTab.$name.title

Type: string

Title of the tab

liveTab.$name.templ

Type: list:string

List of registered templates associated with this live tab. The sort order in the view follows the order here.

liveTab.$name.buttonText

Default: Disseminate

Type: string

Text of the disseminate button

Note

matching.* Configure matching criteria which decide whether a similar simulation already exists or if a new simulation should be created. This is useful to reduce the number of simulations which are created in order to save disk space and computing time and to make the selection of the best simulation easier.

matching.magnitude.variance

Default: 0.1

Type: double

Maximum magnitude variance. The matching options control whether a new simulation (scenario) is actually generated. It is not generated if a simulation already exists for which magnitude, depth, location and fault plane all are within the configured variance with respect to the new simulation.

matching.depth.variance

Default: 30.0

Unit: km

Type: double

Maximum depth variance. For more information see the config option matching.magnitude.variance.

matching.location.variance

Default: 0.1

Unit: degree

Type: double

Maximum location variance. For more information see the config option matching.magnitude.variance.

matching.faultPlane.variance

Default: 0.15

Unit: 0, 1

Type: double

Maximum fault plane orientation residual in the range [0, 1]. If set to 0, only identical fault planes are considered to match, if set to 1, fault planes are always considered to match. The residual is computed by mapping the rotation angle between fault planes from [0°, 90°] to [0, 1] using a sigmoid (angles larger than 90° are mapped to 1). For more information see the config option matching.magnitude.variance.

Note

patches.* Configure settings for the automatic patches (rupture plane) generation.

patches.width

Default: 50

Unit: km

Type: int

The patch width option is not used at this time.

patches.depthMode

Default: 1

Type: int

Mode of the automatic depth correction. The following modes are available: 0 = Off, 1 = Adjust the depth to avoid negative z-top, 2 = Abort the patch generation in case of negative z-top

patches.maxFaultDist

Default: 1

Unit: degree

Type: double

Maximum horizontal distance between epicenter and closest fault point allowed for automatic patch generation.

patches.maxFootWallDist

Default: -1

Unit: degree

Type: double

Deprecated: Maximum distance between epicenter and closest fault point if epicenter is on foot wall. Note that this parameter is deprecated, use ‘maxFaultDist’ instead.

patches.maxHangingWallDist

Default: -1

Unit: degree

Type: double

Deprecated: Maximum distance between epicenter and closest fault point if epicenter is on hanging wall. Note that this parameter is deprecated, use ‘maxFaultDist’ instead.

patches.maxDip

Default: 80.0

Unit: degree

Type: double

Maximum dip in degree.

patches.maxRakeVariance

Default: 20.0

Unit: degree

Type: double

Maximum variance of the rake from 90 degree.

patches.extrapolateFault

Default: false

Type: boolean

Selection of this option will extrapolate fault lines beyond their endpoints, so that they can provide patch generation information for epicenters otherwise not covered.

Note

picker.* Configure settings for the tide gauge waveform picker.

picker.amplitudes

Default: OTM

Type: list:string

Predefined amplitudes.

picker.bufferSize

Default: 86400

Unit: s

Type: int

Total sea level buffer

picker.detecPhase

Default: OTA

Type: string

Phase for automatic picking.

picker.filters

Default: @Tsunami;CUTOFF(1)>>ITAPER(15000)>>BW(4,0.0002,0.002);

Type: list:string

Predefined sea level filters.

picker.leadTime

Default: 48200

Unit: s

Type: int

Time of sea level data before the current time.

picker.phases

Default: OTA

Type: list:string

Predefined phases.

picker.slots

Type: list:string

Registration of slots

picker.stream.codes

Default: *.*.*.*

Type: list:string

White list of stream code patterns. Use to filter the available streams.

Note

picker.slot.$name.* $name is a placeholder for the name to be used and needs to be added to picker.slots to become active.

picker.slots = a,b
picker.slot.a.value1 = ...
picker.slot.b.value1 = ...
# c is not active because it has not been added
# to the list of picker.slots
picker.slot.c.value1 = ...

picker.slot.$name.alias

Type: string

Alternative text.

picker.slot.$name.filter

Type: string

User-defined filter.

picker.slot.$name.pen

Type: string

User-defined pen. A pen is defined by a color, a width and a style. Pen styles are: 1 - A plain line, 2 - Dashes separated by a few pixels, 3 - Dots separated by a few, 4 - Alternate dots and dashes and 5 - One dash, two dots, one dash, two dots.

picker.slot.$name.predefined

Default: false

Type: boolean

Received data from acquisition are not taken into account.

picker.slot.$name.visible

Default: true

Type: boolean

Show/hide slot initially.

picker.spectrogram.fixedMaximum

Type: double

The corresponding maximum value mapped to value 1 of spectrogram.gradient.

picker.spectrogram.fixedMinimum

Type: double

If spectrograms are painted with a fixed gradient this value defines the minimum value which is mapped to gradient value 0 of spectrogram.gradient.

picker.spectrogram.gradient

Type: list:string

Default spectrogram gradient. Value 0 is always mapped to a minimum value and 1 is mapped to a maximum (either a fixed range or the extrema of each single trace).

Note

residuals.* Configure the weights of the residual contributions.

residuals.source.weight

Default: 1.0

Type: double

Weight of source residual for overall residual calculation.

residuals.source.gradient

Type: list:string

Gradient of source residual.

residuals.source.weights.magnitude

Default: 1.0

Type: double

Weight of magnitude for source residual calculation.

residuals.source.weights.depth

Default: 1.0

Type: double

Weight of depth for source residual calculation.

residuals.source.weights.distance

Default: 1.0

Type: double

Weight of distance to origin for source residual calculation.

residuals.momentTensor.weight

Default: 1.0

Type: double

Weight of moment tensor residual for overall residual calculation.

residuals.momentTensor.gradient

Type: list:string

Gradient of moment tensor residual.

residuals.expectedPlane.weight

Default: 1.0

Type: double

Weight of expected plane residual for overall residual calculation.

residuals.expectedPlane.gradient

Type: list:string

Gradient of expected plane residual.

residuals.tideGauge.weight

Default: 1.0

Type: double

Weight of tide gauge residual for overall residual calculation.

residuals.tideGauge.gradient

Type: list:string

Gradient of tide gauge residual.

residuals.displacement.weight

Default: 1.0

Type: double

Weight of coseismic displacement (GNSS) residual for overall residual calculation.

residuals.displacement.gradient

Type: list:string

Gradient of coseismic displacement (GNSS) residual.

residuals.radar.weight

Default: 1.0

Type: double

Weight of radar residual for overall residual calculation.

residuals.radar.gradient

Type: list:string

Gradient of radar residual.

Note

rttv.* Configure settings for the Traces tab (Real-Time-Trace-Viewer).

rttv.acquireStreams

Default: false

Type: boolean

Enables/Disables real time acquisition

rttv.bufferSize

Default: 86400

Unit: s

Type: int

Total sea level buffer

rttv.leadTime

Default: 48200

Unit: s

Type: int

Time of sea level data before the current time.

rttv.seaLevel.filters

Default: @Tsunami;CUTOFF(1)>>ITAPER(15000)>>BW(4,0.0002,0.002);

Type: list:string

Predefined sea level filters in the traces perspective.

rttv.stream.codes

Default: *.*.*.*

Type: list:string

White list of stream code patterns. Use to filter the available streams.

rttv.stream.filter

Type: string

Set rttv stream filter.

rttv.spectrogram.fixedMaximum

Type: double

The corresponding maximum value mapped to value 1 of spectrogram.gradient.

rttv.spectrogram.fixedMinimum

Type: double

If spectrograms are painted with a fixed gradient this value defines the minimum value which is mapped to gradient value 0 of spectrogram.gradient.

rttv.spectrogram.gradient

Type: list:string

Default spectrogram gradient. Value 0 is always mapped to a minimum value and 1 is mapped to a maximum (either a fixed range or the extrema of each single trace).

Note

runupPercentiles.* Define percentiles for the drop-down menu in the Forecast Zones tab. Register the profiles at ‘runupPercentiles’.

Note

runupPercentiles.$name.* $name is a placeholder for the name to be used and needs to be added to runupPercentiles to become active.

runupPercentiles = a,b
runupPercentiles.a.value1 = ...
runupPercentiles.b.value1 = ...
# c is not active because it has not been added
# to the list of runupPercentiles
runupPercentiles.c.value1 = ...

runupPercentiles.$name.text

Default: Median

Type: string

Menu item text

runupPercentiles.$name.value

Default: 50

Type: int

Value of the runup percentile.

Note

scheme.* Configure visualization settings for TOAST. Colors can be defined in HTML convention, e.g. as rgb(a) values, hexadecimal numbers or color keyword names as defined by W3C. If rgb or rgba is used, it must be quoted because the comma is handled as list separator. Examples: “rgb(255,0,0)”, “rgba(0,255,0,100)”, FF00FF40, green.

scheme.precision.traceValues

Default: 2

Type: int

Decimal places of the trace values

scheme.colors.records.eta

Default: FF0000

Type: color

Color of the ETA (T1 Time) marker

scheme.colors.records.etm

Default: 0000FF

Type: color

Color of the ETM (T3 Time) marker

scheme.colors.records.ot

Default: FF0000

Type: color

Color of the incident origin time bar

Note

sourceRegion.* Define source regions within which simulations should be created and the bathymetry file to be used. Register the profiles at ‘sourceRegions’. Keep in mind that a bathymetry file or directory has also to be configured at some simulation backends (e.g. easywave2).

Note

sourceRegion.$name.* $name is a placeholder for the name to be used and needs to be added to sourceRegions to become active.

sourceRegions = a,b
sourceRegion.a.value1 = ...
sourceRegion.b.value1 = ...
# c is not active because it has not been added
# to the list of sourceRegions
sourceRegion.c.value1 = ...

sourceRegion.$name.aoi

Type: string

Path to BNA file.

sourceRegion.$name.name

Type: string

Name of the bathymetry file without the extension

Note

symbol.* Define POI symbols. These profiles are used automatically and need not be registered.

symbol.shape

Default: ignore

Type: list:string

Default symbol for unknown POI types.

symbol.types

Type: list:string

Registration of POI types, no default configuration here. The names must match with the POI types in the acquisition and processing configuration. For instance symbol.types = buoy, tg

Note

symbol.$name.* $name is a placeholder for the name to be used and needs to be added to symbol.types to become active.

symbol.types = a,b
symbol.a.value1 = ...
symbol.b.value1 = ...
# c is not active because it has not been added
# to the list of symbol.types
symbol.c.value1 = ...

symbol.$name.shape

Type: list:string

Shape configuration for a symbol type. A shape is defined by a type, a size, a color and a border color separated by commas. Available shape types are circle, triangle, square and image. In case of an image the second parameter specifies the path including the filename. Parameters can be omitted from right to left. A sample configuration may look like: symbol.tg.shape = image, @DATADIR@/toast/icons/tg.png, ffffff

Note

templates.* Register the requested bulletin templates defined at ‘template’ here.

templates.types

Type: list:string

Registration of bulletin templates

Note

templates.logging.* Template logging options

templates.logging.stdout

Default: false

Type: boolean

Capture standard out process output

Note

template.* Define bulletin template profiles which can be used in a Live tab. Register the profiles at ‘templates’ and configure them in the ‘liveTab’ profiles.

Note

template.$name.* $name is a placeholder for the name to be used and needs to be added to templates.types to become active.

templates.types = a,b
template.a.value1 = ...
template.b.value1 = ...
# c is not active because it has not been added
# to the list of templates.types
template.c.value1 = ...

template.$name.aoi

Type: string

Path to a BNA file which defines one or more regions. If more than one region matches, the first one is used.

template.$name.maxMagnitude

Type: double

Upper bound of the magnitude range.

template.$name.minMagnitude

Type: double

Lower bound of the magnitude range.

template.$name.name

Type: string

Name of the template used in the GUI e.g. for the menu item

template.$name.fileName

Type: string

Path to the template including the file name.

template.$name.prerequisites.scenario

Default: false

Type: boolean

Show hint if no scenario is selected

Note

trigger.* Configure trigger criteria which control whether a simulation is created.

trigger.maximumAge

Default: 1800

Unit: s

Type: int

Maximum age of events in seconds to start a simulation automatically. If the value is negative the age of an event is ignored.

trigger.minimumMagnitude

Default: 6.0

Type: double

Minimum magnitude to start a similation automatically.

trigger.origin.mode

Type: string

Evalution mode of origins to trigger simulations for. Supported modes are manual and automatic. If no mode is specified no filter will be applied.

Note

tsunami.* Configure the TOAST database.

tsunami.database

Default: mysql://sysop:sysop@localhost/toast

Type: string

Define the TOAST database connection.

The format is: service://user:pwd@host/database. "service" is the name of the database driver which can be queried with "--db-driver-list".

IMPORTANT: This parameter replaces former "tsunami.database.type" and "tsunami.database.parameters" which have been deprecated.

tsunami.database.type

Type: string

Deprecated: Defines the tsunami database backend to be used. The name corresponds to the defined name in the database plugin. Examples are: mysql, postgresql or sqlite3. Note that this parameter is deprecated, use ‘tsunami.database’ instead.

tsunami.database.parameters

Type: string

Deprecated: The tsunami database connection parameters. This value depends on the used database backend. E.g. sqlite3 expects the path to the database file whereas MYSQL or PostgreSQL expect an URI in the format user:pwd@host/database?param1=val1&param2=val2. Note that this parameter is deprecated, use ‘tsunami.database’ instead.

tsunami.database.loadLastDays

Default: 1

Unit: days

Type: int

Load incidents of the last n days from database.

Bindings Parameters

maxGapTolerance

Default: 3600.0

Type: double

Maximum gap in seconds between two records to apply linear interpolation

spectrogram

Type: string

Min, max, periods and ranges of the spectrogramview e.g. periods_log(1000,10000,5,10)

Command-Line Options

Generic

-h, --help

Show help message.

-V, --version

Show version information.

--plugins arg

Load given plugins.

Database

--db-driver-list

List all supported database drivers.

-d, --database arg

The database connection string, format: service://user:pwd@host/database. "service" is the name of the database driver which can be queried with "--db-driver-list".

--config-module arg

The config module to use.

--inventory-db arg

Load the inventory from the given database or file, format: [service://]location .

--config-db arg

Load the configuration from the given database or file, format: [service://]location .

Messaging

-u, --user arg

Overrides configuration parameter connection.username.

-H, --host arg

Overrides configuration parameter connection.server.

-g, --primary-group arg

Overrides configuration parameter connection.primaryGroup.

-S, --subscribe-group arg

A group to subscribe to. This option can be given more than once.

--start-stop-msg arg

Default: 0

Set sending of a start and a stop message.

Verbosity

--verbosity arg

Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug.

-v, --v

Increase verbosity level (may be repeated, eg. -vv).

-q, --quiet

Quiet mode: no logging output.

--component arg

Limit the logging to a certain component. This option can be given more than once.

-s, --syslog

Use syslog logging backend. The output usually goes to /var/lib/messages.

-l, --lockfile arg

Path to lock file.

--console arg

Send log output to stdout.

--debug

Execute in debug mode. Equivalent to --verbosity=4 --console=1 .

--log-file arg

Use alternative log file.