Updated documentation

thomas-schouten · Nov 21, 2024 · 6e11b05 · 6e11b05
1 parent 3592493
commit 6e11b05
Show file tree

Hide file tree

Showing 42 changed files with 1,436 additions and 748 deletions.
diff --git a/docs/build/doctrees/api/globe/index.doctree b/docs/build/doctrees/api/globe/index.doctree
diff --git a/docs/build/doctrees/api/grids/index.doctree b/docs/build/doctrees/api/grids/index.doctree
diff --git a/docs/build/doctrees/api/optimise/index.doctree b/docs/build/doctrees/api/optimise/index.doctree
diff --git a/docs/build/doctrees/api/plate_torques/index.doctree b/docs/build/doctrees/api/plate_torques/index.doctree
diff --git a/docs/build/doctrees/api/plates/index.doctree b/docs/build/doctrees/api/plates/index.doctree
diff --git a/docs/build/doctrees/api/points/index.doctree b/docs/build/doctrees/api/points/index.doctree
diff --git a/docs/build/doctrees/api/slabs/index.doctree b/docs/build/doctrees/api/slabs/index.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -293,7 +293,7 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/_modules/plato/globe.html b/docs/build/html/_modules/plato/globe.html
diff --git a/docs/build/html/_modules/plato/grids.html b/docs/build/html/_modules/plato/grids.html
diff --git a/docs/build/html/_modules/plato/optimisation.html b/docs/build/html/_modules/plato/optimisation.html
diff --git a/docs/build/html/_modules/plato/plate_torques.html b/docs/build/html/_modules/plato/plate_torques.html
diff --git a/docs/build/html/_modules/plato/plates.html b/docs/build/html/_modules/plato/plates.html
diff --git a/docs/build/html/_modules/plato/plot.html b/docs/build/html/_modules/plato/plot.html
@@ -1485,14 +1485,12 @@ <h1>Source code for plato.plot</h1><div class="highlight"><pre>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># Normalise vectors, if necessary</span>
         <span class="k">if</span> <span class="n">normalise_vectors</span> <span class="ow">and</span> <span class="n">vector_mag</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
-            <span class="c1"># Normalise by dividing by the magnitude of the vectors</span>
-            <span class="c1"># Multiply by 10 to make the vectors more visible</span>
-            <span class="n">vector_lon</span> <span class="o">=</span> <span class="n">vector_lon</span> <span class="o">/</span> <span class="n">vector_mag</span> <span class="o">*</span> <span class="mi">10</span>
-            <span class="n">vector_lat</span> <span class="o">=</span> <span class="n">vector_lat</span> <span class="o">/</span> <span class="n">vector_mag</span> <span class="o">*</span> <span class="mi">10</span>
-
-            <span class="nb">print</span><span class="p">(</span><span class="n">_numpy</span><span class="o">.</span><span class="n">nanmean</span><span class="p">(</span><span class="n">_numpy</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">vector_lon</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="n">vector_lat</span><span class="o">**</span><span class="mi">2</span><span class="p">)))</span>
-
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Normalised vectors!&quot;</span><span class="p">)</span>
+            <span class="k">with</span> <span class="n">warnings</span><span class="o">.</span><span class="n">catch_warnings</span><span class="p">():</span>
+                <span class="n">warnings</span><span class="o">.</span><span class="n">simplefilter</span><span class="p">(</span><span class="s2">&quot;ignore&quot;</span><span class="p">)</span>
+                <span class="c1"># Normalise by dividing by the magnitude of the vectors</span>
+                <span class="c1"># Multiply by 10 to make the vectors more visible</span>
+                <span class="n">vector_lon</span> <span class="o">=</span> <span class="n">vector_lon</span> <span class="o">/</span> <span class="n">vector_mag</span> <span class="o">*</span> <span class="mi">10</span>
+                <span class="n">vector_lat</span> <span class="o">=</span> <span class="n">vector_lat</span> <span class="o">/</span> <span class="n">vector_mag</span> <span class="o">*</span> <span class="mi">10</span>
 
         <span class="c1"># Plot vectors</span>
         <span class="c1"># Ignore annoying warnings</span>
@@ -1611,7 +1609,7 @@ <h1>Source code for plato.plot</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/_modules/plato/points.html b/docs/build/html/_modules/plato/points.html
diff --git a/docs/build/html/_modules/plato/slabs.html b/docs/build/html/_modules/plato/slabs.html
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'v0.0.1-41-gdd09714-dirty',
+    VERSION: 'v0.0.1-45-g3592493-dirty',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/build/html/api/generated/plato.globe.html b/docs/build/html/api/generated/plato.globe.html
@@ -304,7 +304,7 @@
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/api/generated/plato.grids.html b/docs/build/html/api/generated/plato.grids.html
@@ -304,7 +304,7 @@
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/api/generated/plato.plates.html b/docs/build/html/api/generated/plato.plates.html
@@ -304,7 +304,7 @@
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/api/generated/plato.plot.html b/docs/build/html/api/generated/plato.plot.html
@@ -304,7 +304,7 @@
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/api/generated/plato.points.html b/docs/build/html/api/generated/plato.points.html
@@ -304,7 +304,7 @@
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>

diff --git a/docs/build/html/api/generated/plato.slabs.html b/docs/build/html/api/generated/plato.slabs.html
@@ -304,7 +304,7 @@
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=ad0b566d"></script>
+</div><script src="../../_static/documentation_options.js?v=27c35e89"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=5fa4622c"></script>