update online documentation

Author: tgastine

.buildinfo

@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Overview: module code &#8212; Magic 6.3 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../_static/magic.css?v=a97dc138" />
 
     <script src="../_static/documentation_options.js?v=4b074805"></script>
@@ -106,11 +106,13 @@ <h1>All modules for which code is available</h1>
 <li><a href="magic/compSims.html">magic.compSims</a></li>
 <li><a href="magic/cyl.html">magic.cyl</a></li>
 <li><a href="magic/graph.html">magic.graph</a></li>
+<li><a href="magic/graph2vtk.html">magic.graph2vtk</a></li>
 <li><a href="magic/libmagic.html">magic.libmagic</a></li>
 <li><a href="magic/log.html">magic.log</a></li>
 <li><a href="magic/movie.html">magic.movie</a></li>
 <li><a href="magic/plotlib.html">magic.plotlib</a></li>
 <li><a href="magic/potExtra.html">magic.potExtra</a></li>
+<li><a href="magic/potential.html">magic.potential</a></li>
 <li><a href="magic/radial.html">magic.radial</a></li>
 <li><a href="magic/radialSpectra.html">magic.radialSpectra</a></li>
 <li><a href="magic/series.html">magic.series</a></li>
@@ -157,8 +159,8 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright 2023, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
+    &#169; Copyright 2025, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
     </div>
   </body>
 </html>

_modules/index.html

@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>magic.bLayers &#8212; Magic 6.3 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../_static/magic.css?v=a97dc138" />
 
     <script src="../../_static/documentation_options.js?v=4b074805"></script>
@@ -98,21 +98,21 @@ <h3>Navigation</h3>
 
   <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
-<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
-<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
-<span class="kn">import</span> <span class="nn">os</span>
-<span class="kn">from</span> <span class="nn">magic</span> <span class="kn">import</span> <span class="n">MagicRadial</span><span class="p">,</span> <span class="n">matder</span><span class="p">,</span> <span class="n">intcheb</span><span class="p">,</span> <span class="n">MagicSetup</span><span class="p">,</span> <span class="n">scanDir</span><span class="p">,</span> <span class="n">AvgField</span>
-<span class="kn">from</span> <span class="nn">magic.setup</span> <span class="kn">import</span> <span class="n">labTex</span>
-<span class="kn">from</span> <span class="nn">scipy.signal</span> <span class="kn">import</span> <span class="n">argrelextrema</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">matplotlib.pyplot</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">plt</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">magic</span><span class="w"> </span><span class="kn">import</span> <span class="n">MagicRadial</span><span class="p">,</span> <span class="n">matder</span><span class="p">,</span> <span class="n">intcheb</span><span class="p">,</span> <span class="n">MagicSetup</span><span class="p">,</span> <span class="n">scanDir</span><span class="p">,</span> <span class="n">AvgField</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">magic.setup</span><span class="w"> </span><span class="kn">import</span> <span class="n">labTex</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">scipy.signal</span><span class="w"> </span><span class="kn">import</span> <span class="n">argrelextrema</span>
 <span class="k">try</span><span class="p">:</span>
-    <span class="kn">from</span> <span class="nn">scipy.integrate</span> <span class="kn">import</span> <span class="n">simps</span>
+    <span class="kn">from</span><span class="w"> </span><span class="nn">scipy.integrate</span><span class="w"> </span><span class="kn">import</span> <span class="n">simps</span>
 <span class="k">except</span><span class="p">:</span>
-    <span class="kn">from</span> <span class="nn">scipy.integrate</span> <span class="kn">import</span> <span class="n">simpson</span> <span class="k">as</span> <span class="n">simps</span>
-<span class="kn">from</span> <span class="nn">scipy.interpolate</span> <span class="kn">import</span> <span class="n">splrep</span><span class="p">,</span> <span class="n">splev</span>
+    <span class="kn">from</span><span class="w"> </span><span class="nn">scipy.integrate</span><span class="w"> </span><span class="kn">import</span> <span class="n">simpson</span> <span class="k">as</span> <span class="n">simps</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">scipy.interpolate</span><span class="w"> </span><span class="kn">import</span> <span class="n">splrep</span><span class="p">,</span> <span class="n">splev</span>
 
 <div class="viewcode-block" id="getAccuratePeaks">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.getAccuratePeaks">[docs]</a>
-<span class="k">def</span> <span class="nf">getAccuratePeaks</span><span class="p">(</span><span class="n">rad</span><span class="p">,</span> <span class="n">uh</span><span class="p">,</span> <span class="n">uhTop</span><span class="p">,</span> <span class="n">uhBot</span><span class="p">,</span> <span class="n">ri</span><span class="p">,</span> <span class="n">ro</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">getAccuratePeaks</span><span class="p">(</span><span class="n">rad</span><span class="p">,</span> <span class="n">uh</span><span class="p">,</span> <span class="n">uhTop</span><span class="p">,</span> <span class="n">uhBot</span><span class="p">,</span> <span class="n">ri</span><span class="p">,</span> <span class="n">ro</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    This functions performs a spline extrapolation around the maxima</span>
 <span class="sd">    of the input array uh to define a more accurate location of the</span>
@@ -162,7 +162,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="integBulkBc">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.integBulkBc">[docs]</a>
-<span class="k">def</span> <span class="nf">integBulkBc</span><span class="p">(</span><span class="n">rad</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">ri</span><span class="p">,</span> <span class="n">ro</span><span class="p">,</span> <span class="n">lambdai</span><span class="p">,</span> <span class="n">lambdao</span><span class="p">,</span> <span class="n">normed</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">integBulkBc</span><span class="p">(</span><span class="n">rad</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">ri</span><span class="p">,</span> <span class="n">ro</span><span class="p">,</span> <span class="n">lambdai</span><span class="p">,</span> <span class="n">lambdao</span><span class="p">,</span> <span class="n">normed</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    This function evaluates the radial integral of the input array field</span>
 <span class="sd">    in the boundary layer and in the bulk separately.</span>
@@ -216,7 +216,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="integBotTop">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.integBotTop">[docs]</a>
-<span class="k">def</span> <span class="nf">integBotTop</span><span class="p">(</span><span class="n">rad</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">ri</span><span class="p">,</span> <span class="n">ro</span><span class="p">,</span> <span class="n">lambdai</span><span class="p">,</span> <span class="n">lambdao</span><span class="p">,</span> <span class="n">normed</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">integBotTop</span><span class="p">(</span><span class="n">rad</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">ri</span><span class="p">,</span> <span class="n">ro</span><span class="p">,</span> <span class="n">lambdai</span><span class="p">,</span> <span class="n">lambdao</span><span class="p">,</span> <span class="n">normed</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    This function evaluates the radial integral of the input array field</span>
 <span class="sd">    in the bottom and top boundary layers separately.</span>
@@ -261,7 +261,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="getMaxima">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.getMaxima">[docs]</a>
-<span class="k">def</span> <span class="nf">getMaxima</span><span class="p">(</span><span class="n">field</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">getMaxima</span><span class="p">(</span><span class="n">field</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    This function determines the local maxima of the input array field</span>
 
@@ -290,7 +290,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="BLayers">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.BLayers">[docs]</a>
-<span class="k">class</span> <span class="nc">BLayers</span><span class="p">(</span><span class="n">MagicSetup</span><span class="p">):</span>
+<span class="k">class</span><span class="w"> </span><span class="nc">BLayers</span><span class="p">(</span><span class="n">MagicSetup</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    This class allows to determine the viscous and thermal boundary layers</span>
 <span class="sd">    using several classical methods (slope method, peak values, dissipation</span>
@@ -326,7 +326,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="BLayers.__init__">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.BLayers.__init__">[docs]</a>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">iplot</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">quiet</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">iplot</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">quiet</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        :param iplot: display the result when set to True (default False)</span>
 <span class="sd">        :type iplot: bool</span>
@@ -682,7 +682,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="BLayers.plot">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.BLayers.plot">[docs]</a>
-    <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Plotting function</span>
 <span class="sd">        &quot;&quot;&quot;</span>
@@ -759,7 +759,7 @@ <h1>Source code for magic.bLayers</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="BLayers.__str__">
 <a class="viewcode-back" href="../../apiPython/misc.html#magic.bLayers.BLayers.__str__">[docs]</a>
-    <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Formatted output</span>
 <span class="sd">        &quot;&quot;&quot;</span>
@@ -856,8 +856,8 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-    &#169; Copyright 2023, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
+    &#169; Copyright 2025, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
     </div>
   </body>
 </html>