Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit a12d0dc

Browse files
authored
Merge pull request #1236 from cbworden/update_docs
Update docs
2 parents e55c7ce + 31256cf commit a12d0dc

File tree

347 files changed

+14410
-3774
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

347 files changed

+14410
-3774
lines changed

doc_source/manual4_0/sg_contributing.rst

+14-6

doc_source/shakelib/shakelib.distance.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rst

-2

doc_source/shakelib/shakelib.rupture.base.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.constants.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.edge_rupture.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.factory.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.origin.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.point_rupture.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.quad_rupture.rst

-7
This file was deleted.

doc_source/shakelib/shakelib.rupture.rst

-23
This file was deleted.

doc_source/shakelib/shakelib.rupture.utils.rst

-7
This file was deleted.

docs/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: daa1315a262695cbd433fedb28627b0d
3+
config: f4d02ea22168e687dd158080fd595211
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
29 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
33 Bytes
Binary file not shown.
-950 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
29 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
-188 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/.doctrees/environment.pickle

518 KB
Binary file not shown.

docs/.doctrees/index.doctree

-1 Bytes
Binary file not shown.
1.22 KB
Binary file not shown.
-2.72 KB
Binary file not shown.
149 Bytes
Binary file not shown.
Binary file not shown.
-326 Bytes
Binary file not shown.
-76 Bytes
Binary file not shown.
-2.25 KB
Binary file not shown.
-23.6 KB
Binary file not shown.
-28.7 KB
Binary file not shown.
-614 Bytes
Binary file not shown.
-4.56 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
-3.3 KB
Binary file not shown.
-681 Bytes
Binary file not shown.
Binary file not shown.
-9.33 KB
Binary file not shown.
-7.12 KB
Binary file not shown.
-1.22 KB
Binary file not shown.
-1.07 KB
Binary file not shown.
-28.1 KB
Binary file not shown.
-1.68 KB
Binary file not shown.
-657 Bytes
Binary file not shown.
-18 Bytes
Binary file not shown.
-20.4 KB
Binary file not shown.
12.2 KB
Binary file not shown.
Binary file not shown.
-6.87 KB
Binary file not shown.
-2.11 KB
Binary file not shown.
-85 Bytes
Binary file not shown.
-5 KB
Binary file not shown.
Binary file not shown.
-251 Bytes
Binary file not shown.
-1.84 KB
Binary file not shown.
-30.7 KB
Binary file not shown.
-613 Bytes
Binary file not shown.
-192 Bytes
Binary file not shown.
-569 Bytes
Binary file not shown.
-7.45 KB
Binary file not shown.
-1.26 KB
Binary file not shown.
-26.9 KB
Binary file not shown.
-8.16 KB
Binary file not shown.
Binary file not shown.
-8.4 KB
Binary file not shown.
-15.5 KB
Binary file not shown.
-2.85 KB
Binary file not shown.
Binary file not shown.
-45 Bytes
Binary file not shown.
-9.24 KB
Binary file not shown.
-27.2 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
2.64 MB
Binary file not shown.
42 Bytes
Binary file not shown.

docs/.doctrees/programs/shake.doctree

2.65 MB
Binary file not shown.
2.66 MB
Binary file not shown.
2.66 MB
Binary file not shown.
2.67 MB
Binary file not shown.
2.67 MB
Binary file not shown.
2.68 MB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
-38 Bytes
Binary file not shown.
Binary file not shown.
29 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
29 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
-447 Bytes
Binary file not shown.
Binary file not shown.
29 Bytes
Binary file not shown.
Binary file not shown.
-2.82 KB
Binary file not shown.
-2.15 KB
Binary file not shown.
Binary file not shown.
29 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/_modules/index.html

+6-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -12,6 +12,7 @@
1212
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
1313
<script src="../_static/jquery.js"></script>
1414
<script src="../_static/underscore.js"></script>
15+
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
1516
<script src="../_static/doctools.js"></script>
1617
<link rel="shortcut icon" href="../_static/northridge_points.ico"/>
1718
<link rel="index" title="Index" href="../genindex.html" />
@@ -43,7 +44,6 @@ <h1>All modules for which code is available</h1>
4344
<li><a href="shakelib/correlation/loth_baker_2013.html">shakelib.correlation.loth_baker_2013</a></li>
4445
<li><a href="shakelib/directivity/bayless2013.html">shakelib.directivity.bayless2013</a></li>
4546
<li><a href="shakelib/directivity/rowshandel2013.html">shakelib.directivity.rowshandel2013</a></li>
46-
<li><a href="shakelib/distance.html">shakelib.distance</a></li>
4747
<li><a href="shakelib/gmice/ak07.html">shakelib.gmice.ak07</a></li>
4848
<li><a href="shakelib/gmice/fm11.html">shakelib.gmice.fm11</a></li>
4949
<li><a href="shakelib/gmice/gmice.html">shakelib.gmice.gmice</a></li>
@@ -54,13 +54,6 @@ <h1>All modules for which code is available</h1>
5454
<li><a href="shakelib/multigmpe.html">shakelib.multigmpe</a></li>
5555
<li><a href="shakelib/plotting/contour.html">shakelib.plotting.contour</a></li>
5656
<li><a href="shakelib/plotting/plotrupture.html">shakelib.plotting.plotrupture</a></li>
57-
<li><a href="shakelib/rupture/base.html">shakelib.rupture.base</a></li>
58-
<li><a href="shakelib/rupture/edge_rupture.html">shakelib.rupture.edge_rupture</a></li>
59-
<li><a href="shakelib/rupture/factory.html">shakelib.rupture.factory</a></li>
60-
<li><a href="shakelib/rupture/origin.html">shakelib.rupture.origin</a></li>
61-
<li><a href="shakelib/rupture/point_rupture.html">shakelib.rupture.point_rupture</a></li>
62-
<li><a href="shakelib/rupture/quad_rupture.html">shakelib.rupture.quad_rupture</a></li>
63-
<li><a href="shakelib/rupture/utils.html">shakelib.rupture.utils</a></li>
6457
<li><a href="shakelib/sites.html">shakelib.sites</a></li>
6558
<li><a href="shakelib/station.html">shakelib.station</a></li>
6659
<li><a href="shakelib/utils/containers.html">shakelib.utils.containers</a></li>
@@ -137,9 +130,9 @@ <h1 class="logo logo-name">ShakeMap Documentation</h1>
137130

138131
<h3>Navigation</h3>
139132
<ul>
140-
<li class="toctree-l1"><a class="reference internal" href="../manual4_0/index.html">ShakeMap 4.0 Manual</a></li>
141-
<li class="toctree-l1"><a class="reference internal" href="../programs/programs.html">ShakeMap 4.0 Command Line Interface</a></li>
142-
<li class="toctree-l1"><a class="reference internal" href="../apidoc/shakemap.html">ShakeMap 4.0 API</a></li>
133+
<li class="toctree-l1"><a class="reference internal" href="../manual4_0/index.html">ShakeMap 4.1 Manual</a></li>
134+
<li class="toctree-l1"><a class="reference internal" href="../programs/programs.html">ShakeMap 4.1 Command Line Interface</a></li>
135+
<li class="toctree-l1"><a class="reference internal" href="../apidoc/shakemap.html">ShakeMap 4.1 API</a></li>
143136
<li class="toctree-l1"><a class="reference internal" href="../manual3_5/index.html">ShakeMap 3.5 Manual (Deprecated)</a></li>
144137
</ul>
145138

@@ -153,7 +146,7 @@ <h3 id="searchlabel">Quick search</h3>
153146
</form>
154147
</div>
155148
</div>
156-
<script>$('#searchbox').show(0);</script>
149+
<script>document.getElementById('searchbox').style.display = "block"</script>
157150
</div>
158151
</div>
159152
<div class="clearer"></div>

docs/_modules/shakelib/conversions/imc/boore_kishida_2017.html

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -12,7 +12,9 @@
1212
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
1313
<script src="../../../../_static/jquery.js"></script>
1414
<script src="../../../../_static/underscore.js"></script>
15+
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1516
<script src="../../../../_static/doctools.js"></script>
17+
<link rel="shortcut icon" href="../../../../_static/northridge_points.ico"/>
1618
<link rel="index" title="Index" href="../../../../genindex.html" />
1719
<link rel="search" title="Search" href="../../../../search.html" />
1820

@@ -38,7 +40,11 @@ <h1>Source code for shakelib.conversions.imc.boore_kishida_2017</h1><div class="
3840
<span class="kn">import</span> <span class="nn">glob</span>
3941
<span class="kn">import</span> <span class="nn">logging</span>
4042
<span class="kn">import</span> <span class="nn">os.path</span>
41-
<span class="kn">import</span> <span class="nn">importlib.resources</span> <span class="k">as</span> <span class="nn">importlib_resources</span>
43+
44+
<span class="c1"># This is what we want for the future (Python 2.9 an beyond):</span>
45+
<span class="c1"># import importlib.resources as importlib_resources</span>
46+
<span class="c1"># but right now we have to support Py 3.8, so we have this:</span>
47+
<span class="kn">import</span> <span class="nn">pkg_resources</span>
4248

4349
<span class="c1"># Third party imports</span>
4450
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
@@ -307,7 +313,10 @@ <h1>Source code for shakelib.conversions.imc.boore_kishida_2017</h1><div class="
307313
<span class="sd"> string &#39;Null&#39;, then imc_in and imc_out evaluated to be the</span>
308314
<span class="sd"> same.</span>
309315
<span class="sd"> &quot;&quot;&quot;</span>
310-
<span class="n">datadir</span> <span class="o">=</span> <span class="n">importlib_resources</span><span class="o">.</span><span class="n">files</span><span class="p">(</span><span class="s2">&quot;shakelib.conversions.imc&quot;</span><span class="p">)</span> <span class="o">/</span> <span class="s2">&quot;data&quot;</span>
316+
<span class="c1"># This is what we want for the future (Python 2.9 an beyond):</span>
317+
<span class="c1"># datadir = importlib_resources.files(&quot;shakelib.conversions.imc&quot;) / &quot;data&quot;</span>
318+
<span class="c1"># but right now we have to support Py 3.8, so we have this:</span>
319+
<span class="n">datadir</span> <span class="o">=</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">resource_filename</span><span class="p">(</span><span class="s2">&quot;shakelib.conversions.imc&quot;</span><span class="p">,</span> <span class="s2">&quot;data&quot;</span><span class="p">)</span>
311320
<span class="n">conv_files</span> <span class="o">=</span> <span class="n">glob</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">datadir</span><span class="p">,</span> <span class="s2">&quot;*.csv&quot;</span><span class="p">))</span>
312321
<span class="n">stub1</span> <span class="o">=</span> <span class="n">BooreKishida2017</span><span class="o">.</span><span class="n">_imcToFilestr</span><span class="p">(</span><span class="n">imc_in</span><span class="p">)</span>
313322
<span class="n">stub2</span> <span class="o">=</span> <span class="n">BooreKishida2017</span><span class="o">.</span><span class="n">_imcToFilestr</span><span class="p">(</span><span class="n">imc_out</span><span class="p">)</span>
@@ -410,9 +419,9 @@ <h1 class="logo logo-name">ShakeMap Documentation</h1>
410419

411420
<h3>Navigation</h3>
412421
<ul>
413-
<li class="toctree-l1"><a class="reference internal" href="../../../../manual4_0/index.html">ShakeMap 4.0 Manual</a></li>
414-
<li class="toctree-l1"><a class="reference internal" href="../../../../programs/programs.html">ShakeMap 4.0 Command Line Interface</a></li>
415-
<li class="toctree-l1"><a class="reference internal" href="../../../../apidoc/shakemap.html">ShakeMap 4.0 API</a></li>
422+
<li class="toctree-l1"><a class="reference internal" href="../../../../manual4_0/index.html">ShakeMap 4.1 Manual</a></li>
423+
<li class="toctree-l1"><a class="reference internal" href="../../../../programs/programs.html">ShakeMap 4.1 Command Line Interface</a></li>
424+
<li class="toctree-l1"><a class="reference internal" href="../../../../apidoc/shakemap.html">ShakeMap 4.1 API</a></li>
416425
<li class="toctree-l1"><a class="reference internal" href="../../../../manual3_5/index.html">ShakeMap 3.5 Manual (Deprecated)</a></li>
417426
</ul>
418427

@@ -426,7 +435,7 @@ <h3 id="searchlabel">Quick search</h3>
426435
</form>
427436
</div>
428437
</div>
429-
<script>$('#searchbox').show(0);</script>
438+
<script>document.getElementById('searchbox').style.display = "block"</script>
430439
</div>
431440
</div>
432441
<div class="clearer"></div>

docs/_modules/shakelib/conversions/imt/abrahamson_bhasin_2020.html

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -12,7 +12,9 @@
1212
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
1313
<script src="../../../../_static/jquery.js"></script>
1414
<script src="../../../../_static/underscore.js"></script>
15+
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1516
<script src="../../../../_static/doctools.js"></script>
17+
<link rel="shortcut icon" href="../../../../_static/northridge_points.ico"/>
1618
<link rel="index" title="Index" href="../../../../genindex.html" />
1719
<link rel="search" title="Search" href="../../../../search.html" />
1820

@@ -277,9 +279,9 @@ <h1 class="logo logo-name">ShakeMap Documentation</h1>
277279

278280
<h3>Navigation</h3>
279281
<ul>
280-
<li class="toctree-l1"><a class="reference internal" href="../../../../manual4_0/index.html">ShakeMap 4.0 Manual</a></li>
281-
<li class="toctree-l1"><a class="reference internal" href="../../../../programs/programs.html">ShakeMap 4.0 Command Line Interface</a></li>
282-
<li class="toctree-l1"><a class="reference internal" href="../../../../apidoc/shakemap.html">ShakeMap 4.0 API</a></li>
282+
<li class="toctree-l1"><a class="reference internal" href="../../../../manual4_0/index.html">ShakeMap 4.1 Manual</a></li>
283+
<li class="toctree-l1"><a class="reference internal" href="../../../../programs/programs.html">ShakeMap 4.1 Command Line Interface</a></li>
284+
<li class="toctree-l1"><a class="reference internal" href="../../../../apidoc/shakemap.html">ShakeMap 4.1 API</a></li>
283285
<li class="toctree-l1"><a class="reference internal" href="../../../../manual3_5/index.html">ShakeMap 3.5 Manual (Deprecated)</a></li>
284286
</ul>
285287

@@ -293,7 +295,7 @@ <h3 id="searchlabel">Quick search</h3>
293295
</form>
294296
</div>
295297
</div>
296-
<script>$('#searchbox').show(0);</script>
298+
<script>document.getElementById('searchbox').style.display = "block"</script>
297299
</div>
298300
</div>
299301
<div class="clearer"></div>

docs/_modules/shakelib/directivity/bayless2013.html

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -12,7 +12,9 @@
1212
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
1313
<script src="../../../_static/jquery.js"></script>
1414
<script src="../../../_static/underscore.js"></script>
15+
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1516
<script src="../../../_static/doctools.js"></script>
17+
<link rel="shortcut icon" href="../../../_static/northridge_points.ico"/>
1618
<link rel="index" title="Index" href="../../../genindex.html" />
1719
<link rel="search" title="Search" href="../../../search.html" />
1820

@@ -36,8 +38,8 @@ <h1>Source code for shakelib.directivity.bayless2013</h1><div class="highlight">
3638
<span class="kn">import</span> <span class="nn">openquake.hazardlib.geo</span> <span class="k">as</span> <span class="nn">geo</span>
3739
<span class="kn">import</span> <span class="nn">copy</span>
3840

39-
<span class="kn">from</span> <span class="nn">shakelib.distance</span> <span class="kn">import</span> <span class="n">get_distance</span>
40-
<span class="kn">from</span> <span class="nn">shakelib.rupture.utils</span> <span class="kn">import</span> <span class="n">_distance_sq_to_segment</span>
41+
<span class="kn">from</span> <span class="nn">impactutils.rupture.distance</span> <span class="kn">import</span> <span class="n">get_distance</span>
42+
<span class="kn">from</span> <span class="nn">impactutils.rupture.utils</span> <span class="kn">import</span> <span class="n">_distance_sq_to_segment</span>
4143
<span class="kn">import</span> <span class="nn">impactutils.vectorutils.ecef</span> <span class="k">as</span> <span class="nn">ecef</span>
4244
<span class="kn">from</span> <span class="nn">impactutils.vectorutils.vector</span> <span class="kn">import</span> <span class="n">Vector</span>
4345

@@ -520,9 +522,9 @@ <h1 class="logo logo-name">ShakeMap Documentation</h1>
520522

521523
<h3>Navigation</h3>
522524
<ul>
523-
<li class="toctree-l1"><a class="reference internal" href="../../../manual4_0/index.html">ShakeMap 4.0 Manual</a></li>
524-
<li class="toctree-l1"><a class="reference internal" href="../../../programs/programs.html">ShakeMap 4.0 Command Line Interface</a></li>
525-
<li class="toctree-l1"><a class="reference internal" href="../../../apidoc/shakemap.html">ShakeMap 4.0 API</a></li>
525+
<li class="toctree-l1"><a class="reference internal" href="../../../manual4_0/index.html">ShakeMap 4.1 Manual</a></li>
526+
<li class="toctree-l1"><a class="reference internal" href="../../../programs/programs.html">ShakeMap 4.1 Command Line Interface</a></li>
527+
<li class="toctree-l1"><a class="reference internal" href="../../../apidoc/shakemap.html">ShakeMap 4.1 API</a></li>
526528
<li class="toctree-l1"><a class="reference internal" href="../../../manual3_5/index.html">ShakeMap 3.5 Manual (Deprecated)</a></li>
527529
</ul>
528530

@@ -536,7 +538,7 @@ <h3 id="searchlabel">Quick search</h3>
536538
</form>
537539
</div>
538540
</div>
539-
<script>$('#searchbox').show(0);</script>
541+
<script>document.getElementById('searchbox').style.display = "block"</script>
540542
</div>
541543
</div>
542544
<div class="clearer"></div>

0 commit comments

Comments
 (0)