[installation] Change to nightly

This commit is contained in:
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions

View File

@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>iLoc &#8212; SeisComP Release documentation</title>
<title>iLoc &#8212; SeisComP Development documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/seiscomp.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=823bb831"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=744d344a"></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" />
@ -25,8 +25,8 @@
<div class="container">
<div class="brand">
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
<!-- span class="title">SeisComP Release</span -->
<span class="version">6.9.0</span>
<!-- span class="title">SeisComP Development</span -->
<span class="version">7.0.0</span>
</div>
</div>
</div>
@ -78,7 +78,7 @@
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>iLoc is a locator developed by István Bondár which has been integrated into
<cite>SeisComP</cite> by <span id="id1"><em>gempa GmbH</em> [<a class="reference internal" href="../base/references.html#id122" title="gempa GmbH. The SeisComP development and maintenance company. URL: https://www.gempa.de/.">28</a>]</span>. It is invoked by the wrapper plugin <em>lociloc</em> - the
<cite>SeisComP</cite> by <span id="id1"><em>gempa GmbH</em> [<a class="reference internal" href="../base/references.html#id147" title="gempa GmbH. The SeisComP development and maintenance company. URL: https://www.gempa.de.">31</a>]</span>. It is invoked by the wrapper plugin <em>lociloc</em> - the
interface between <cite>SeisComP</cite> and iLoc.
Read the sections <a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a> and <a class="reference internal" href="#iloc-application"><span class="std std-ref">Application in SeisComP</span></a> for
configuring and using iLoc in <cite>SeisComP</cite>.</p>
@ -87,10 +87,10 @@ configuring and using iLoc in <cite>SeisComP</cite>.</p>
<p>iLoc is a locator tool for locating seismic, hydroacoustic and
infrasound sources
based on <a class="reference internal" href="../base/glossary.html#term-pick"><span class="xref std std-term">phase picks</span></a>. iLoc is based on the location
algorithm developed by <span id="id2">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id12" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">34</a>]</span> and implemented at the
International Seismological Center, (<span id="id3"><em>ISC</em> [<a class="reference internal" href="../base/references.html#id140" title="ISC. International Seismological Centre. URL: http://www.isc.ac.uk/.">14</a>]</span>, <span id="id4">Bondár <em>et al.</em> [<a class="reference internal" href="../base/references.html#id16" title="I. Bondár, P. Mónus, C. Czanik, M. Kiszely, Z. Gráczer, Z. Wéber, and the AlpArrayWorking Group. Relocation of Seismicity in the Pannonian Basin Using a Global 3D Velocity Model. Seismol. Res. Lett., 6:2284 2293, 2018. doi:10.1785/0220180143.">36</a>]</span>)
with numerous new features added (<span id="id5">Bondár <em>et al.</em> [<a class="reference internal" href="../base/references.html#id16" title="I. Bondár, P. Mónus, C. Czanik, M. Kiszely, Z. Gráczer, Z. Wéber, and the AlpArrayWorking Group. Relocation of Seismicity in the Pannonian Basin Using a Global 3D Velocity Model. Seismol. Res. Lett., 6:2284 2293, 2018. doi:10.1785/0220180143.">36</a>]</span>).
The stand-alone iLoc code can be downloaded from the <span id="id6"></span>
algorithm developed by <span id="id2">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id19" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">42</a>]</span> and implemented at the
International Seismological Center, (<span id="id3"><em>ISC</em> [<a class="reference internal" href="../base/references.html#id167" title="ISC. International Seismological Centre. URL: http://www.isc.ac.uk/.">13</a>]</span>, <span id="id4">Bondár <em>et al.</em> [<a class="reference internal" href="../base/references.html#id23" title="I. Bondár, P. Mónus, C. Czanik, M. Kiszely, Z. Gráczer, Z. Wéber, and the AlpArrayWorking Group. Relocation of Seismicity in the Pannonian Basin Using a Global 3D Velocity Model. Seismol. Res. Lett., 6:2284 2293, 2018. doi:10.1785/0220180143.">44</a>]</span>)
with numerous new features added (<span id="id5">Bondár <em>et al.</em> [<a class="reference internal" href="../base/references.html#id23" title="I. Bondár, P. Mónus, C. Czanik, M. Kiszely, Z. Gráczer, Z. Wéber, and the AlpArrayWorking Group. Relocation of Seismicity in the Pannonian Basin Using a Global 3D Velocity Model. Seismol. Res. Lett., 6:2284 2293, 2018. doi:10.1785/0220180143.">44</a>]</span>).
The stand-alone iLoc code can be downloaded from the <span id="id6"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span>
software repository.</p>
<p>Among the major advantages of using iLoc is that it can</p>
<ul class="simple">
@ -111,7 +111,7 @@ hypocenter depth;</p></li>
<ul class="simple">
<li><p>Originally developed for U.S. Air Force Research Laboratory, today the standard
at the International Seismological Centre (ISC) replacing previous routines</p></li>
<li><p>Open source, download website: <span id="id7"></span></p></li>
<li><p>Open source, download website: <span id="id7"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span></p></li>
<li><p>Integrated first in SeisComP3 in 2019</p></li>
<li><p>Basis of the EMSC crowd-source locator, CsLoc since 2019</p></li>
<li><p>EMSC standard as of 2022</p></li>
@ -137,12 +137,12 @@ Attempts for free-depth solution only if there is depth resolution</p></li>
<h3>Algorithms<a class="headerlink" href="#algorithms" title="Permalink to this heading"></a></h3>
<p>This section describes some of the principles. The full description of the applied
algorithms can be found in the iLoc documentation provided along with the package
on the <span id="id8"></span> website.</p>
on the <span id="id8"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span> website.</p>
<section id="neighbourhood-algorithm">
<h4>Neighbourhood algorithm<a class="headerlink" href="#neighbourhood-algorithm" title="Permalink to this heading"></a></h4>
<p>Linearized inversion algorithms are quite sensitive to the initial guess. In order
to find an initial hypocenter guess for the linearized inversion the Neigbourhood
Algorithm (<span id="id9">Sambridge [<a class="reference internal" href="../base/references.html#id73" title="M. Sambridge. Geophysical inversion with a neighbourhood algorithm. I. Searching the parameter space. Geophys. J. Int., 2:479 494, 1999. doi:10.1046/j.1365-246X.1999.00876.x.">60</a>]</span>; <span id="id10">Sambridge and Kennett [<a class="reference internal" href="../base/references.html#id74" title="M. Sambridge and B.L.N. Kennett. Seismic event location: non-linear inversion using a neighbourhood algorithm. Pure and Applied Geophysics, 151(1):241 257, 2001. doi:10.1007/PL00001158.">61</a>]</span>) is performed
Algorithm (<span id="id9">Sambridge [<a class="reference internal" href="../base/references.html#id94" title="M. Sambridge. Geophysical inversion with a neighbourhood algorithm. I. Searching the parameter space. Geophys. J. Int., 2:479 494, 1999. doi:10.1046/j.1365-246X.1999.00876.x.">69</a>]</span>; <span id="id10">Sambridge and Kennett [<a class="reference internal" href="../base/references.html#id95" title="M. Sambridge and B.L.N. Kennett. Seismic event location: non-linear inversion using a neighbourhood algorithm. Pure and Applied Geophysics, 151(1):241 257, 2001. doi:10.1007/PL00001158.">70</a>]</span>) is performed
around the starting hypocentre if <a class="reference internal" href="#confval-iLoc.profile.-name.DoGridSearch"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.DoGridSearch</span></code></a> is active.</p>
<p>During the NA search, we identify the phases with respect to each trial hypocenter
and calculate the misfit of the trial hypocenter. The misfit is defined as the sum
@ -172,24 +172,24 @@ and to a lesser extent near-regional secondary phases. iLoc attempts for a free-
solution if the set of :term:arrivals meets at least one of the following conditions:</p>
<ul class="simple">
<li><p>Number of pairs of defining P and depth phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinDepthPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinDepthPhases</span></code></a></p></li>
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.svg" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinDepthPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinDepthPhases</span></code></a></p></li>
<li><p>Number of pairs of defining P and core phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinCorePhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinCorePhases</span></code></a></p></li>
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.svg" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinCorePhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinCorePhases</span></code></a></p></li>
<li><p>Number of pairs of defining P and S phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinSPpairs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinSPpairs</span></code></a>
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.svg" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinSPpairs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinSPpairs</span></code></a>
within a regional distance of <a class="reference internal" href="#confval-iLoc.profile.-name.MaxLocalDistDeg"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MaxLocalDistDeg</span></code></a>
degree</p></li>
<li><p>Number of defining P phases
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.png" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinLocalStations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinLocalStations</span></code></a>
<img class="math" src="../_images/math/cd836da15c805704a25218271107e7935265b89e.svg" alt="\le"/> <a class="reference internal" href="#confval-iLoc.profile.-name.MinLocalStations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinLocalStations</span></code></a>
within a local distance of <a class="reference internal" href="#confval-iLoc.profile.-name.MinLocalStations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinLocalStations</span></code></a>
degree.</p></li>
</ul>
<p>If there is insufficient depth resolution provided by the data, or the depth uncertainty
for a free-depth solution exceeds a threshold, the hypocentre depth is set to the depth
from the default depth grid if a grid point for the epicentre location exists; otherwise
it is set to a depth <span id="id11">Bolton <em>et al.</em> [<a class="reference internal" href="../base/references.html#id9" title="M.K. Bolton, D.A. Storchak, and J. Harris. Updating default depth in the isc bulletin. Phys. Earth Planet. Int., 1:27 - 45, 2006. doi:10.1016/j.pepi.2006.03.004.">33</a>]</span> assigned to
it is set to a depth <span id="id11">Bolton <em>et al.</em> [<a class="reference internal" href="../base/references.html#id16" title="M.K. Bolton, D.A. Storchak, and J. Harris. Updating default depth in the isc bulletin. Phys. Earth Planet. Int., 1:27 - 45, 2006. doi:10.1016/j.pepi.2006.03.004.">41</a>]</span> assigned to
the corresponding Flinn-Engdahl geographic
region (<span id="id12">Young <em>et al.</em> [<a class="reference internal" href="../base/references.html#id86" title="J.B. Young, B.W. Presgrave, H. Aichele, D.A. Wiens, and E.A. Flinn. The Flinn-Engdahl Regionalisation Scheme: The 1995 revision. Phys. Earth Planet. Int., 96:223 - 297, 1996. doi:10.1016/0031-9201(96)03141-X.">66</a>]</span>). The default depth grid (<span id="id13">Bondár and Storchak [<a class="reference internal" href="../base/references.html#id14" title="I. Bondár and D. Storchak. Improved location procedures at the International Seismological Centre. Geophys. J. Int., 3:1220 1244, 2011. doi:10.1111/j.1365-246X.2011.05107.x.">37</a>]</span>)
region (<span id="id12">Young <em>et al.</em> [<a class="reference internal" href="../base/references.html#id109" title="J.B. Young, B.W. Presgrave, H. Aichele, D.A. Wiens, and E.A. Flinn. The Flinn-Engdahl Regionalisation Scheme: The 1995 revision. Phys. Earth Planet. Int., 96:223 - 297, 1996. doi:10.1016/0031-9201(96)03141-X.">75</a>]</span>). The default depth grid (<span id="id13">Bondár and Storchak [<a class="reference internal" href="../base/references.html#id21" title="I. Bondár and D. Storchak. Improved location procedures at the International Seismological Centre. Geophys. J. Int., 3:1220 1244, 2011. doi:10.1111/j.1365-246X.2011.05107.x.">45</a>]</span>)
is defined on a 0.5º x 0.5º grid as the median of all depths in the cell, provided
that there were at least five events in the cell, and the 7525 percent quartile
range was less than 100 km. The latter constraint is imposed to avoid regions with
@ -212,23 +212,23 @@ Finally, the user can fix the depth to the initial depth.</p>
<h4>Linearized inversion<a class="headerlink" href="#linearized-inversion" title="Permalink to this heading"></a></h4>
<p>Once the Neighbourhood search get close to the global optimum, iloc switches
to an iterative linearized least-squares inversion of travel-time, azimuth and
slowness observations (<span id="id14">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id13" title="I. Bondár and K.L. McLaughlin. Seismic location bias and uncertainty in the presence of correlated and non-gaussian travel-time errors. Bull. Seismol. Soc. Am., 1:172 193, 2009. doi:10.1785/0120080922.">35</a>]</span>; <span id="id15">Bondár and Storchak [<a class="reference internal" href="../base/references.html#id14" title="I. Bondár and D. Storchak. Improved location procedures at the International Seismological Centre. Geophys. J. Int., 3:1220 1244, 2011. doi:10.1111/j.1365-246X.2011.05107.x.">37</a>]</span>) to obtain the final solution
slowness observations (<span id="id14">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id20" title="I. Bondár and K.L. McLaughlin. Seismic location bias and uncertainty in the presence of correlated and non-gaussian travel-time errors. Bull. Seismol. Soc. Am., 1:172 193, 2009. doi:10.1785/0120080922.">43</a>]</span>; <span id="id15">Bondár and Storchak [<a class="reference internal" href="../base/references.html#id21" title="I. Bondár and D. Storchak. Improved location procedures at the International Seismological Centre. Geophys. J. Int., 3:1220 1244, 2011. doi:10.1111/j.1365-246X.2011.05107.x.">45</a>]</span>) to obtain the final solution
for the hypocenter.</p>
<p>The convergence test after (<span id="id16">Paige and Saunders [<a class="reference internal" href="../base/references.html#id59" title="C. Paige and M. Saunders. Lsqr: an algorithm for sparse linear equations and sparse least squares. ACM Transactions on Mathematical Software, 1:43 - 71, 1982. doi:10.1145/355984.355989.">54</a>]</span>) is
<p>The convergence test after (<span id="id16">Paige and Saunders [<a class="reference internal" href="../base/references.html#id77" title="C. Paige and M. Saunders. Lsqr: an algorithm for sparse linear equations and sparse least squares. ACM Transactions on Mathematical Software, 1:43 - 71, 1982. doi:10.1145/355984.355989.">63</a>]</span>) is
applied after every iteration. Once a convergent solution is obtained, the location
uncertainty is defined by the a posteriori model covariance matrix. The model
covariance matrix yields the four-dimensional error ellipsoid whose projections
provide the two-dimensional error ellipse and one-dimensional errors for depth
and origin time. These uncertainties are scaled to the 90% confidence level
(<span id="id17">Jordan and Sverdrup [<a class="reference internal" href="../base/references.html#id41" title="T.H. Jordan and K.A. Sverdrup. Teleseismic location techniques and their application to earthquake clusters in the south-central pacific. Bull. Seismol. Soc. Am., 4:1105 1130, 1981. doi:10.1785/BSSA0710041105.">47</a>]</span>).</p>
(<span id="id17">Jordan and Sverdrup [<a class="reference internal" href="../base/references.html#id56" title="T.H. Jordan and K.A. Sverdrup. Teleseismic location techniques and their application to earthquake clusters in the south-central pacific. Bull. Seismol. Soc. Am., 4:1105 1130, 1981. doi:10.1785/BSSA0710041105.">55</a>]</span>).</p>
<p>The final hypocentre is tested against the
ground truth selection criteria (<span id="id18">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id12" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">34</a>]</span>),
ground truth selection criteria (<span id="id18">Bondár and McLaughlin [<a class="reference internal" href="../base/references.html#id19" title="I. Bondár and K.L. McLaughlin. A new ground truth data set for seismic studies. Seismol. Res. Lett., 3:465 - 472, 2009. doi:10.1785/gssrl.80.3.465.">42</a>]</span>),
and it is reported as
a GT5candidate if the solution meets the GT5 criteria.</p>
<p>Some important parameters are:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.SigmaThreshold"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.SigmaThreshold</span></code></a>: Residuals that exceed
<img class="math" src="../_images/math/07995ff78d6ae4e3ecb50d9c0740eb0addf47d94.png" alt="abs(Sigmathreshold * PriorMeasError)"/> are made non-defining.</p></li>
<img class="math" src="../_images/math/07995ff78d6ae4e3ecb50d9c0740eb0addf47d94.svg" alt="abs(Sigmathreshold * PriorMeasError)"/> are made non-defining.</p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.MinNdefPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.MinNdefPhases</span></code></a>: Minimum number of observations
required to attempt for a solution.</p></li>
</ul>
@ -241,7 +241,7 @@ be used in the location.</p>
<h3>Integration into <cite>SeisComP</cite><a class="headerlink" href="#integration-into-scname" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Integration of iLoc into <cite>SeisComP</cite> is provided by an external library of
routines (<span id="id19"></span>).</p></li>
routines (<span id="id19"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span>).</p></li>
<li><p><cite>SeisComP</cite> modules call iLoc routines by passing the objects via the plugin
<em>lociloc</em> installed in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/plugins/lociloc.so</span></code>.</p></li>
<li><p>iLoc returns objects to <cite>SeisComP</cite> for integration.</p></li>
@ -252,27 +252,44 @@ the configuration in <cite>SeisComP</cite>.</p>
</section>
<section id="velocity-models">
<h3>Velocity models<a class="headerlink" href="#velocity-models" title="Permalink to this heading"></a></h3>
<p>iLoc ships with the global models <em>iasp91</em> and <em>ak135</em> as well as with regional
seismic travel-time tables, RSTT, which, if activated by configuration, replaces
the global models in areas where they are defined.</p>
<p>iLoc ships with the global velocity models <em>iasp91</em> and <em>ak135</em> as well as with
regional seismic travel-time tables, RSTT, which, if activated by configuration,
replace the global models in areas where they are defined.</p>
<section id="global-models">
<span id="iloc-velocity-global"></span><h4>Global models<a class="headerlink" href="#global-models" title="Permalink to this heading"></a></h4>
<p>The global models <em>iasp91</em> and <em>ak135</em> and RSTT are available by default without
further configuration.</p>
<p>The global Earth velocity models <em>iasp91</em> and <em>ak135</em> as well as <em>RSTT</em>
(section <a class="reference internal" href="#iloc-velocity-rstt"><span class="std std-ref">RSTT</span></a>) are available and applicable by default
without further configuration if the default iLoc profile names <em>iasp91</em>
and <em>ak135</em>, respectively, are considered. The same is true if explicit iLoc
profiles using <em>iasp91</em> or <em>ak135</em> for the profile names are added to the iLoc
configuration. Any other global model can be added, by explicitly adding an iLoc
profile as set out in section <a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a>. The respective model name is
configured in <a class="reference internal" href="#confval-iLoc.profile.-name.globalModel"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.globalModel</span></code></a>.</p>
<p>Similar to <a class="reference internal" href="global_locsat.html#global-locsat"><span class="std std-ref">LOCSAT</span></a> the global models require travel-time tables for
each phase which is to be considered. The table files are located in
<a class="reference internal" href="#confval-iLoc.auxDir"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.auxDir</span></code></a><code class="file docutils literal notranslate"><span class="pre">/[model</span> <span class="pre">name]</span></code>.</p>
<p>If available, corrections for Earths
ellipticity are considered from
<a class="reference internal" href="#confval-iLoc.auxDir"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.auxDir</span></code></a><code class="file docutils literal notranslate"><span class="pre">/[model</span> <span class="pre">name]/ELCOR.dat</span></code>, e.g.,
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/iLocAuxDir/iasp91/ELCOR.dat</span></code>.</p>
</section>
<section id="rstt">
<span id="iloc-velocity-rstt"></span><h4>RSTT<a class="headerlink" href="#rstt" title="Permalink to this heading"></a></h4>
<p>RSTT are available in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/RSTTmodels/pdu202009Du.geotess</span></code>.
<p>RSTT are available in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/RSTTmodels/pdu202009Du.geotess</span></code> and
applied by default.
Custom RSTT can be integrated into iLoc and provided to <cite>SeisComP</cite>.
For adding custom RSTT to iLoc read the original iLoc documentation from the
<span id="id20"></span> software repository.</p>
<span id="id20"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span> software repository.</p>
<p>The usage of RSTT is controlled per iLoc profile by global configuration
parameters</p>
<ul class="simple">
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTT"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTT</span></code></a></p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPnSn"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPnSn</span></code></a></p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPgLg"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPgLg</span></code></a></p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTT"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTT</span></code></a>,</p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPnSn"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPnSn</span></code></a>,</p></li>
<li><p><a class="reference internal" href="#confval-iLoc.profile.-name.UseRSTTPgLg"><code class="xref std std-confval docutils literal notranslate"><span class="pre">iLoc.profile.$name.UseRSTTPgLg</span></code></a>.</p></li>
</ul>
<p>In order to adjust these configuration parameters for the <em>iasp91</em>,
<em>ak135</em> or any other model, the profile must be added first as set out
in section <a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a>.</p>
</section>
<section id="local-velocity-models">
<span id="iloc-velocity-local"></span><h4>Local velocity models<a class="headerlink" href="#local-velocity-models" title="Permalink to this heading"></a></h4>
@ -290,8 +307,8 @@ parameters</p>
<span class="w"> </span><span class="na">77.500</span><span class="w"> </span><span class="s">8.0400 4.4800 x</span>
</pre></div>
</div>
<p>Once added, the velocity can be configured in <cite>SeisComP</cite> as set out in section
<a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a>.</p>
<p>Once added, the velocity can be configured along with iLoc profiles as set out
in section <a class="reference internal" href="#iloc-setup"><span class="std std-ref">Setup in SeisComP</span></a>.</p>
</section>
</section>
<section id="station-elevation">
@ -299,7 +316,7 @@ parameters</p>
<p>iLoc considers station elevation. It calculates the elevation correction,
<em>elevationCorrection</em>, for a station as</p>
<div class="math">
<p><img src="../_images/math/5f9c3c10facedc7a9d6e72dcdc5f421acb20e77c.png" alt="elevationCorrection = \frac{\sqrt{1 - (surfVel * p)^2} * elev}{surfVel}"/></p>
<p><img src="../_images/math/5f9c3c10facedc7a9d6e72dcdc5f421acb20e77c.svg" alt="elevationCorrection = \frac{\sqrt{1 - (surfVel * p)^2} * elev}{surfVel}"/></p>
</div><p>where</p>
<ul class="simple">
<li><p><em>elev</em>: elevation of the station</p></li>
@ -336,21 +353,21 @@ Read the section <a class="reference internal" href="../base/references.html#sec
</pre></div>
</div>
<p>In case the variable is undefined, follow the instructions in section
<span class="xref std std-ref">getting-started-variables</span>.</p>
<a class="reference internal" href="../base/getting-started.html#getting-started-variables"><span class="std std-ref">Environment variables</span></a>.</p>
<p>After <em>$SEISCOMP_ROOT</em> is defined you may install the software dependencies
for iLoc using the <a class="reference internal" href="../base/installation.html#software-dependencies"><span class="std std-ref">install scripts</span></a> or simply
the <a class="reference internal" href="seiscomp.html#seiscomp"><span class="std std-ref">seiscomp</span></a> script:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>install-deps<span class="w"> </span>iloc
</pre></div>
</div>
<p>The install scripts will fetch auxiliary files from <span id="id21"></span>
<p>The install scripts will fetch auxiliary files from <span id="id21"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span>
and install them in <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/iLocAuxDir</span></code>. For manual download and
installation read the install scripts located in
<code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/deps/[os]/[version]/install-iloc.sh</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>Check the <span id="id22"></span> website for updates before downloading
<li><p>Check the <span id="id22"><em>iLoc source code</em> [<a class="reference internal" href="../base/references.html#id169" title="iLoc source code. GitHub. URL: https://github.com/IstvanBondar/iLoc.">34</a>]</span> website for updates before downloading
the file since the version number, hence the name of the download file
may change.</p></li>
<li><p>Instead of generating the <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/share/iloc/iLocAuxDir</span></code>
@ -459,8 +476,8 @@ phase is p or Pn and not P but <cite>SeisComP</cite> provides P.</p>
<dt class="sig sig-object std" id="confval-iLoc.auxDir">
<span class="sig-name descname"><span class="pre">iLoc.auxDir</span></span><a class="headerlink" href="#confval-iLoc.auxDir" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/iloc/iLocAuxDir</span></code></p>
<p>Type: <em>string</em></p>
<p>iLoc directory for auxialiary files and directories. Some
<p>Type: <em>directory</em></p>
<p>iLoc directory for auxiliary files and directories. Some
of them must be provided from the iLoc website. Read the
documentation for their installation.</p>
</dd></dl>
@ -490,9 +507,9 @@ is disabled.</p>
<span class="sig-name descname"><span class="pre">iLoc.profiles</span></span><a class="headerlink" href="#confval-iLoc.profiles" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">iasp91,ak135</span></code></p>
<p>Type: <em>list:string</em></p>
<p>iLoc profile name.
Multiples names may be set separated by comma.
Each profile can have different velocity or parameters.</p>
<p>List of iLoc profile name(s). Separate multiple names by comma.
Each profile can have different velocity or parameters. The
must be defined separate by iLoc profiles.</p>
</dd></dl>
<div class="admonition note">
@ -538,7 +555,7 @@ unset, the name of the profile is considered instead.</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseRSTT</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseRSTT" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use regional seismic travel-time tables</p>
<p>Use regional seismic travel-time tables.</p>
</dd></dl>
<dl class="std confval">
@ -546,7 +563,7 @@ unset, the name of the profile is considered instead.</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseRSTTPnSn</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseRSTTPnSn" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use regional seismic travel-time tables for Pn and Sn</p>
<p>Use regional seismic travel-time tables for Pn and Sn.</p>
</dd></dl>
<dl class="std confval">
@ -554,7 +571,7 @@ unset, the name of the profile is considered instead.</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.UseRSTTPgLg</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.UseRSTTPgLg" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Use regional seismic travel-time tables for Pg and Lg</p>
<p>Use regional seismic travel-time tables for Pg and Lg.</p>
</dd></dl>
<dl class="std confval">
@ -568,7 +585,7 @@ unset, the name of the profile is considered instead.</p>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.LocalVmodel">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.LocalVmodel</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.LocalVmodel" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<dd><p>Type: <em>file</em></p>
<p>Full path to a file containing the local velocity model.
Requires: UseLocalTT = true. Empty string or unset or
UseLocalTT = false disables using a local model in
@ -592,7 +609,7 @@ velocity model.</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.DoGridSearch</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.DoGridSearch" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Perform neighbourhood algorithm</p>
<p>Perform neighbourhood algorithm.</p>
</dd></dl>
<dl class="std confval">
@ -602,7 +619,7 @@ velocity model.</p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Neighbourhood Algorithm: Search radius around initial
epicentre</p>
epicentre.</p>
</dd></dl>
<dl class="std confval">
@ -612,7 +629,7 @@ epicentre</p>
<p>Type: <em>float</em></p>
<p>Unit: <em>km</em></p>
<p>Neighbourhood Algorithm: Search radius around initial
depth</p>
depth.</p>
</dd></dl>
<dl class="std confval">
@ -622,7 +639,7 @@ depth</p>
<p>Type: <em>float</em></p>
<p>Unit: <em>s</em></p>
<p>Neighbourhood Algorithm: Search radius around initial
origin time</p>
origin time.</p>
</dd></dl>
<dl class="std confval">
@ -630,49 +647,50 @@ origin time</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAlpNorm</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAlpNorm" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>float</em></p>
<p>Range: <code class="docutils literal notranslate"><span class="pre">1:2</span></code></p>
<p>Neighbourhood Algorithm: p-value for norm to compute
misfit [1,2]</p>
misfit.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAiterMax">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAiterMax</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAiterMax" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Maximum number of iterations</p>
<p>Type: <em>int</em></p>
<p>Neighbourhood Algorithm: Maximum number of iterations.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAcells">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAcells</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAcells" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">25</span></code></p>
<p>Type: <em>integer</em></p>
<p>Type: <em>int</em></p>
<p>Neighbourhood Algorithm: Number of cells to be resampled
at each iteration</p>
at each iteration.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAinitialSample">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAinitialSample</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAinitialSample" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Size of initial sample</p>
<p>Type: <em>int</em></p>
<p>Neighbourhood Algorithm: Size of initial sample.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.NAnextSample">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.NAnextSample</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.NAnextSample" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p>
<p>Type: <em>integer</em></p>
<p>Neighbourhood Algorithm: Size of subsequent samples</p>
<p>Type: <em>int</em></p>
<p>Neighbourhood Algorithm: Size of subsequent samples.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinDepthPhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinDepthPhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinDepthPhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of depth phases for depdp</p>
<p>Type: <em>int</em></p>
<p>Depth resolution: Minimum number of depth phases.</p>
</dd></dl>
<dl class="std confval">
@ -681,15 +699,15 @@ at each iteration</p>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.2</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Depth resolution: Maximum local distance</p>
<p>Depth resolution: Maximum local distance.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinLocalStations">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinLocalStations</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinLocalStations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of local defining stations</p>
<p>Type: <em>int</em></p>
<p>Depth resolution: Minimum number of local defining stations.</p>
</dd></dl>
<dl class="std confval">
@ -698,22 +716,23 @@ at each iteration</p>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">2.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>deg</em></p>
<p>Depth resolution: Maximum distance for using S-P travel-time differences.</p>
<p>Depth resolution: Maximum epicentral distance for
using S-P travel-time differences.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinSPpairs">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinSPpairs</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinSPpairs" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>integer</em></p>
<p>Depth resolution: Minimum number of defining S-P phase pairs</p>
<p>Type: <em>int</em></p>
<p>Depth resolution: Minimum number of defining S-P phase pairs.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinCorePhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinCorePhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinCorePhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
<p>Type: <em>integer</em></p>
<p>Type: <em>int</em></p>
<p>Depth resolution: Minimum number of defining core reflection phases</p>
</dd></dl>
@ -723,7 +742,7 @@ at each iteration</p>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>km</em></p>
<p>Depth resolution: Maximum depth error for crustal free-depth</p>
<p>Depth resolution: Maximum depth error for crustal free-depth.</p>
</dd></dl>
<dl class="std confval">
@ -732,7 +751,7 @@ at each iteration</p>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">60.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>km</em></p>
<p>Depth resolution: Maximum depth error for deep free-depth</p>
<p>Depth resolution: Maximum depth error for deep free-depth.</p>
</dd></dl>
<dl class="std confval">
@ -740,7 +759,7 @@ at each iteration</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.DoCorrelatedErrors</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.DoCorrelatedErrors" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Linearized inversion: Account for correlated errors</p>
<p>Linearized inversion: Account for correlated errors.</p>
</dd></dl>
<dl class="std confval">
@ -749,7 +768,7 @@ at each iteration</p>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">6.0</span></code></p>
<p>Type: <em>float</em></p>
<p>Unit: <em>s</em></p>
<p>Linearized inversion: Used to exclude big residuals from solution</p>
<p>Linearized inversion: Used to exclude big residuals from solution.</p>
</dd></dl>
<dl class="std confval">
@ -757,31 +776,31 @@ at each iteration</p>
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.AllowDamping</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.AllowDamping" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Linearized inversion: Allow damping of model vector</p>
<p>Linearized inversion: Allow damping of model vector.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinIterations">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinIterations</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinIterations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">4</span></code></p>
<p>Type: <em>integer</em></p>
<p>Linearized inversion: Minimum number of iterations</p>
<p>Type: <em>int</em></p>
<p>Linearized inversion: Minimum number of iterations.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MaxIterations">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MaxIterations</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MaxIterations" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>integer</em></p>
<p>Linearized inversion: Maximum number of iterations</p>
<p>Type: <em>int</em></p>
<p>Linearized inversion: Maximum number of iterations.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-iLoc.profile.-name.MinNdefPhases">
<span class="sig-name descname"><span class="pre">iLoc.profile.$name.MinNdefPhases</span></span><a class="headerlink" href="#confval-iLoc.profile.-name.MinNdefPhases" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">4</span></code></p>
<p>Type: <em>integer</em></p>
<p>Linearized inversion: Minimum number of defining phases</p>
<p>Type: <em>int</em></p>
<p>Linearized inversion: Minimum number of defining phases.</p>
</dd></dl>
<dl class="std confval">
@ -876,7 +895,7 @@ profile.</p>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>6.9.0</b> Release
Version <b>7.0.0</b> Development
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.