[installation] Change to nightly

share/doc/seiscomp/html/_sources/apps/global_iloc.rst.txt

@@ -205,9 +205,9 @@ the configuration in |scname|.
 Velocity models
 ---------------
 
-iLoc ships with the global models *iasp91* and *ak135* 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.
+iLoc ships with the global velocity models *iasp91* and *ak135* 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.
 
 
 .. _iloc-velocity_global:
@@ -215,8 +215,23 @@ the global models in areas where they are defined.
 Global models
 ~~~~~~~~~~~~~
 
-The global models *iasp91* and *ak135* and RSTT are available by default without
-further configuration.
+The global Earth velocity models *iasp91* and *ak135* as well as *RSTT*
+(section :ref:`iloc-velocity_rstt`) are available and applicable by default
+without further configuration if the default iLoc profile names *iasp91*
+and *ak135*, respectively, are considered. The same is true if explicit iLoc
+profiles using *iasp91* or *ak135* 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 :ref:`iloc-setup`. The respective model name is
+configured in :confval:`iLoc.profile.$name.globalModel`.
+
+Similar to :ref:`global_locsat` the global models require travel-time tables for
+each phase which is to be considered. The table files are located in
+:confval:`iLoc.auxDir`:file:`/[model name]`.
+
+If available, corrections for Earth's
+ellipticity are considered from
+:confval:`iLoc.auxDir`:file:`/[model name]/ELCOR.dat`, e.g.,
+:file:`@DATADIR@/iloc/iLocAuxDir/iasp91/ELCOR.dat`.
 
 
 .. _iloc-velocity_rstt:
@@ -224,7 +239,8 @@ further configuration.
 RSTT
 ~~~~
 
-RSTT are available in :file:`@DATADIR@/iloc/RSTTmodels/pdu202009Du.geotess`.
+RSTT are available in :file:`@DATADIR@/iloc/RSTTmodels/pdu202009Du.geotess` and
+applied by default.
 Custom RSTT can be integrated into iLoc and provided to |scname|.
 For adding custom RSTT to iLoc read the original iLoc documentation from the
 :cite:t:`iloc-github` software repository.
@@ -232,9 +248,13 @@ For adding custom RSTT to iLoc read the original iLoc documentation from the
 The usage of RSTT is controlled per iLoc profile by global configuration
 parameters
 
-* :confval:`iLoc.profile.$name.UseRSTT`
-* :confval:`iLoc.profile.$name.UseRSTTPnSn`
-* :confval:`iLoc.profile.$name.UseRSTTPgLg`
+* :confval:`iLoc.profile.$name.UseRSTT`,
+* :confval:`iLoc.profile.$name.UseRSTTPnSn`,
+* :confval:`iLoc.profile.$name.UseRSTTPgLg`.
+
+In order to adjust these configuration parameters for the *iasp91*,
+*ak135* or any other model, the profile must be added first as set out
+in section :ref:`iloc-setup`.
 
 
 .. _iloc-velocity_local:
@@ -258,8 +278,8 @@ Custom local velocity models can be provided by a file in
        45.000    8.0400    4.4800 MOHO
        77.500    8.0400    4.4800 x
 
-Once added, the velocity can be configured in |scname| as set out in section
-:ref:`iloc-setup`.
+Once added, the velocity can be configured along with iLoc profiles as set out
+in section :ref:`iloc-setup`.
 
 
 Station elevation
@@ -280,7 +300,7 @@ where
   of the phase name.
 
 
-.. note ::
+.. note::
 
    iLoc does not allow airquakes or source locations above datum (0 km). If the
    depth of an origin becomes negative, iLoc
@@ -332,7 +352,7 @@ Setup in |scname|
    installation read the install scripts located in
    :file:`@DATADIR@/deps/[os]/[version]/install-iloc.sh`.
 
-   .. note ::
+   .. note::
 
       * Check the :cite:t:`iloc-github` website for updates before downloading
         the file since the version number, hence the name of the download file
@@ -363,7 +383,7 @@ Setup in |scname|
      Activate the parameter to avoid phase renaming.
    * Consider the remaining parameters.
 
-   .. note ::
+   .. note::
 
       Creating the profiles allows using the same global velocity model along
       with different local models or RSTT settings in separate profiles.
@@ -411,7 +431,7 @@ which opens the iLoc settings dialog:
 
    Adjust the settings and click OK to confirm
 
-.. warning ::
+.. warning::
 
    By default, automatic phase renaming by iLoc is active. The renaming may
    change the phase names, e.g. from P to Pn.
@@ -450,9 +470,9 @@ Module Configuration
 
    Default: ``@DATADIR@/iloc/iLocAuxDir``
 
-   Type: *string*
+   Type: *directory*
 
-   iLoc directory for auxialiary files and directories. Some
+   iLoc directory for auxiliary files and directories. Some
    of them must be provided from the iLoc website. Read the
    documentation for their installation.
 
@@ -486,9 +506,9 @@ Module Configuration
 
    Type: *list:string*
 
-   iLoc profile name.
-   Multiples names may be set separated by comma.
-   Each profile can have different velocity or parameters.
+   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.
 
 
 .. note::
@@ -540,7 +560,7 @@ Module Configuration
 
    Type: *boolean*
 
-   Use regional seismic travel\-time tables
+   Use regional seismic travel\-time tables.
 
 
 .. confval:: iLoc.profile.$name.UseRSTTPnSn
@@ -549,7 +569,7 @@ Module Configuration
 
    Type: *boolean*
 
-   Use regional seismic travel\-time tables for Pn and Sn
+   Use regional seismic travel\-time tables for Pn and Sn.
 
 
 .. confval:: iLoc.profile.$name.UseRSTTPgLg
@@ -558,7 +578,7 @@ Module Configuration
 
    Type: *boolean*
 
-   Use regional seismic travel\-time tables for Pg and Lg
+   Use regional seismic travel\-time tables for Pg and Lg.
 
 
 .. confval:: iLoc.profile.$name.UseLocalTT
@@ -572,7 +592,7 @@ Module Configuration
 
 .. confval:: iLoc.profile.$name.LocalVmodel
 
-   Type: *string*
+   Type: *file*
 
    Full path to a file containing the local velocity model.
    Requires: UseLocalTT \= true. Empty string or unset or
@@ -602,7 +622,7 @@ Module Configuration
 
    Type: *boolean*
 
-   Perform neighbourhood algorithm
+   Perform neighbourhood algorithm.
 
 
 .. confval:: iLoc.profile.$name.NAsearchRadius
@@ -614,7 +634,7 @@ Module Configuration
    Unit: *deg*
 
    Neighbourhood Algorithm: Search radius around initial
-   epicentre
+   epicentre.
 
 
 .. confval:: iLoc.profile.$name.NAsearchDepth
@@ -626,7 +646,7 @@ Module Configuration
    Unit: *km*
 
    Neighbourhood Algorithm: Search radius around initial
-   depth
+   depth.
 
 
 .. confval:: iLoc.profile.$name.NAsearchOT
@@ -638,7 +658,7 @@ Module Configuration
    Unit: *s*
 
    Neighbourhood Algorithm: Search radius around initial
-   origin time
+   origin time.
 
 
 .. confval:: iLoc.profile.$name.NAlpNorm
@@ -647,54 +667,56 @@ Module Configuration
 
    Type: *float*
 
+   Range: ``1:2``
+
    Neighbourhood Algorithm: p\-value for norm to compute
-   misfit [1,2]
+   misfit.
 
 
 .. confval:: iLoc.profile.$name.NAiterMax
 
    Default: ``5``
 
-   Type: *integer*
+   Type: *int*
 
-   Neighbourhood Algorithm: Maximum number of iterations
+   Neighbourhood Algorithm: Maximum number of iterations.
 
 
 .. confval:: iLoc.profile.$name.NAcells
 
    Default: ``25``
 
-   Type: *integer*
+   Type: *int*
 
    Neighbourhood Algorithm: Number of cells to be resampled
-   at each iteration
+   at each iteration.
 
 
 .. confval:: iLoc.profile.$name.NAinitialSample
 
    Default: ``1000``
 
-   Type: *integer*
+   Type: *int*
 
-   Neighbourhood Algorithm: Size of initial sample
+   Neighbourhood Algorithm: Size of initial sample.
 
 
 .. confval:: iLoc.profile.$name.NAnextSample
 
    Default: ``100``
 
-   Type: *integer*
+   Type: *int*
 
-   Neighbourhood Algorithm: Size of subsequent samples
+   Neighbourhood Algorithm: Size of subsequent samples.
 
 
 .. confval:: iLoc.profile.$name.MinDepthPhases
 
    Default: ``3``
 
-   Type: *integer*
+   Type: *int*
 
-   Depth resolution: Minimum number of depth phases for depdp
+   Depth resolution: Minimum number of depth phases.
 
 
 .. confval:: iLoc.profile.$name.MaxLocalDistDeg
@@ -705,16 +727,16 @@ Module Configuration
 
    Unit: *deg*
 
-   Depth resolution: Maximum local distance
+   Depth resolution: Maximum local distance.
 
 
 .. confval:: iLoc.profile.$name.MinLocalStations
 
    Default: ``1``
 
-   Type: *integer*
+   Type: *int*
 
-   Depth resolution: Minimum number of local defining stations
+   Depth resolution: Minimum number of local defining stations.
 
 
 .. confval:: iLoc.profile.$name.MaxSPDistDeg
@@ -725,23 +747,24 @@ Module Configuration
 
    Unit: *deg*
 
-   Depth resolution: Maximum distance for using S\-P travel\-time differences.
+   Depth resolution: Maximum epicentral distance for
+   using S\-P travel\-time differences.
 
 
 .. confval:: iLoc.profile.$name.MinSPpairs
 
    Default: ``3``
 
-   Type: *integer*
+   Type: *int*
 
-   Depth resolution: Minimum number of defining S\-P phase pairs
+   Depth resolution: Minimum number of defining S\-P phase pairs.
 
 
 .. confval:: iLoc.profile.$name.MinCorePhases
 
    Default: ``3``
 
-   Type: *integer*
+   Type: *int*
 
    Depth resolution: Minimum number of defining core reflection phases
 
@@ -754,7 +777,7 @@ Module Configuration
 
    Unit: *km*
 
-   Depth resolution: Maximum depth error for crustal free\-depth
+   Depth resolution: Maximum depth error for crustal free\-depth.
 
 
 .. confval:: iLoc.profile.$name.MaxDeepDepthError
@@ -765,7 +788,7 @@ Module Configuration
 
    Unit: *km*
 
-   Depth resolution: Maximum depth error for deep free\-depth
+   Depth resolution: Maximum depth error for deep free\-depth.
 
 
 .. confval:: iLoc.profile.$name.DoCorrelatedErrors
@@ -774,7 +797,7 @@ Module Configuration
 
    Type: *boolean*
 
-   Linearized inversion: Account for correlated errors
+   Linearized inversion: Account for correlated errors.
 
 
 .. confval:: iLoc.profile.$name.SigmaThreshold
@@ -785,7 +808,7 @@ Module Configuration
 
    Unit: *s*
 
-   Linearized inversion: Used to exclude big residuals from solution
+   Linearized inversion: Used to exclude big residuals from solution.
 
 
 .. confval:: iLoc.profile.$name.AllowDamping
@@ -794,34 +817,34 @@ Module Configuration
 
    Type: *boolean*
 
-   Linearized inversion: Allow damping of model vector
+   Linearized inversion: Allow damping of model vector.
 
 
 .. confval:: iLoc.profile.$name.MinIterations
 
    Default: ``4``
 
-   Type: *integer*
+   Type: *int*
 
-   Linearized inversion: Minimum number of iterations
+   Linearized inversion: Minimum number of iterations.
 
 
 .. confval:: iLoc.profile.$name.MaxIterations
 
    Default: ``20``
 
-   Type: *integer*
+   Type: *int*
 
-   Linearized inversion: Maximum number of iterations
+   Linearized inversion: Maximum number of iterations.
 
 
 .. confval:: iLoc.profile.$name.MinNdefPhases
 
    Default: ``4``
 
-   Type: *integer*
+   Type: *int*
 
-   Linearized inversion: Minimum number of defining phases
+   Linearized inversion: Minimum number of defining phases.
 
 
 .. confval:: iLoc.profile.$name.DoNotRenamePhases