[installation] Init with inital config for global

This commit is contained in:
2025-10-30 15:08:17 +01:00
commit 7640b452ed
3678 changed files with 2200095 additions and 0 deletions

View File

@ -0,0 +1,730 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ngl2caps &#8212; CAPS: Common Acquisition Protocol Server documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/gempa.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="orb2caps" href="orb2caps.html" />
<link rel="prev" title="gdi2caps" href="gdi2caps.html" />
</head>
<body>
<div class="header">
<div class="container">
<img class="background" src="../_static/icon.png"/>
<div class="content">
<span class="title">CAPS: Common Acquisition Protocol Server </span>
<span class="version">2025.254#f0c77b29e</span></h1>
</div>
</div>
</div>
<div class="nav">
<div class="container">
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right">
<a href="../genindex.html" title="General Index"
accesskey="I">
index
</a>
</li>
<li class="right">
<a href="orb2caps.html" title="orb2caps"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="gdi2caps.html" title="gdi2caps"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="../base/plugins.html" accesskey="U">Data Acquisition and Manipulation by Plugins</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="ngl2caps">
<span id="id1"></span><h1>ngl2caps<a class="headerlink" href="#ngl2caps" title="Permalink to this heading"></a></h1>
<p><strong>NGL CAPS plugin. Reads GNSS data in kenv format and sends it to CAPS.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Read GNSS data in kenv format, convert to RAW and send to a CAPS server.</p>
</section>
<section id="waveform-data">
<h2>Waveform Data<a class="headerlink" href="#waveform-data" title="Permalink to this heading"></a></h2>
<section id="format-describtions">
<h3>Format describtions<a class="headerlink" href="#format-describtions" title="Permalink to this heading"></a></h3>
<ul>
<li><p><strong>kenv Format</strong>:
Final 5 min rapid solutions from stations [stat]:
<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/rapids_5min/kenv/[stat]/">http://geodesy.unr.edu/gps_timeseries/rapids_5min/kenv/[stat]/</a></p>
<ul>
<li><p>Sample rate: 1/300 sps</p></li>
<li><p>Example: <a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/rapids_5min/kenv/0ALM/">http://geodesy.unr.edu/gps_timeseries/rapids_5min/kenv/0ALM/</a></p></li>
<li><p>Format (<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/README_kenv.txt">http://geodesy.unr.edu/gps_timeseries/README_kenv.txt</a>):</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">----------------------------------------</span>
<span class="na">.kenv</span><span class="w"> </span><span class="s">format (east,north,up time series)</span>
<span class="na">----------------------------------------</span>
<span class="na">Note</span><span class="o">:</span><span class="w"> </span><span class="s">first line of .kenv contains header fields to help human interpretation.</span>
<span class="na">Column</span><span class="w"> </span><span class="s">Header Example Description</span>
<span class="na">------</span><span class="w"> </span><span class="s">----------- --------- ------------------------------------</span>
<span class="w"> </span><span class="na">1</span><span class="w"> </span><span class="s">site JPLM 4-character station ID</span>
<span class="w"> </span><span class="na">2</span><span class="w"> </span><span class="s">sec-J2000 3705278100 GPS seconds since 2000-01-01 12:00:00</span>
<span class="w"> </span><span class="na">3</span><span class="w"> </span><span class="s">__MJD 55833 Modified Julian Day for GPS day</span>
<span class="w"> </span><span class="na">4</span><span class="w"> </span><span class="s">year 2011 Year</span>
<span class="w"> </span><span class="na">5</span><span class="w"> </span><span class="s">mm 9 Month</span>
<span class="w"> </span><span class="na">6</span><span class="w"> </span><span class="s">dd 29 Day of month</span>
<span class="w"> </span><span class="na">7</span><span class="w"> </span><span class="s">doy 272 Day of year</span>
<span class="w"> </span><span class="na">8</span><span class="w"> </span><span class="s">s-day 10800 Seconds of the GPS day</span>
<span class="w"> </span><span class="na">9</span><span class="w"> </span><span class="s">___e-ref(m) -0.202261 East from reference longitude in llh</span>
<span class="na">10</span><span class="w"> </span><span class="s">___n-ref(m) 0.079096 North from reference latitude in llh</span>
<span class="na">11</span><span class="w"> </span><span class="s">___v-ref(m) -0.025883 Up from reference height in llh</span>
<span class="na">12</span><span class="w"> </span><span class="s">_e-mean(m) -0.015904 East from daily mean position</span>
<span class="na">13</span><span class="w"> </span><span class="s">_n-mean(m) -0.000944 North from daily mean position</span>
<span class="na">14</span><span class="w"> </span><span class="s">_v-mean(m) 0.000232 Up from daily mean position</span>
<span class="na">15</span><span class="w"> </span><span class="s">sig_e(m) 0.005700 Sigma east</span>
<span class="na">16</span><span class="w"> </span><span class="s">sig_n(m) 0.006875 Sigma north</span>
<span class="na">17</span><span class="w"> </span><span class="s">sig_v(m) 0.021739 Sigma up</span>
</pre></div>
</div>
</li>
</ul>
</li>
<li><p>RINEX data web server: <a class="reference external" href="http://geodesy.unr.edu/magnet/rinex/">http://geodesy.unr.edu/magnet/rinex/</a></p></li>
</ul>
</section>
<section id="data-sources">
<h3>Data sources<a class="headerlink" href="#data-sources" title="Permalink to this heading"></a></h3>
<p>kenv data are provided by Nevada Geodetic Laboratory, NGL
(<a class="reference external" href="http://geodesy.unr.edu/">http://geodesy.unr.edu/</a>):</p>
<ul>
<li><p><strong>Preferred:</strong> Rapid data, 24 hours latency, 5 minutes sps, 1 ZIP file per year:
<a class="reference external" href="http://geodesy.unr.edu/NGLStationPages/RapidStationList">http://geodesy.unr.edu/NGLStationPages/RapidStationList</a></p>
<p>Archives:
<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/kenv/">http://geodesy.unr.edu/gps_timeseries/kenv/</a></p>
<p>Example for one station, 1 year:
<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/kenv/0ABI/0ABI.2022.kenv.zip">http://geodesy.unr.edu/gps_timeseries/kenv/0ABI/0ABI.2022.kenv.zip</a></p>
</li>
<li><p>Ultra-rapid data, 1 hour latency, 5 minutes sps (may have many gaps and outages):
<a class="reference external" href="http://geodesy.unr.edu/NGLStationPages/UltraStationList">http://geodesy.unr.edu/NGLStationPages/UltraStationList</a></p>
<p>Hourly upload:
<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/ultracombo/kenv/2022/141/">http://geodesy.unr.edu/gps_timeseries/ultracombo/kenv/2022/141/</a></p>
<p>Archives:
<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/kenv/">http://geodesy.unr.edu/gps_timeseries/kenv/</a></p>
</li>
<li><p>Final 24 h solutions from stations [stat]:
<a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/txyz/IGS14/[stat].txyz2">http://geodesy.unr.edu/gps_timeseries/txyz/IGS14/[stat].txyz2</a></p>
<p>Example: <a class="reference external" href="http://geodesy.unr.edu/gps_timeseries/txyz/IGS14/ARIS.txyz2">http://geodesy.unr.edu/gps_timeseries/txyz/IGS14/ARIS.txyz2</a></p>
</li>
</ul>
</section>
<section id="fetch-data">
<h3>Fetch data<a class="headerlink" href="#fetch-data" title="Permalink to this heading"></a></h3>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Data on the NGL server are zipped files, one file per year.
Geoffrey Blewitt why this is:</p>
<p>“We zip into yearly files which are updated every week. The actual day it is
updated varies depending on when other necessary inputs are ready, such as
JPL orbit files, and weather model files from TU Vienna, and ocean loading
files from Chalmers, Sweden. So, you would not want to check every day, but
I would say every Wednesday would typically work.
Its also important to note that while we process Final data every week,
often we include newly discovered or late data that can go as far back as
1994. So, we are not just incrementing with a new week of files.</p>
<p>On the technical side, we zip the data into yearly files to reduce the number
of “inodes” (files) on our server, which can slow things down when attempting
to seek files, and in the past has overloaded the server with maximum number
of inodes.</p>
<p>Zipping files has speeded up our operations considerably and allows us to
process all the worlds GPS geodetic data (currently &gt; 18,000 stations).
It also allows for efficient backup, which can take far too long with
individual files.”</p>
</div>
<p>For fetching data from the server above adjust:</p>
<ul class="simple">
<li><p><em>year</em> year to consider as set in the file name. Use “” for all.</p></li>
<li><p><em>url</em></p></li>
<li><p><em>outPut</em>: target directory of fetched files</p></li>
</ul>
<p>in the Python script provided with the source code:
<code class="file docutils literal notranslate"><span class="pre">ngl/plugin/tools/fetchFilesFromWeb.py</span></code> and use it:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>fetchFilesFromWeb.py
</pre></div>
</div>
<p>Change to the target directory and unpack the files:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span><span class="o">[</span>target<span class="o">]</span>
unzip<span class="w"> </span>*
gunzip<span class="w"> </span>*
</pre></div>
</div>
<p>Running ngl2caps converts data to RAW and sends them to the CAPS server. The
assumed physical unit of the output data is <strong>nanometer</strong> and the original data
are assumed in units of <strong>meter</strong>. The conversion is applied by the <code class="xref std std-confval docutils literal notranslate"><span class="pre">gain</span></code>
which is therefore <strong>1000,000,000</strong> by default.
<strong>Make sure to generate the inventory with the correct gain and gainUnit.</strong>
If data are stored in “nm” and gainUnit of the stream in the inventory is “m” (SI unit),
the gain in the inventory must be <img class="math" src="../_images/math/18e6c1d83efdf6b796704284b4f52eb7bc826135.png" alt="10^{-09}"/>. Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>ngl2caps<span class="w"> </span>--debug<span class="w"> </span>-p<span class="w"> </span><span class="o">[</span>target<span class="w"> </span>directory<span class="o">]</span><span class="w"> </span>--gain<span class="w"> </span><span class="m">1000000000</span>
</pre></div>
</div>
</section>
<section id="output-streams">
<h3>Output streams<a class="headerlink" href="#output-streams" title="Permalink to this heading"></a></h3>
<p>The plugin writes the following parameter to the header of the output data.</p>
<table class="docutils align-left">
<colgroup>
<col style="width: 20.0%" />
<col style="width: 20.0%" />
<col style="width: 10.0%" />
<col style="width: 50.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>group</p></th>
<th class="head"><p>parameter</p></th>
<th class="head"><p>added</p></th>
<th class="head"><p>value/remark</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>network</p></td>
<td><p>code</p></td>
<td><p>x</p></td>
<td><p>from input parameter</p></td>
</tr>
<tr class="row-odd"><td><p>network</p></td>
<td><p>start time</p></td>
<td><p>x</p></td>
<td><p>from input parameter</p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>station</p></td>
<td><p>code</p></td>
<td><p>x</p></td>
<td><p>from input file</p></td>
</tr>
<tr class="row-even"><td><p>station</p></td>
<td><p>start time</p></td>
<td><p>x</p></td>
<td><p>same as network</p></td>
</tr>
<tr class="row-odd"><td><p>station</p></td>
<td><p>coordinates</p></td>
<td><p>x</p></td>
<td><p>from input file</p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>sensor location</p></td>
<td><p>code</p></td>
<td><p>x</p></td>
<td><p>from input parameter</p></td>
</tr>
<tr class="row-even"><td><p>sensor location</p></td>
<td><p>start</p></td>
<td><p>x</p></td>
<td><p>same as network</p></td>
</tr>
<tr class="row-odd"><td><p>sensor location</p></td>
<td><p>elevation</p></td>
<td><p>x</p></td>
<td><p>same as station</p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>stream</p></td>
<td><p>code</p></td>
<td><p>x</p></td>
<td><p>from band + [XYZ][ZNE]</p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
<td><p>from band + [X][ZNE] : derived data, daily mean removed</p></td>
</tr>
<tr class="row-odd"><td></td>
<td></td>
<td></td>
<td><p>from band + [Y][ZNE] : raw data</p></td>
</tr>
<tr class="row-even"><td></td>
<td></td>
<td></td>
<td><p>from band + [Z][ZNE] : sigma data</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="inventory">
<h2>Inventory<a class="headerlink" href="#inventory" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Access to different stations lists and formats: <a class="reference external" href="http://geodesy.unr.edu/PlugNPlayPortal.php">http://geodesy.unr.edu/PlugNPlayPortal.php</a></p></li>
<li><p>Station list (HTML): <a class="reference external" href="http://geodesy.unr.edu/NGLStationPages/GlobalStationList">http://geodesy.unr.edu/NGLStationPages/GlobalStationList</a></p></li>
<li><p>Station list (TXT, 1/300 sps, 24 hour latency):
<a class="reference external" href="http://geodesy.unr.edu/NGLStationPages/DataHoldingsRapid5min.txt">http://geodesy.unr.edu/NGLStationPages/DataHoldingsRapid5min.txt</a></p></li>
<li><p>Details about stations [stat]: <a class="reference external" href="http://geodesy.unr.edu/NGLStationPages/stations/[stat].sta">http://geodesy.unr.edu/NGLStationPages/stations/[stat].sta</a></p></li>
<li><p>Station table with coordinates:
<a class="reference external" href="http://plugandplay.unavco.org:8080/unrgsac/gsacapi/site/search#tabId3153-1">http://plugandplay.unavco.org:8080/unrgsac/gsacapi/site/search#tabId3153-1</a></p></li>
</ul>
<p><span class="xref std std-ref">table2inv</span> can be used for conversion of a station table to <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>.</p>
</section>
<section id="module-configuration">
<h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/ngl2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/ngl2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/ngl2caps.cfg</span></code></div>
</div>
<p>ngl2caps inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Modules/plugins may require a license file. The default path to license
files is <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/licenses/</span></code> which can be overridden by global
configuration of the parameter <code class="xref std std-confval docutils literal notranslate"><span class="pre">gempa.licensePath</span></code>. Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>gempa.licensePath = @CONFIGDIR@/licenses
</pre></div>
</div>
</div>
<div class="admonition note" id="input">
<p class="admonition-title">Note</p>
<p><strong>input.*</strong>
<em>Parameters controlling the input of event information and</em>
<em>reception of GNSS data.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-input.readFrom">
<span class="sig-name descname"><span class="pre">input.readFrom</span></span><a class="headerlink" href="#confval-input.readFrom" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Read input data from this file.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-input.directory">
<span class="sig-name descname"><span class="pre">input.directory</span></span><a class="headerlink" href="#confval-input.directory" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Watch this directory for incoming input files.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-input.watchEvents">
<span class="sig-name descname"><span class="pre">input.watchEvents</span></span><a class="headerlink" href="#confval-input.watchEvents" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">close_write</span></code></p>
<p>Type: <em>string</em></p>
<p>Listen for specific inotify event(s).
If ommitted, close_write events are listened for. Events:</p>
<p>access - file or directory contents were read,</p>
<p>modify - file or directory contents were written,</p>
<p>attrib - file or directory attributes changed,</p>
<p>close_write - file or directory closed, after being opened in writable mode,</p>
<p>close_nowrite - file or directory closed, after being opened in read-only mode,</p>
<p>close - file or directory closed, regardless of read/write mode,</p>
<p>open - file or directory opened,</p>
<p>moved_to - file or directory moved to watched directory,</p>
<p>moved_from - file or directory moved from watched directory,</p>
<p>move - file or directory moved to or from watched directory,</p>
<p>create - file or directory created within watched directory,</p>
<p>delete - file or directory deleted within watched directory,</p>
<p>delete_self - file or directory was deleted,</p>
<p>unmount - file system containing file or directory unmounted.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-input.watchPattern">
<span class="sig-name descname"><span class="pre">input.watchPattern</span></span><a class="headerlink" href="#confval-input.watchPattern" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Process any events whose filename matches the specified regular expression</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-input.leapSecondsFile">
<span class="sig-name descname"><span class="pre">input.leapSecondsFile</span></span><a class="headerlink" href="#confval-input.leapSecondsFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/caps/plugins/ngl2caps/leapseconds.txt</span></code></p>
<p>Type: <em>string</em></p>
<p>Name of file with leap seconds.</p>
</dd></dl>
<div class="admonition note" id="streams">
<p class="admonition-title">Note</p>
<p><strong>streams.*</strong>
<em>Parameters controlling the processing of received data.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.networkCode">
<span class="sig-name descname"><span class="pre">streams.networkCode</span></span><a class="headerlink" href="#confval-streams.networkCode" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">NG</span></code></p>
<p>Type: <em>string</em></p>
<p>Network code to use.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.locationCode">
<span class="sig-name descname"><span class="pre">streams.locationCode</span></span><a class="headerlink" href="#confval-streams.locationCode" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Location code to use.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.bandCode">
<span class="sig-name descname"><span class="pre">streams.bandCode</span></span><a class="headerlink" href="#confval-streams.bandCode" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">U</span></code></p>
<p>Type: <em>string</em></p>
<p>Band code of streams to use. Streams will be formed as
[band][sensor type][component].</p>
</dd></dl>
<div class="admonition note" id="output">
<p class="admonition-title">Note</p>
<p><strong>output.*</strong>
<em>Parameters controlling the output of received data.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.host">
<span class="sig-name descname"><span class="pre">output.host</span></span><a class="headerlink" href="#confval-output.host" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">localhost</span></code></p>
<p>Type: <em>string</em></p>
<p>Data output host.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.port">
<span class="sig-name descname"><span class="pre">output.port</span></span><a class="headerlink" href="#confval-output.port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18003</span></code></p>
<p>Type: <em>int</em></p>
<p>Data output port.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.bufferSize">
<span class="sig-name descname"><span class="pre">output.bufferSize</span></span><a class="headerlink" href="#confval-output.bufferSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1048576</span></code></p>
<p>Type: <em>uint</em></p>
<p>Size (bytes) of the packet buffer.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.gain">
<span class="sig-name descname"><span class="pre">output.gain</span></span><a class="headerlink" href="#confval-output.gain" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000000</span></code></p>
<p>Type: <em>float</em></p>
<p>Apply given gain to samples.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<span id="id2"></span><h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-h">
<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-V">
<span id="cmdoption-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-config-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative configuration file. When this option is
used the loading of all stages is disabled. Only the
given configuration file is parsed and used. To use
another name for the configuration create a symbolic
link of the application or copy it. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
</section>
<section id="verbosity">
<span id="id3"></span><h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-v">
<span id="cmdoption-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-q">
<span id="cmdoption-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-print-component">
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-s">
<span id="cmdoption-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-l">
<span id="cmdoption-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="input-event">
<span id="id4"></span><h3>Input event<a class="headerlink" href="#input-event" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-d">
<span id="cmdoption-directory"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--directory</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition"></a></dt>
<dd><p>Watch this directory for incoming event input files. By
default the current directory is watched.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-watch-pattern">
<span class="sig-name descname"><span class="pre">--watch-pattern</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-watch-pattern" title="Permalink to this definition"></a></dt>
<dd><p>Process any event file which file name matches the specified
regular expression.</p>
</dd></dl>
</section>
<section id="input-waveforms">
<span id="id5"></span><h3>Input waveforms<a class="headerlink" href="#input-waveforms" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span id="cmdoption-file"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition"></a></dt>
<dd><p>Read kenv data directly from this given file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-p">
<span id="cmdoption-read-from"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--read-from</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-p" title="Permalink to this definition"></a></dt>
<dd><p>Read all kenv files from this directory path. Only
considered if file is not given.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-0">
<span id="cmdoption-leap-file"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--leap-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-0" title="Permalink to this definition"></a></dt>
<dd><p>Path to leap seconds file.</p>
</dd></dl>
</section>
<section id="filter">
<span id="id6"></span><h3>Filter<a class="headerlink" href="#filter" title="Permalink to this heading"></a></h3>
</section>
<section id="id7">
<span id="id8"></span><h3>Streams<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-network-code">
<span class="sig-name descname"><span class="pre">--network-code</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-network-code" title="Permalink to this definition"></a></dt>
<dd><p>Network code to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-location-code">
<span class="sig-name descname"><span class="pre">--location-code</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-location-code" title="Permalink to this definition"></a></dt>
<dd><p>Sensor location code to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-1">
<span class="sig-name descname"><span class="pre">--location-code</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-1" title="Permalink to this definition"></a></dt>
<dd><p>Band code to use. Streams will be formed as [band code][xyz][ZNE].</p>
</dd></dl>
</section>
<section id="id9">
<span id="id10"></span><h3>Output<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-H">
<span id="cmdoption-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-H" title="Permalink to this definition"></a></dt>
<dd><p>Data output host.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-P">
<span id="cmdoption-port"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--port</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-P" title="Permalink to this definition"></a></dt>
<dd><p>Data output port.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-g">
<span id="cmdoption-gain"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--gain</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-g" title="Permalink to this definition"></a></dt>
<dd><p>Gain value multiplied to the data for unit conversion to nm.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-u">
<span id="cmdoption-gain-unit"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--gain-unit</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-u" title="Permalink to this definition"></a></dt>
<dd><p>Gain unit to write to data file.</p>
</dd></dl>
</section>
</section>
</section>
<div id="anchors-bottom"></div>
</div>
<div class="sidebar" role="navigation" aria-label="main navigation">
<div id="anchors-top"></div>
<div id="anchors" class="content">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ngl2caps</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#waveform-data">Waveform Data</a><ul>
<li><a class="reference internal" href="#format-describtions">Format describtions</a></li>
<li><a class="reference internal" href="#data-sources">Data sources</a></li>
<li><a class="reference internal" href="#fetch-data">Fetch data</a></li>
<li><a class="reference internal" href="#output-streams">Output streams</a></li>
</ul>
</li>
<li><a class="reference internal" href="#inventory">Inventory</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#input-event">Input event</a></li>
<li><a class="reference internal" href="#input-waveforms">Input waveforms</a></li>
<li><a class="reference internal" href="#filter">Filter</a></li>
<li><a class="reference internal" href="#id7">Streams</a></li>
<li><a class="reference internal" href="#id9">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="gdi2caps.html"
title="previous chapter">gdi2caps</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="orb2caps.html"
title="next chapter">orb2caps</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/ngl2caps.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="content">
Release <b></b> version <b>2025.254#f0c77b29e</b>
<div class="copyright">
&copy; Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
</div>
</div>
</div>
</div>
</body>
</html>