.. highlight:: rst .. _kappa: ##### kappa ##### **Event Classification GUI** Description =========== Kappa is a graphical user interface for interactive event classification. It provides a :ref:`Summary tab` for a final event classification based on different observations and preliminary type guesses which are presented in the :ref:`observation tabs `. .. _kappa-summary: Summary and classification ========================== The summary tab is the main tab for making interactive event classifications. The preliminary type guesses and certainties from the individual observations are presented for joint evaluation in the table :ref:`Feature results `. A type selection can be made below in the :ref:`Event type ranking `. .. _fig-kappa-summary-tab: .. figure:: media/kappa-summary.png :align: center :width: 16cm Summary tab with individual observations and the final ranking. .. _kappa-summary-features: Feature results table --------------------- The row show the preliminary type guesses from the individual observations. The color indicate the status of the applied methods: * green: the observations are available and could be evaluated, * blue: the observations are being processed, * red: the observations are not available or the processing was not successful. When the preliminary event type different from the default, it is highlighted in bold letters. The different observations and methods may results in different suggestions for the event type or even no decision at all. To every observation a certainty is automatically assigned which can be adjusted manually. Together with the weight, an overall certainty is computed from the event type suggestions. .. _kappa-summary-ranking: Event type ranking ------------------ In the lower part, the event type suggestions are summarized. The most likely type is shown at the top of the table. They pie chart visualizes the relative certainties of the different types. The colors correspond to the rows in the table to the right. For making a final classification, select the event type in different ways: * **Pie chart:** Click on the type in the pie chart. The selection is highlighted by the circle segment outside the pie chart. In the pie chart the type can also be selected by using the courser keys or the mouse wheel and then pressing the Enter key. * **Table:** Click on the row of the table. In the table the type can also be selected by using the courser keys then pressing the Enter key. * **Pull-down menu:** Select the type from the pull-down menu in the lower part of the Summary tab. Press **Commit** to send the decision to the SeisComP messaging system. .. note:: To revise a classification simply select the correct one an press **Commit** again. .. _kappa-tabs: Detailed observation tabs ========================= The observations can be reviewed in the different observation tab. They provide automatic preliminary guesses of the event type based on the presented observation. The type along with the certainty can be interactively adjusted. .. note:: The behavior of all observation tabs can be configured in the module configuration of kappa. The parameters contain the alternative event types, fallback event types, thresholds, etc. Region check ------------ The region check tab shows the event location and the relation to pre-defined polygons. If the polygons contain information about the event type and the hypocenter of the event lies within the polygone, the preliminary type is given to the selected event. .. _fig-kappa-rc-tab: .. figure:: media/kappa-regioncheck.png :align: center :width: 16cm Region check tab Magnitude / Amplitude Ratio --------------------------- The Magnitude / Amplitude Ratio tab shows the network magnitude ratio of Ms_20 vs. mb. Upper and lower thresholds along with event types and example data points are configurable. If the selected event is below the lower or above upper thresholds, the respective preliminary event type is given with a certainty of 100%. If the event type is in between, the type and the certainty are given based on the event type associated to the closest threshold line. .. _fig-kappa-mag-amps-tab: .. figure:: media/kappa-mag-amps.png :align: center :width: 16cm Magnitude-Amplitude tab. The colors representing the event types and the thresholds are configurable. .. note:: Hold the mouse over an example point to read more information about this event. Moment tensor ------------- The moment tensor tab provides the full information about the moment tensor, its components and the derived focal mechanism values such as focal mechanism and principle axes. The beach balls represent the full moment tensor (left) and the double-couple (DC) moment tensor (right). The color of the represent the centroid depth of the moment tensor if given or the hypocenter depth. The rectangles around the beach balls represent the stations at their azimuth from the event origin. The colors of the station rectangles indicate the average station fit from moment tensor inversion: * green: good fit, low residual * yellow: intermediate * red: low fit, high residual. .. _fig-kappa-mt-tab: .. figure:: media/kappa-mt.png :align: center :width: 16cm Moment tensor tab. The color of the moment tensors indicate depth: red - shallow, yellow to green - intermediate, blue - deep. MachineLearning --------------- In the machine learning tabs multiple methods can be added and configured. The machine learning algorithms provide probabilities of particular event types based on provided features. By default, the features are the magnitude ratios: * :term:`Ms_20`/:term:`mb` * :term:`ML`/:term:`Md`. The machine learning methods are provided by Python scripts. Additional procedures can be added as profiles. .. note:: Machine learning algorithms are executed from configurable Python scripts. To use other methods simply create a new script and define it in :confval:`machineLearning.$name.command`. Ms vs. mb ^^^^^^^^^ The MachineLearning: Ms/mb tab compares Ms-mb magntiude ratios of the selected event with provided event examples. The classification and the certainties are based on machine learning. To run the machine learning tool press the **Start** button. The gray field to the left shows the progress information and possible errors. .. _fig-kappa-ml-ms-mb-tab: .. figure:: media/kappa-ml-ms-mb.png :align: center :width: 16cm Machine learning: Ms vs. mb ML vs. Md ^^^^^^^^^ The MachineLearning: ML/Md tab compares ML-Md magnitude ratios of the selected event with provided event examples. The classification and the certainties are based on machine learning. To run the machine learning tool press the **Start** button. The gray field to the left shows the progress information and possible errors. .. _fig-kappa-ml-ml-md-tab: .. figure:: media/kappa-ml-ml-md.png :align: center :width: 16cm Machine learning: ML vs. Md Origin Meta Information ----------------------- Kappa is able to evaluate origin comments. E.g. the template-based event detector `ccloc `_ can transport the event type of a master event to the new origin by a comment written to the origin. When the comment is configured in Kappa and found in an origin of an event, then this is a strong indicator that the event which contains the new origin is of the same type as the master event. The considered comment is configured by :confval:`originMeta.idEventType`. .. _fig-kappa-origin-tab: .. figure:: media/kappa-orgin.png :align: center :width: 16cm Origin meta information. Module Configuration ==================== | :file:`etc/defaults/global.cfg` | :file:`etc/defaults/kappa.cfg` | :file:`etc/global.cfg` | :file:`etc/kappa.cfg` | :file:`~/.seiscomp/global.cfg` | :file:`~/.seiscomp/kappa.cfg` kappa inherits :ref:`global options`. .. note:: Modules/plugins may require a license file. The default path to license files is :file:`@DATADIR@/licenses/` which can be overridden by global configuration of the parameter :confval:`gempa.licensePath`. Example: :: gempa.licensePath = @CONFIGDIR@/licenses .. confval:: preferredEventTypes Default: ``earthquake,explosion`` Type: *list:string* List of preferred event types which should appear on top of event type selection boxes. .. confval:: eventTypeColors Default: ``earthquake:b3de69,explosion:fb8072,"nuclear explosion:bc80bd","quarry blast:fdb462","sonic blast:80b1d3"`` Type: *list:string* List of eventType to color mappings, e.g., earthquake:00ff00, explosion:ff0000. .. confval:: inputDir Type: *string* Default directory used in file open dialog. .. confval:: outputDir Type: *string* Default directory used in file save as dialog. .. _scripts: .. note:: **scripts.\*** .. confval:: scripts.export Type: *string* Export button command. The current EventParameters object including the selected event type will be serialized and passed on stdin. In addition to the default SeisComP environment variables \(e.g., \@DATADIR\@\) the following event context variables will be resolved in the command string: EID, OTIME, LAT, LON, DEPTH, MAG, MAGTYPE, ETYPE, EVALMODE, EVALSTATUS, REGION. The use of apostrophe is recommended because some of the variables might be resolved to strings including spaces. .. _regionCheck: .. note:: **regionCheck.\*** *Evaluates the events hypocenter against a spatial region.* *Events within a region are flagged as positive, outside as negative.* *The event type is set accordingly.* .. confval:: regionCheck.enabled Default: ``false`` Type: *boolean* Defines whether this plugin should be available. .. confval:: regionCheck.name Default: ``Region Check`` Type: *string* Name of the plugin used in tab and summary table. .. confval:: regionCheck.weight Default: ``1.0`` Type: *double* Weight of the event type reported by this plugin. .. confval:: regionCheck.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: regionCheck.defaultMinDepth Unit: *km* Type: *double* Minimum hypocenter depth required for the default event type. .. confval:: regionCheck.defaultMaxDepth Unit: *km* Type: *double* Maximum hypocenter depth allowed for the default event type. .. confval:: regionCheck.regions Default: ``!reject`` Type: *list:string* The list of closed BNA or GeoJSON polygon names defining regions for flagging event as positive or negative. A polygon name defines a positive region but names with prefix \! \(exclamation mark\) define negative regions. Evaluation is done in the order of the polygons. The last matching criteria applies and the event type is set accordingly. If events are neither within positive nor negative regions, then the event type is set to \"outside of network interest\". Using \"accept\" will not classify such events. Examples: Events are flagged positive within the polygon \"Germany\": Germany All events are flagged positive but events within the polygon \"quarries\" are negative: accept,\!quarries Events within the polygon \"Germany\" are flagged positive but all other events and events within the polygon \"quarries\" are negative: Germany,\!quarries All events are flagged positive but events within the polygon \"Germany\" are negative and all events within the polygon \"Saxony\" are positive: accept,\!Germany,Saxony .. confval:: regionCheck.readEventTypeFromBNA Default: ``false`` Type: *boolean* Read the event type from the BNA polygon header. The header must contain the type, e.g., header of a polygon with name \"quarry\": \"quarry\",\"rank 1\",\"eventType: quarry blast\",13 When active, type supersede eventTypePositive and eventTypeNegative. This feature requires a SeisComP version greater than 2018.327. .. confval:: regionCheck.eventTypePositive Type: *string* New type of an event which is flagged positive. Ignored if readEventTypeFromBNA is active. Empty: Do not set type .. confval:: regionCheck.eventTypeNegative Default: ``"outside of network interest"`` Type: *string* New type of an event which is flagged negative. Ignored if readEventTypeFromBNA is active. Empty means default: \"outside of network interest\" .. _magRatio: .. note:: **magRatio.\*** *Magnitude ratio.* .. confval:: magRatio.enabled Default: ``false`` Type: *boolean* Defines whether this plugin should be available. .. confval:: magRatio.name Default: ``Magnitude Ratio`` Type: *string* Name of the plugin used in tab and summary table. .. confval:: magRatio.weight Default: ``1.0`` Type: *double* Weight of the event type reported by this plugin. .. confval:: magRatio.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: magRatio.typeX Default: ``mb`` Type: *string* Magnitude type to bind to variable X. .. confval:: magRatio.typeY Default: ``Ms_20`` Type: *string* Magnitude type to bind to variable Y. .. _magRatio.upperType: .. note:: **magRatio.upperType.\*** *Formula representing an upper bound for an event* *type. If the magnitude ratio exceeds the graph* *described by this formula, then the configured event* *type is set.* .. confval:: magRatio.upperType.eventType Type: *string* The event type. E.g., earthquake. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: magRatio.upperType.formula Type: *string* E.g., x \- 0.68 .. confval:: magRatio.upperType.description Type: *string* Formula description or reference. .. confval:: magRatio.upperType.referenceData Type: *file* Name of file containing reference data. Each line is expected to hold a coordinate of form x,y and an event description, e.g., 5.5,6,gfz2020abcd .. _magRatio.upperType.pen: .. note:: **magRatio.upperType.pen.\*** *Defines the pen used for the graph and event data.* .. confval:: magRatio.upperType.pen.color Default: ``ff0000`` Type: *color* The color of the pen. .. confval:: magRatio.upperType.pen.style Default: ``SolidLine`` Type: *string* Values: ``NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine`` The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. .. confval:: magRatio.upperType.pen.width Default: ``2.0`` Unit: *px* Type: *double* The width of the pen. .. _magRatio.lowerType: .. note:: **magRatio.lowerType.\*** *Formula representing a lower bound for an event* *type. If the magnitude ratio falls below the graph* *described by this formula, then the configured event* *type is set.* .. confval:: magRatio.lowerType.eventType Type: *string* The event type. E.g., explosion. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: magRatio.lowerType.formula Type: *string* E.g., 0.95 \* x \- 1.668 .. confval:: magRatio.lowerType.description Type: *string* Formula description or reference. .. confval:: magRatio.lowerType.referenceData Type: *file* Name of file containing reference data. Each line is expected to hold a coordinate of form x,y and an event description. Example line: 5.5,6,gfz2020abcd .. _magRatio.lowerType.pen: .. note:: **magRatio.lowerType.pen.\*** *Defines the pen used for the graph and event data.* .. confval:: magRatio.lowerType.pen.color Default: ``ff0000`` Type: *color* The color of the pen. .. confval:: magRatio.lowerType.pen.style Default: ``SolidLine`` Type: *string* Values: ``NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine`` The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. .. confval:: magRatio.lowerType.pen.width Default: ``2.0`` Unit: *px* Type: *double* The width of the pen. .. _ampRatio: .. note:: **ampRatio.\*** *Amplitude ratio.* .. confval:: ampRatio.enabled Default: ``false`` Type: *boolean* Defines whether this plugin should be available. .. confval:: ampRatio.name Default: ``Amplitude Ratio`` Type: *string* Name of the plugin used in tab and summary table. .. confval:: ampRatio.weight Default: ``1.0`` Type: *double* Weight of the event type reported by this plugin. .. confval:: ampRatio.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: ampRatio.typeX Default: ``mb`` Type: *string* Amplitude type to bind to variable X. .. confval:: ampRatio.typeY Default: ``Ms_20`` Type: *string* Amplitude type to bind to variable Y. .. confval:: ampRatio.unitX Default: ``nm`` Type: *string* Amplitude unit. .. confval:: ampRatio.unitY Default: ``nm`` Type: *string* Amplitude unit. .. _ampRatio.upperType: .. note:: **ampRatio.upperType.\*** *Formula representing an upper bound for an event* *type. If the amplitude ratio exceeds the graph* *described by this formula, then the configured event* *type is set.* .. confval:: ampRatio.upperType.eventType Type: *string* The event type. E.g., earthquake. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: ampRatio.upperType.formula Type: *string* E.g., x \- 0.68 .. confval:: ampRatio.upperType.description Type: *string* Formula description or reference. .. _ampRatio.upperType.pen: .. note:: **ampRatio.upperType.pen.\*** *Defines the pen used for the graph and event data.* .. confval:: ampRatio.upperType.pen.color Default: ``ff0000`` Type: *color* The color of the pen. .. confval:: ampRatio.upperType.pen.style Default: ``SolidLine`` Type: *string* Values: ``NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine`` The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. .. confval:: ampRatio.upperType.pen.width Default: ``2.0`` Unit: *px* Type: *double* The width of the pen. .. _ampRatio.lowerType: .. note:: **ampRatio.lowerType.\*** *Formula representing a lower bound for an event* *type. If the amplitude ratio falls below the graph* *described by this formula, then the configured event* *type is set.* .. confval:: ampRatio.lowerType.eventType Type: *string* The event type. E.g., explosion. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: ampRatio.lowerType.formula Type: *string* E.g., 0.95 \* x \- 1.668 .. confval:: ampRatio.lowerType.description Type: *string* Formula description or reference. .. _ampRatio.lowerType.pen: .. note:: **ampRatio.lowerType.pen.\*** *Defines the pen used for the graph and event data.* .. confval:: ampRatio.lowerType.pen.color Default: ``ff0000`` Type: *color* The color of the pen. .. confval:: ampRatio.lowerType.pen.style Default: ``SolidLine`` Type: *string* Values: ``NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine`` The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. .. confval:: ampRatio.lowerType.pen.width Default: ``2.0`` Unit: *px* Type: *double* The width of the pen. .. _momentTensor: .. note:: **momentTensor.\*** *Evaluates the isotropic component of a moment tensor solution.* .. confval:: momentTensor.enabled Default: ``false`` Type: *boolean* Defines whether this plugin should be available. .. confval:: momentTensor.name Default: ``Moment Tensor`` Type: *string* Name of the plugin used in tab and summary table. .. confval:: momentTensor.weight Default: ``1.0`` Type: *double* Weight of the event type reported by this plugin. .. confval:: momentTensor.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: momentTensor.iso Default: ``30`` Unit: *%* Type: *double* Threshold of the isotropic moment tensor component. .. confval:: momentTensor.eventType Default: ``explosion`` Type: *string* Event type to set if the iso threshold is exceeded. .. _machineLearning: .. note:: **machineLearning.\*** *Machine learning through external command invocation.* *For each configured profile an external command is run which* *is expected to read the EventParameters object from stdin,* *report processing information on stderr and a probability* *value in range [0,1] on stdout. If the reported probability* *is less than 0.5, then event type is set to the configured* *lowerType, else to the upperType. The event type certainty* *is derived from the probability value.* .. confval:: machineLearning.profiles Type: *list:string* List of machine learning profiles to activate. .. _machineLearning.$name: .. note:: **machineLearning.$name.\*** $name is a placeholder for the name to be used. .. confval:: machineLearning.$name.enabled Default: ``true`` Type: *boolean* Defines whether this plugin should be available. .. confval:: machineLearning.$name.name Default: ``Machine Learning`` Type: *string* Name of the profile used in tab and summary table. .. confval:: machineLearning.$name.weight Default: ``1.0`` Type: *double* Weight of the event type reported by this plugin. .. confval:: machineLearning.$name.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: machineLearning.$name.command Type: *string* Command to execute. .. confval:: machineLearning.$name.minValue Default: ``0.0`` Type: *double* Minimum expected value. .. confval:: machineLearning.$name.maxValue Default: ``1.0`` Type: *double* Maximum expected value. .. _machineLearning.$name.lowerType: .. confval:: machineLearning.$name.lowerType.eventType Default: ``explosion`` Type: *string* EventType to use if probability exceeds the lower threshold. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: machineLearning.$name.lowerType.threshold Default: ``0.2`` Type: *double* Lower threshold .. confval:: machineLearning.$name.lowerType.referenceData Type: *file* Name of file containing reference data. Each line is expected to hold a probability value, the event time in iso format and an event description, e.g., 0.05,2017\-06\-23T22:58:12.123456,gfz2020abcd .. _machineLearning.$name.lowerType.pen: .. note:: **machineLearning.$name.lowerType.pen.\*** *Defines the pen used for the graph and event data.* .. confval:: machineLearning.$name.lowerType.pen.color Default: ``ff0000`` Type: *color* The color of the pen. .. confval:: machineLearning.$name.lowerType.pen.style Default: ``SolidLine`` Type: *string* Values: ``NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine`` The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. .. confval:: machineLearning.$name.lowerType.pen.width Default: ``2.0`` Unit: *px* Type: *double* The width of the pen. .. _machineLearning.$name.upperType: .. confval:: machineLearning.$name.upperType.eventType Default: ``earthquake`` Type: *string* EventType to use if probability exceeds the upper threshold. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: machineLearning.$name.upperType.threshold Default: ``0.8`` Type: *double* Upper threshold .. confval:: machineLearning.$name.upperType.referenceData Type: *file* Name of file containing reference data. Each line is expected to hold a probability value, the event time in ISO format and an event description separated by comma. Example: 0.95,2017\-06\-23T22:58:12.123456,gfz2020abcd .. _machineLearning.$name.upperType.pen: .. note:: **machineLearning.$name.upperType.pen.\*** *Defines the pen used for the graph and event data.* .. confval:: machineLearning.$name.upperType.pen.color Default: ``00ff00`` Type: *color* The color of the pen. .. confval:: machineLearning.$name.upperType.pen.style Default: ``SolidLine`` Type: *string* Values: ``NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine`` The style of the pen. Supported values are: NoPen, SolidLine, DashLine, DotLine, DashDotLine, DashDotDotLine. .. confval:: machineLearning.$name.upperType.pen.width Default: ``2.0`` Unit: *px* Type: *double* The width of the pen. .. _generic: .. note:: **generic.\*** *Generic feature evaluation by external command.* *For each configured profile an external command is run which* *is expected to read the EventParameters object from stdin,* *report processing information on stderr and up to 2 line on* *stdout:* * * *[resource path]* *The probability type must be in range [0,1]. The resource path* *may point to an image (PNG, JPG, SVG, ...) or any other file* *type which can be displayed by the build in QT web view* *component, e.g., a HTML file.* .. confval:: generic.profiles Type: *list:string* List of generic profiles to activate. .. _generic.$name: .. note:: **generic.$name.\*** $name is a placeholder for the name to be used. .. confval:: generic.$name.enabled Default: ``true`` Type: *boolean* Defines whether this plugin should be available. .. confval:: generic.$name.name Default: ``Generic`` Type: *string* Name of the profile used in tab and summary table. .. confval:: generic.$name.weight Default: ``1.0`` Type: *double* Weight of the event type reported by this plugin. .. confval:: generic.$name.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. .. confval:: generic.$name.command Type: *string* Command to execute. .. _originMeta: .. note:: **originMeta.\*** *Reads the event type from origin comments, e.g., set by ccloc.* .. confval:: originMeta.enabled Default: ``true`` Type: *boolean* Defines whether this plugin should be available. .. confval:: originMeta.name Default: ``Origin Meta Information`` Type: *string* Name of the plugin used in tab and summary table. .. confval:: originMeta.idEventType Default: ``ccloc:eventTypeHint`` Type: *string* ID of the comment containing the event type hint. .. confval:: originMeta.idCertainty Default: ``configID`` Type: *string* ID of the comment containing the certainty value. .. confval:: originMeta.idDescription Default: ``configID`` Type: *string* ID of the comment containing an additional result description. .. confval:: originMeta.defaultEventType Type: *string* Event type used as fallback when no other type applies. Leaving it empty will not propose a type. See \@ROOTDIR\@\/include\/seiscomp\/datamodel\/types.h or scolv for a list of supported event types. Bindings Parameters =================== .. confval:: enable Default: ``true`` Type: *boolean* Enables\/disables the station for event classification. .. confval:: channels Type: *list:string* Defines a list of preferred channels that are activated by default for that station. If this option is undefined, then the highest sample rate channels for acceleration and velocity are used by default. If the list is empty \(which is a different state than undefined\), then no channels are selected by default. Command-Line Options ==================== .. _Generic: Generic ------- .. option:: -h, --help Show help message. .. option:: -V, --version Show version information. .. option:: --config-file file The alternative module configuration file. When this option is used, the module configuration is only read from the given file and no other configuration stage is considered. Therefore, all configuration including the definition of plugins must be contained in that file or given along with other command\-line options such as \-\-plugins. .. option:: --plugins arg Load given plugins. .. option:: -D, --daemon Run as daemon. This means the application will fork itself and doesn't need to be started with \&. .. option:: --auto-shutdown arg Enable\/disable self\-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message \(enabled with \-\-start\-stop\-msg for the master module\). .. option:: --shutdown-master-module arg Set the name of the master\-module used for auto\-shutdown. This is the application name of the module actually started. If symlinks are used, then it is the name of the symlinked application. .. option:: --shutdown-master-username arg Set the name of the master\-username of the messaging used for auto\-shutdown. If \"shutdown\-master\-module\" is given as well, this parameter is ignored. .. _Verbosity: Verbosity --------- .. option:: --verbosity arg Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug. .. option:: -v, --v Increase verbosity level \(may be repeated, e.g., \-vv\). .. option:: -q, --quiet Quiet mode: no logging output. .. option:: --component arg Limit the logging to a certain component. This option can be given more than once. .. option:: -s, --syslog Use syslog logging backend. The output usually goes to \/var\/lib\/messages. .. option:: -l, --lockfile arg Path to lock file. .. option:: --console arg Send log output to stdout. .. option:: --debug Execute in debug mode. Equivalent to \-\-verbosity\=4 \-\-console\=1 . .. option:: --log-file arg Use alternative log file. .. _Database: Database -------- .. option:: --db-driver-list List all supported database drivers. .. option:: -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\". .. option:: --config-module arg The config module to use. .. option:: --inventory-db arg Load the inventory from the given database or file, format: [service:\/\/]location .