regen docs

crotwell · Dec 5, 2024 · bb8b438 · bb8b438
1 parent 9338fdd
commit bb8b438
Show file tree

Hide file tree

Showing 21 changed files with 162 additions and 53 deletions.
diff --git a/docs/manual/_static/StdModels/constant.tvel b/docs/manual/_static/StdModels/constant.tvel
diff --git a/docs/manual/distribution.html b/docs/manual/distribution.html
@@ -107,7 +107,7 @@ <h3 id="searchlabel">Quick search</h3>
 <h1>Distribution<a class="headerlink" href="#distribution" title="Link to this heading">¶</a></h1>
 <section id="what-and-where">
 <h2>What and Where<a class="headerlink" href="#what-and-where" title="Link to this heading">¶</a></h2>
-<p>The current distribution of the TauP package is 3.0.0-SNAPSHOT8, created Nov 06, 2024.</p>
+<p>The current distribution of the TauP package is 3.0.0-SNAPSHOT8, created Dec 05, 2024.</p>
 <p>Downloads available from either
 <a class="reference external" href="https://github.com/crotwell/TauP/releases">GitHub</a> or
 <a class="reference external" href="https://zenodo.org/records/10794858">Zenodo</a>. Installation also

diff --git a/docs/manual/index.html b/docs/manual/index.html
@@ -102,7 +102,7 @@ <h1>The TauP Toolkit<a class="headerlink" href="#the-taup-toolkit" title="Link t
 <section id="version-version">
 <h2>Version 3.0<a class="headerlink" href="#version-version" title="Link to this heading">¶</a></h2>
 <p>Flexible Seismic Travel-Time and Raypath Utilities.
-Release 3.0.0-SNAPSHOT8, created Nov 06, 2024.</p>
+Release 3.0.0-SNAPSHOT8, created Dec 05, 2024.</p>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
@@ -154,6 +154,7 @@ <h2>Version 3.0<a class="headerlink" href="#version-version" title="Link to this
 <li class="toctree-l1"><a class="reference internal" href="models.html">Velocity Models</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="models.html#velocity-model-files">Velocity Model Files</a></li>
 <li class="toctree-l2"><a class="reference internal" href="models.html#using-saved-tau-models">Using Saved Tau Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="models.html#notes-on-standard-models">Notes on Standard Models</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="programming.html">Programmatic Access</a><ul>

diff --git a/docs/manual/models.html b/docs/manual/models.html
@@ -62,6 +62,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Velocity Models</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#velocity-model-files">Velocity Model Files</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#using-saved-tau-models">Using Saved Tau Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#notes-on-standard-models">Notes on Standard Models</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="programming.html">Programmatic Access</a></li>
@@ -346,6 +347,117 @@ <h2>Using Saved Tau Models<a class="headerlink" href="#using-saved-tau-models" t
 reprocessing them each time the tool starts.</p></li>
 </ul>
 </section>
+<section id="notes-on-standard-models">
+<h2>Notes on Standard Models<a class="headerlink" href="#notes-on-standard-models" title="Link to this heading">¶</a></h2>
+<ul>
+<li><p>ak135</p>
+<p>There is a discontinuity in S velocity, but not for P or density at 210 km.
+The effect on travel times is small, but this odd discontinuity in S
+velocity at 210 creates odd reflection and transmission coefficients at
+this depth. This discontinuity does not exist in the ak135f models for
+velocity, but the 210 a discontinuity in the Q model.</p>
+<p>``
+210.000      8.3000      4.5180      3.4258
+210.000      8.3000      4.5230      3.4258
+``</p>
+<p>There is a non-discontinuity discontinuity within the published ak135 model
+at 2740 km depth. This causes no issues within TauP as there is no change
+in velocity at that depth.</p>
+<p>``
+2740.000     13.6494      7.2490      5.4817
+2740.000     13.6494      7.2490      5.4817
+``</p>
+<p>Between 4700 and 4800 km depth there appears to be a missing line in the
+published model as before and after the depth increment is approximately
+50 km, but is 100 at this depth.
+This may have a small effect on outer core phases. The
+missing line does appear in the ak135f models, which are supposed to share
+the velocity structure, but to be consistent with the published paper we
+have not changed the file. We do recomment using ak135fcont instead,
+which is ak135 with Q and the “continental structure” above 120 km.</p>
+<p>``
+4650.590     10.0439      0.0000     11.8437
+4700.920     10.0768      0.0000     11.8772
+4801.580     10.1415      0.0000     11.9414
+4851.910     10.1739      0.0000     11.9722
+``</p>
+<p>The source web page for ak135f lists attentuation parameters as Qkappa and Qmu,
+but the reference paper, <span id="id8">Montagner and Kennett [<a class="reference internal" href="bibliography.html#id5" title="J.P. Montagner and B.L.N. Kennett. How to reconcile body-wave and normal-mode reference earth models? Geophysical Journal International, 125:229-248, 1995.">MK95</a>]</span> says:</p>
+<dl class="field-list simple">
+<dt class="field-odd">quote<span class="colon">:</span></dt>
+<dd class="field-odd"><p>We did not attempt to invert for Q K ,which is
+known to be poorly resolved. To a first approximation, Q K-1
+is very close to zero except in the core.</p>
+</dd>
+</dl>
+<p>and so it seems reasonable that this column is actually Qp (or equivalently
+Q_alpha) and is derived from the Qs =Q_mu paramter via equation 2.6 where</p>
+<blockquote>
+<div><p>1/Q_alpha = (4/3)(beta/alpha)^2 (1/Q_beta)</p>
+</div></blockquote>
+<p>Checking the given values shows that the Q_kappa column to actually be Q_p within
++-0.03 for all values except fluid layers, where Qp is set to a generic large
+value of 57822.0, which is the same default value used in PREM. For comparison,
+the PREM model here:
+<a class="reference external" href="https://ds.iris.edu/ds/products/emc-prem/">https://ds.iris.edu/ds/products/emc-prem/</a>
+does in fact contain Q_kappa as the last column in PREM_1s.csv and the value is
+constant at 57823 except in the inner core, where it is 1327.7. We therefore
+are using this column as Q_alpha and not Q_kappa.</p>
+</li>
+<li><p>ak135fcont</p>
+<p>There is a small discrepancy in how to create a “continental structure”
+variant of ak135f at 120 km depth. In the online version
+at <a class="reference external" href="https://rses.anu.edu.au/seismology/ak135/ak135f.html">https://rses.anu.edu.au/seismology/ak135/ak135f.html</a>
+there is a small discontinuity in P velocity if the continental model
+is pasted on top of the base model that does not exist for the average
+model, where vp=8.0500 in the continent vs 8.0505 in the base,
+which would make the 120 km depth a very odd
+discontinuity as density and S velocity are continuous.
+We have constructed
+the “continental structure” model, ak135fcont, so that Vp is continuous
+at this depth with Vp=8.0505.</p>
+<p>There is a difference between the text version of the model,
+<a class="reference external" href="https://rses.anu.edu.au/seismology/ak135/ak135f.txt">https://rses.anu.edu.au/seismology/ak135/ak135f.txt</a>
+and the html version here
+<a class="reference external" href="https://rses.anu.edu.au/seismology/ak135/ak135f.html">https://rses.anu.edu.au/seismology/ak135/ak135f.html</a>
+with the text version showing a depth sample in the average structure at 120 km
+that matches the 120 km sample in the base model. As both lines are the same,
+this doesn’t change the model, but seems to indicate that the 120 km depth
+sample in the continental model should not be viewed as creating a discontinuity.</p>
+<p>At 210 km depth, there is a non-discontinuity in velocity, but a discontinuity
+in the Q model.</p>
+<p>``
+210.00    3.3243    8.3007    4.5184    200.97     79.40     0.000
+210.00    3.3243    8.3007    4.5184    338.47    133.72     0.000
+``</p>
+<p>The “continental structure” model does not list density, Qp or Qs for the
+upper 120 km. Because these values are useful for amplitude calculations,
+we have inserted the density from ak135 for these depth samples and used values
+roughly compatible with the ak135f average model for Qp and Qs.</p>
+</li>
+<li><p>Syngine/Instaseis</p>
+<p>The very useful syngine web service hosted by IRIS,
+<a class="reference external" href="https://service.iris.edu/irisws/syngine/1/">https://service.iris.edu/irisws/syngine/1/</a>
+allows calculation of synthetic seismograms for several 1D earth models. The
+ak135f model used by Syngine appears to be a variant of the ak135favg model
+where the 3 km ocean and 0.3 km sediment layers have been replaced by
+velocities from the lower crustal layer, resulting in a 10 km thick
+crust with constant velocity. Note this is different from the ak135fcont
+model that includes a thicker, 35 km thick two layer crust and a slightly different
+uppermost mantle structure, from 35 to 120 km. Travel times from TauP
+for ak135f will thus be similar, but not exactly match the output of syngine.
+We have included a ak135fsyngine model with these modifications for
+compatibility.</p>
+</li>
+<li><p>PREM</p>
+<p>The Qp values in prem.nd are all also derived from Qs via the equation above
+for ak135f, except for the inner core, where values near 600 are given but
+the equation from Qs predicts a Qp value closer to 430-445. Note that PREM
+gives a different Qkappa in the inner core from the rest of the model,
+which likely explains the difference.</p>
+</li>
+</ul>
+</section>
 </section>
 
 

diff --git a/docs/manual/overview.html b/docs/manual/overview.html
@@ -102,7 +102,7 @@ <h3 id="searchlabel">Quick search</h3>
   <section id="overview">
 <h1>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h1>
 <p>This documentation is for version 3.0.0-SNAPSHOT8 of The TauP Toolkit
-created Nov 06, 2024.</p>
+created Dec 05, 2024.</p>
 <p>The algorithms employed within the TauP package are based on the
 method of <span id="id1">Buland and Chapman [<a class="reference internal" href="bibliography.html#id2" title="Ray Buland and C. H. Chapman. The computation of seismic travel times. Bull. Seism. Soc. Am., 73(5):1271-1302, 1983.">BC83</a>]</span>.
 The IASPEI <em>ttimes</em> package is a widely-used implementation of

diff --git a/docs/manual/searchindex.js b/docs/manual/searchindex.js
diff --git a/docs/manual/taup_curve.html b/docs/manual/taup_curve.html
@@ -3345,7 +3345,7 @@ <h3 id="searchlabel">Quick search</h3>
                              incidentangle, turndepth, amp, amppsv, ampsh,
                              geospread, refltran, refltranpsv, refltransh,
                              index, tstar, attenuation, theta, energygeospread,
-                             pathlength, radiationpsv, radiationsh
+                             pathlength, radiation, radiationpsv, radiationsh
       --xabs               X axis is absolute value
       --xlog               X axis is log
       --xminmax=x x        min and max x axis for plotting
@@ -3356,7 +3356,7 @@ <h3 id="searchlabel">Quick search</h3>
                              incidentangle, turndepth, amp, amppsv, ampsh,
                              geospread, refltran, refltranpsv, refltransh,
                              index, tstar, attenuation, theta, energygeospread,
-                             pathlength, radiationpsv, radiationsh
+                             pathlength, radiation, radiationpsv, radiationsh
       --yabs               Y axis is absolute value
       --ylog               Y axis is log
       --yminmax=y y        min and max y axis for plotting

diff --git a/docs/manual/taup_find.html b/docs/manual/taup_find.html
@@ -181,15 +181,15 @@ <h3 id="searchlabel">Quick search</h3>
 <p>The usage is:</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Usage: taup find [--amp] [--debug] [--help] [--onlynameddiscon] [--pwaveonly]
                  [--showrayparam] [--verbose]
-                 [--attenuationfreq=&lt;attenuationFreq&gt;] [--deltatime=dt]
-                 --max=&lt;maxActions&gt; [--mw=&lt;mw&gt;]
+                 [--attenuationfreq=&lt;attenuationFreq&gt;] [--az=&lt;azimuth&gt;]
+                 [--deltatime=dt] --max=&lt;maxActions&gt; [--mw=&lt;mw&gt;]
                  [--numattenuationfreq=&lt;numFrequencies&gt;] [-o=&lt;outFile&gt;]
                  [--prop=&lt;toolPropsFilename&gt;] [--deg=d[,d...]]...
                  [--strikediprake=s[,s...]]... [--rayparamdeg=s/deg [s/deg]]...
                  [--rayparamkm=s/km [s/km]]... [--time=t [t]]...
-                 [--exclude=depth...]... [[--mod=&lt;modelName&gt;] [-h=depth[,
-                 depth...]]... [--stadepth=depth[,depth...]]... [--scat=s
-                 s]...] [[-p=phase[,phase...]]...
+                 [--exclude=depth[,depth...]...]... [[--mod=&lt;modelName&gt;]
+                 [-h=depth[,depth...]]... [--stadepth=depth[,depth...]]...
+                 [--scat=s s]...] [[-p=phase[,phase...]]...
                  [--phasefile=&lt;phaseFiles&gt;]...] [--json | --text]
 Find seismic phases in an earth model.
 
@@ -198,12 +198,14 @@ <h3 id="searchlabel">Quick search</h3>
       --amp                show amplitude factor for each phase, only if --deg
       --attenuationfreq=&lt;attenuationFreq&gt;
                            attenuation frequency for amplitude calculations
+      --az=&lt;azimuth&gt;       azimuth in degrees, for amp calculations
       --debug              enable debugging output
       --deg, --degree=d[,d...]
                            distance in degrees
       --deltatime=dt       find arrivals within the +- deltatime, --times must
                              have single time
-      --exclude=depth...   Exclude boundaries from phase conversion or
+      --exclude=depth[,depth...]...
+                           Exclude boundaries from phase conversion or
                              reflection interactions
                            May be depth (within tol) or named boundary like
                              moho, cmb, iocb

diff --git a/docs/manual/taup_refltrans.html b/docs/manual/taup_refltrans.html
@@ -965,7 +965,7 @@ <h3 id="searchlabel">Quick search</h3>
 87.0000 0.100536
 88.0000 0.0669995
 89.0000 0.0335123
-89.9999 3.05948e-06
+89.9999 3.05965e-06
   "  /> <!-- -->
   </g>
     </g> <!-- end  -->
@@ -1064,7 +1064,7 @@ <h3 id="searchlabel">Quick search</h3>
 87.0000 0.0312300
 88.0000 0.0208806
 89.0000 0.0104647
-89.9999 -8.17887e-07
+89.9999 -8.17935e-07
   "  /> <!-- -->
   </g>
     </g> <!-- end  -->
@@ -1163,7 +1163,7 @@ <h3 id="searchlabel">Quick search</h3>
 87.0000 0.0280124
 88.0000 0.0187323
 89.0000 0.00938897
-89.9999 -6.85387e-07
+89.9999 -6.85426e-07
   "  /> <!-- -->
   </g>
     </g> <!-- end  -->
@@ -1835,7 +1835,7 @@ <h3 id="searchlabel">Quick search</h3>
       <command>taup refltransplot &#45;&#45;mod ak135 &#45;&#45;depth 35 &#45;&#45;legend &#45;&#45;energyflux &#45;&#45;svg -o stdout </command>
       <version>3.0.0-SNAPSHOT8</version>
       <a href="https://github.com/crotwell/TauP">https://github.com/crotwell/TauP</a>
-    <minmax xmin="0.0" xmax="89.9999088048935" ymin="0.0" ymax="1.00001667986517" />
+    <minmax xmin="0.0" xmax="89.9999088048935" ymin="0.0" ymax="1.0000166798651702" />
     </taup>
   </metadata>
   <defs>
@@ -2547,7 +2547,7 @@ <h3 id="searchlabel">Quick search</h3>
 87.0000 0.982577
 88.0000 0.988324
 89.0000 0.994137
-89.9999 1.00001
+89.9999 1.00002
   "  /> <!-- -->
   </g>
     </g> <!-- end  -->
@@ -2745,7 +2745,7 @@ <h3 id="searchlabel">Quick search</h3>
 87.0000 0.00890003
 88.0000 0.00596399
 89.0000 0.00299474
-89.9999 2.00573e-07
+89.9999 2.00585e-07
   "  /> <!-- -->
   </g>
     </g> <!-- end  -->
@@ -2844,7 +2844,7 @@ <h3 id="searchlabel">Quick search</h3>
 87.0000 0.00852303
 88.0000 0.00571165
 89.0000 0.00286812
-89.9999 1.67567e-07
+89.9999 1.67576e-07
   "  /> <!-- -->
   </g>
     </g> <!-- end  -->

diff --git a/docs/manual/taup_velplot.html b/docs/manual/taup_velplot.html
@@ -401,7 +401,6 @@ <h3 id="searchlabel">Quick search</h3>
 6.50000 35.0000
 8.04000 35.0000
 8.04500 77.5000
-8.05000 120.000
 8.05050 120.000
 8.17500 165.000
 8.30070 210.000
@@ -1126,7 +1125,6 @@ <h3 id="searchlabel">Quick search</h3>
 0.229788 35.0000
 0.274850 35.0000
 0.273797 77.5000
-0.272740 120.000
 0.272781 120.000
 0.281384 165.000
 0.289464 210.000

diff --git a/docs/manual/taup_wavefront.html b/docs/manual/taup_wavefront.html
@@ -26433,7 +26433,7 @@ <h3 id="searchlabel">Quick search</h3>
       <desc>Time  270.00</desc>
     <g>
       <desc>seg 27/29 s of s at   270.00</desc>
-      <circle class="wavefront phase_s swave time_270_00" cx="1263.0570878834023" cy="-6189.624227895289" r="11.4"/>
+      <circle class="wavefront phase_s swave time_270_00" cx="1263.0570878834023" cy="-6189.62422789529" r="11.4"/>
     </g>
     <g>
       <desc>seg 27/139 S of S at   270.00</desc>

diff --git a/src/doc/sphinx/source/cmdLineHelp/VERSION.json b/src/doc/sphinx/source/cmdLineHelp/VERSION.json
@@ -2,14 +2,14 @@
   "version": "3.0.0-SNAPSHOT8",
   "name": "TauP",
   "group": "edu.sc.seis",
-  "date": "2024-11-19T00:20:19Z",
+  "date": "2024-12-05T20:04:17Z",
   "git": {
-    "revision": "1648",
-    "shortsha": "d5a725ef",
-    "sha": "d5a725ef4dbbe26dde4161468e158b4276f9c458",
-    "date": "2024-11-18T19:15:57-05:00",
+    "revision": "1682",
+    "shortsha": "9338fddb",
+    "sha": "9338fddb9a7c3a80d57755329548f27bbd015b4f",
+    "date": "2024-12-05T13:06:05-05:00",
     "lastTag": "v3.0.0-snapshot7",
     "lastTagDate": "2024-11-05T09:31:17-05:00",
-    "commitsSinceLastTag": 53
+    "commitsSinceLastTag": 87
   }
 }
diff --git a/src/doc/sphinx/source/cmdLineHelp/taup_curve.usage b/src/doc/sphinx/source/cmdLineHelp/taup_curve.usage
@@ -49,7 +49,7 @@ Options:
                              incidentangle, turndepth, amp, amppsv, ampsh,
                              geospread, refltran, refltranpsv, refltransh,
                              index, tstar, attenuation, theta, energygeospread,
-                             pathlength, radiationpsv, radiationsh
+                             pathlength, radiation, radiationpsv, radiationsh
       --xabs               X axis is absolute value
       --xlog               X axis is log
       --xminmax=x x        min and max x axis for plotting
@@ -60,7 +60,7 @@ Options:
                              incidentangle, turndepth, amp, amppsv, ampsh,
                              geospread, refltran, refltranpsv, refltransh,
                              index, tstar, attenuation, theta, energygeospread,
-                             pathlength, radiationpsv, radiationsh
+                             pathlength, radiation, radiationpsv, radiationsh
       --yabs               Y axis is absolute value
       --ylog               Y axis is log
       --yminmax=y y        min and max y axis for plotting

diff --git a/src/doc/sphinx/source/cmdLineHelp/taup_find.usage b/src/doc/sphinx/source/cmdLineHelp/taup_find.usage
@@ -1,14 +1,14 @@
 Usage: taup find [--amp] [--debug] [--help] [--onlynameddiscon] [--pwaveonly]
                  [--showrayparam] [--verbose]
-                 [--attenuationfreq=<attenuationFreq>] [--deltatime=dt]
-                 --max=<maxActions> [--mw=<mw>]
+                 [--attenuationfreq=<attenuationFreq>] [--az=<azimuth>]
+                 [--deltatime=dt] --max=<maxActions> [--mw=<mw>]
                  [--numattenuationfreq=<numFrequencies>] [-o=<outFile>]
                  [--prop=<toolPropsFilename>] [--deg=d[,d...]]...
                  [--strikediprake=s[,s...]]... [--rayparamdeg=s/deg [s/deg]]...
                  [--rayparamkm=s/km [s/km]]... [--time=t [t]]...
-                 [--exclude=depth...]... [[--mod=<modelName>] [-h=depth[,
-                 depth...]]... [--stadepth=depth[,depth...]]... [--scat=s
-                 s]...] [[-p=phase[,phase...]]...
+                 [--exclude=depth[,depth...]...]... [[--mod=<modelName>]
+                 [-h=depth[,depth...]]... [--stadepth=depth[,depth...]]...
+                 [--scat=s s]...] [[-p=phase[,phase...]]...
                  [--phasefile=<phaseFiles>]...] [--json | --text]
 Find seismic phases in an earth model.
 
@@ -17,12 +17,14 @@ Options:
       --amp                show amplitude factor for each phase, only if --deg
       --attenuationfreq=<attenuationFreq>
                            attenuation frequency for amplitude calculations
+      --az=<azimuth>       azimuth in degrees, for amp calculations
       --debug              enable debugging output
       --deg, --degree=d[,d...]
                            distance in degrees
       --deltatime=dt       find arrivals within the +- deltatime, --times must
                              have single time
-      --exclude=depth...   Exclude boundaries from phase conversion or
+      --exclude=depth[,depth...]...
+                           Exclude boundaries from phase conversion or
                              reflection interactions
                            May be depth (within tol) or named boundary like
                              moho, cmb, iocb

diff --git a/src/doc/sphinx/source/examples/my_earthquake.ms3 b/src/doc/sphinx/source/examples/my_earthquake.ms3