Update documentation

Sbozzolo · Jun 10, 2023 · af24a16 · af24a16
1 parent 6a53428
commit af24a16
Show file tree

Hide file tree

Showing 33 changed files with 698 additions and 692 deletions.
diff --git a/dev/_images/tutorials_timeseries_10_1.png b/dev/_images/tutorials_timeseries_10_1.png
diff --git a/dev/_images/tutorials_timeseries_12_0.png b/dev/_images/tutorials_timeseries_12_0.png
diff --git a/dev/_images/tutorials_timeseries_14_1.png b/dev/_images/tutorials_timeseries_14_1.png
diff --git a/dev/_images/tutorials_timeseries_16_1.png b/dev/_images/tutorials_timeseries_16_1.png
diff --git a/dev/_images/tutorials_timeseries_19_0.png b/dev/_images/tutorials_timeseries_19_0.png
diff --git a/dev/_images/tutorials_timeseries_20_1.png b/dev/_images/tutorials_timeseries_20_1.png
diff --git a/dev/_images/tutorials_timeseries_21_1.png b/dev/_images/tutorials_timeseries_21_1.png
diff --git a/dev/_images/tutorials_timeseries_23_1.png b/dev/_images/tutorials_timeseries_23_1.png
diff --git a/dev/_images/tutorials_timeseries_26_0.png b/dev/_images/tutorials_timeseries_26_0.png
diff --git a/dev/_images/tutorials_timeseries_30_0.png b/dev/_images/tutorials_timeseries_30_0.png
diff --git a/dev/_images/tutorials_timeseries_32_0.png b/dev/_images/tutorials_timeseries_32_0.png
diff --git a/dev/_images/tutorials_timeseries_34_0.png b/dev/_images/tutorials_timeseries_34_0.png
diff --git a/dev/_images/tutorials_timeseries_36_0.png b/dev/_images/tutorials_timeseries_36_0.png
diff --git a/dev/_images/tutorials_timeseries_38_2.png b/dev/_images/tutorials_timeseries_38_2.png
diff --git a/dev/_images/tutorials_timeseries_8_0.png b/dev/_images/tutorials_timeseries_8_0.png
diff --git a/dev/_static/nbsphinx-code-cells.css b/dev/_static/nbsphinx-code-cells.css
@@ -62,12 +62,16 @@ div.nblast.container {
 }
 
 /* input prompt */
-div.nbinput.container div.prompt pre {
+div.nbinput.container div.prompt pre,
+/* for sphinx_immaterial theme: */
+div.nbinput.container div.prompt pre > code {
     color: #307FC1;
 }
 
 /* output prompt */
-div.nboutput.container div.prompt pre {
+div.nboutput.container div.prompt pre,
+/* for sphinx_immaterial theme: */
+div.nboutput.container div.prompt pre > code {
     color: #BF5B3D;
 }
 
@@ -204,8 +208,10 @@ div.nboutput.container div.output_area > div[class^='highlight']{
     overflow-y: hidden;
 }
 
-/* hide copybtn icon on prompts (needed for 'sphinx_copybutton') */
-.prompt .copybtn {
+/* hide copy button on prompts for 'sphinx_copybutton' extension ... */
+.prompt .copybtn,
+/* ... and 'sphinx_immaterial' theme */
+.prompt .md-clipboard.md-icon {
     display: none;
 }
 

diff --git a/dev/citations.html b/dev/citations.html
@@ -65,16 +65,16 @@ <h1>Papers citing this software<a class="headerlink" href="#papers-citing-this-s
 <li id="id10"><p>Tuna Demircik, Christian Ecker, Matti Järvinen, Luciano Rezzolla, Samuel Tootle, and Konrad Topolski. Exploring the Phase Diagram of V-QCD with Neutron Star Merger Simulations. In <em>European Physical Journal Web of Conferences</em>, volume 274 of European Physical Journal Web of Conferences, 07006. August 2022. <a class="reference external" href="https://arxiv.org/abs/2211.10118">arXiv:2211.10118</a>, <a class="reference external" href="https://doi.org/10.1051/epjconf/202227407006">doi:10.1051/epjconf/202227407006</a>.</p></li>
 <li id="id14"><p>Peter Diener, Stephan Rosswog, and Francesco Torsello. Simulating neutron star mergers with the Lagrangian Numerical Relativity code SPHINCS_BSSN. <em>European Physical Journal A</em>, 58(4):74, April 2022. <a class="reference external" href="https://arxiv.org/abs/2203.06478">arXiv:2203.06478</a>, <a class="reference external" href="https://doi.org/10.1140/epja/s10050-022-00725-7">doi:10.1140/epja/s10050-022-00725-7</a>.</p></li>
 <li id="id9"><p>Matthew Elley, Hector O. Silva, Helvi Witek, and Nicolás Yunes. Spin-induced dynamical scalarization, descalarization, and stealthness in scalar-Gauss-Bonnet gravity during a black hole coalescence. <em>Phys. Rev. D</em>, 106(4):044018, August 2022. <a class="reference external" href="https://arxiv.org/abs/2205.06240">arXiv:2205.06240</a>, <a class="reference external" href="https://doi.org/10.1103/PhysRevD.106.044018">doi:10.1103/PhysRevD.106.044018</a>.</p></li>
+<li id="id2"><p>Pedro L. Espino, Gabriele Bozzola, and Vasileios Paschalidis. Quantifying uncertainties in general relativistic magnetohydrodynamic codes. <em>Phys. Rev. D</em>, 107(10):104059, May 2023. <a class="reference external" href="https://arxiv.org/abs/2210.13481">arXiv:2210.13481</a>, <a class="reference external" href="https://doi.org/10.1103/PhysRevD.107.104059">doi:10.1103/PhysRevD.107.104059</a>.</p></li>
 <li id="id17"><p>Pedro L. Espino and Vasileios Paschalidis. Fate of twin stars on the unstable branch: Implications for the formation of twin stars. <em>Phys. Rev. D</em>, 105(4):043014, February 2022. <a class="reference external" href="https://arxiv.org/abs/2105.05269">arXiv:2105.05269</a>, <a class="reference external" href="https://doi.org/10.1103/PhysRevD.105.043014">doi:10.1103/PhysRevD.105.043014</a>.</p></li>
-<li id="id6"><p>Pedro Luis Espino, Gabriele Bozzola, and Vasileios Paschalidis. Quantifying uncertainties in general relativistic magnetohydrodynamic codes. <em>arXiv e-prints</em>, pages arXiv:2210.13481, October 2022. <a class="reference external" href="https://arxiv.org/abs/2210.13481">arXiv:2210.13481</a>, <a class="reference external" href="https://doi.org/10.48550/arXiv.2210.13481">doi:10.48550/arXiv.2210.13481</a>.</p></li>
 <li id="id11"><p>Shamim Haque, Ritam Mallick, and Shashikesh Kumar Thakur. Binary neutron star mergers and the effect of onset of phase transition on gravitational wave signals. <em>arXiv e-prints</em>, pages arXiv:2207.14485, July 2022. <a class="reference external" href="https://arxiv.org/abs/2207.14485">arXiv:2207.14485</a>, <a class="reference external" href="https://doi.org/10.48550/arXiv.2207.14485">doi:10.48550/arXiv.2207.14485</a>.</p></li>
-<li id="id3"><p>Ankit Kumar, Debabrata Dey, Shamim Haque, Ritam Mallick, and S. K. Patra. Quarkyonic Model for Neutron Star Matter: A Relativistic Mean-Field Approach. <em>arXiv e-prints</em>, pages arXiv:2304.08223, April 2023. <a class="reference external" href="https://arxiv.org/abs/2304.08223">arXiv:2304.08223</a>, <a class="reference external" href="https://doi.org/10.48550/arXiv.2304.08223">doi:10.48550/arXiv.2304.08223</a>.</p></li>
+<li id="id4"><p>Ankit Kumar, Debabrata Dey, Shamim Haque, Ritam Mallick, and S. K. Patra. Quarkyonic Model for Neutron Star Matter: A Relativistic Mean-Field Approach. <em>arXiv e-prints</em>, pages arXiv:2304.08223, April 2023. <a class="reference external" href="https://arxiv.org/abs/2304.08223">arXiv:2304.08223</a>, <a class="reference external" href="https://doi.org/10.48550/arXiv.2304.08223">doi:10.48550/arXiv.2304.08223</a>.</p></li>
 <li id="id7"><p>Raimon Luna, Gabriele Bozzola, Vitor Cardoso, Vasileios Paschalidis, and Miguel Zilhão. Kicks in charged black hole binaries. <em>Phys. Rev. D</em>, 106(8):084017, October 2022. <a class="reference external" href="https://arxiv.org/abs/2207.06429">arXiv:2207.06429</a>, <a class="reference external" href="https://doi.org/10.1103/PhysRevD.106.084017">doi:10.1103/PhysRevD.106.084017</a>.</p></li>
-<li id="id4"><p>Elias R. Most and Eliot Quataert. Flares, Jets, and Quasiperiodic Outbursts from Neutron Star Merger Remnants. <em>ApJ</em>, 947(1):L15, April 2023. <a class="reference external" href="https://arxiv.org/abs/2303.08062">arXiv:2303.08062</a>, <a class="reference external" href="https://doi.org/10.3847/2041-8213/acca84">doi:10.3847/2041-8213/acca84</a>.</p></li>
-<li id="id2"><p>Carlo Musolino and Luciano Rezzolla. A practical guide to a moment approach for neutrino transport in numerical relativity. <em>arXiv e-prints</em>, pages arXiv:2304.09168, April 2023. <a class="reference external" href="https://arxiv.org/abs/2304.09168">arXiv:2304.09168</a>, <a class="reference external" href="https://doi.org/10.48550/arXiv.2304.09168">doi:10.48550/arXiv.2304.09168</a>.</p></li>
+<li id="id5"><p>Elias R. Most and Eliot Quataert. Flares, Jets, and Quasiperiodic Outbursts from Neutron Star Merger Remnants. <em>ApJ</em>, 947(1):L15, April 2023. <a class="reference external" href="https://arxiv.org/abs/2303.08062">arXiv:2303.08062</a>, <a class="reference external" href="https://doi.org/10.3847/2041-8213/acca84">doi:10.3847/2041-8213/acca84</a>.</p></li>
+<li id="id3"><p>Carlo Musolino and Luciano Rezzolla. A practical guide to a moment approach for neutrino transport in numerical relativity. <em>arXiv e-prints</em>, pages arXiv:2304.09168, April 2023. <a class="reference external" href="https://arxiv.org/abs/2304.09168">arXiv:2304.09168</a>, <a class="reference external" href="https://doi.org/10.48550/arXiv.2304.09168">doi:10.48550/arXiv.2304.09168</a>.</p></li>
 <li id="id12"><p>L. Jens Papenfort, Elias R. Most, Samuel Tootle, and Luciano Rezzolla. Impact of extreme spins and mass ratios on the post-merger observables of high-mass binary neutron stars. <em>MNRAS</em>, 513(3):3646–3662, July 2022. <a class="reference external" href="https://arxiv.org/abs/2201.03632">arXiv:2201.03632</a>, <a class="reference external" href="https://doi.org/10.1093/mnras/stac964">doi:10.1093/mnras/stac964</a>.</p></li>
 <li id="id13"><p>Stephan Rosswog, Peter Diener, and Francesco Torsello. Thinking Outside the Box: Numerical Relativity with Particles. <em>Symmetry</em>, 14(6):1280, June 2022. <a class="reference external" href="https://arxiv.org/abs/2205.08130">arXiv:2205.08130</a>, <a class="reference external" href="https://doi.org/10.3390/sym14061280">doi:10.3390/sym14061280</a>.</p></li>
-<li id="id5"><p>Samuel Tootle, Christian Ecker, Konrad Topolski, Tuna Demircik, Matti Järvinen, and Luciano Rezzolla. Quark formation and phenomenology in binary neutron-star mergers using V-QCD. <em>SciPost Physics</em>, 13(5):109, November 2022. <a class="reference external" href="https://arxiv.org/abs/2205.05691">arXiv:2205.05691</a>, <a class="reference external" href="https://doi.org/10.21468/SciPostPhys.13.5.109">doi:10.21468/SciPostPhys.13.5.109</a>.</p></li>
+<li id="id6"><p>Samuel Tootle, Christian Ecker, Konrad Topolski, Tuna Demircik, Matti Järvinen, and Luciano Rezzolla. Quark formation and phenomenology in binary neutron-star mergers using V-QCD. <em>SciPost Physics</em>, 13(5):109, November 2022. <a class="reference external" href="https://arxiv.org/abs/2205.05691">arXiv:2205.05691</a>, <a class="reference external" href="https://doi.org/10.21468/SciPostPhys.13.5.109">doi:10.21468/SciPostPhys.13.5.109</a>.</p></li>
 </ol>
 </div>
 </section>

diff --git a/dev/genindex.html b/dev/genindex.html
@@ -719,7 +719,7 @@ <h2 id="H">H</h2>
 </li>
       <li><a href="timeseries_ref.html#kuibit.timeseries.TimeSeries.hamming_windowed">hamming_windowed() (kuibit.timeseries.TimeSeries method)</a>
 </li>
-      <li><a href="gw_utils_ref.html#kuibit.gw_utils.Detectors.hanford">hanford (kuibit.gw_utils.Detectors property)</a>
+      <li><a href="gw_utils_ref.html#kuibit.gw_utils.Detectors.hanford">hanford (kuibit.gw_utils.Detectors attribute)</a>
 </li>
       <li><a href="cactus_multipoles_ref.html#kuibit.cactus_multipoles.MultipoleAllDets.has_detector">has_detector() (kuibit.cactus_multipoles.MultipoleAllDets method)</a>
 
@@ -1041,7 +1041,7 @@ <h2 id="K">K</h2>
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="gw_utils_ref.html#kuibit.gw_utils.Detectors.livingston">livingston (kuibit.gw_utils.Detectors property)</a>
+      <li><a href="gw_utils_ref.html#kuibit.gw_utils.Detectors.livingston">livingston (kuibit.gw_utils.Detectors attribute)</a>
 </li>
       <li><a href="cactus_scalars_ref.html#kuibit.cactus_scalars.OneScalar.load">load() (kuibit.cactus_scalars.OneScalar method)</a>
 </li>
@@ -1928,7 +1928,7 @@ <h2 id="V">V</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="gw_utils_ref.html#kuibit.gw_utils.Detectors.virgo">virgo (kuibit.gw_utils.Detectors property)</a>
+      <li><a href="gw_utils_ref.html#kuibit.gw_utils.Detectors.virgo">virgo (kuibit.gw_utils.Detectors attribute)</a>
 </li>
       <li><a href="cactus_horizons_ref.html#kuibit.cactus_horizons.OneHorizon.vtk_at_it">vtk_at_it() (kuibit.cactus_horizons.OneHorizon method)</a>
 </li>

diff --git a/dev/gw_utils_ref.html b/dev/gw_utils_ref.html
@@ -82,21 +82,21 @@ <h3>Navigation</h3>
 <dt class="sig sig-object py" id="kuibit.gw_utils.Detectors">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kuibit.gw_utils.</span></span><span class="sig-name descname"><span class="pre">Detectors</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hanford</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">livingston</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">virgo</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kuibit.gw_utils.Detectors" title="Permalink to this definition">¶</a></dt>
 <dd><p>Create new instance of Detectors(hanford, livingston, virgo)</p>
-<dl class="py property">
+<dl class="py attribute">
 <dt class="sig sig-object py" id="kuibit.gw_utils.Detectors.hanford">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hanford</span></span><a class="headerlink" href="#kuibit.gw_utils.Detectors.hanford" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">hanford</span></span><a class="headerlink" href="#kuibit.gw_utils.Detectors.hanford" title="Permalink to this definition">¶</a></dt>
 <dd><p>Alias for field number 0</p>
 </dd></dl>
 
-<dl class="py property">
+<dl class="py attribute">
 <dt class="sig sig-object py" id="kuibit.gw_utils.Detectors.livingston">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">livingston</span></span><a class="headerlink" href="#kuibit.gw_utils.Detectors.livingston" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">livingston</span></span><a class="headerlink" href="#kuibit.gw_utils.Detectors.livingston" title="Permalink to this definition">¶</a></dt>
 <dd><p>Alias for field number 1</p>
 </dd></dl>
 
-<dl class="py property">
+<dl class="py attribute">
 <dt class="sig sig-object py" id="kuibit.gw_utils.Detectors.virgo">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">virgo</span></span><a class="headerlink" href="#kuibit.gw_utils.Detectors.virgo" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">virgo</span></span><a class="headerlink" href="#kuibit.gw_utils.Detectors.virgo" title="Permalink to this definition">¶</a></dt>
 <dd><p>Alias for field number 2</p>
 </dd></dl>
 

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/searchindex.js b/dev/searchindex.js
diff --git a/dev/tutorials/cactus_horizons.html b/dev/tutorials/cactus_horizons.html
@@ -149,7 +149,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-[&lt;matplotlib.lines.Line2D at 0x7f6af5a87410&gt;]
+[&lt;matplotlib.lines.Line2D at 0x7f4ff631b1f0&gt;]
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -174,7 +174,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-[&lt;matplotlib.lines.Line2D at 0x7f6af5660210&gt;]
+[&lt;matplotlib.lines.Line2D at 0x7f4ff3ecb940&gt;]
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -206,7 +206,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-&lt;mpl_toolkits.mplot3d.art3d.Path3DCollection at 0x7f6af5724fd0&gt;
+&lt;mpl_toolkits.mplot3d.art3d.Path3DCollection at 0x7f4ff3e13c70&gt;
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -278,7 +278,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-&lt;mpl_toolkits.mplot3d.art3d.Path3DCollection at 0x7f6af53bc9d0&gt;
+&lt;mpl_toolkits.mplot3d.art3d.Path3DCollection at 0x7f4feffab310&gt;
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -308,7 +308,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-[&lt;matplotlib.patches.Polygon at 0x7f6af127fa50&gt;]
+[&lt;matplotlib.patches.Polygon at 0x7f4ff0d789d0&gt;]
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -335,7 +335,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-[&lt;matplotlib.patches.Polygon at 0x7f6af2ebb510&gt;]
+[&lt;matplotlib.patches.Polygon at 0x7f4ff09d3160&gt;]
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -360,7 +360,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-[&lt;matplotlib.patches.Polygon at 0x7f6af2eb0dd0&gt;]
+[&lt;matplotlib.patches.Polygon at 0x7f4ff09bbd00&gt;]
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -423,7 +423,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-&lt;matplotlib.legend.Legend at 0x7f6af27c2750&gt;
+&lt;matplotlib.legend.Legend at 0x7f4ff08e6df0&gt;
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">
@@ -490,7 +490,7 @@ <h1>Working with Cactus horizons<a class="headerlink" href="#Working-with-Cactus
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-&lt;matplotlib.legend.Legend at 0x7f6af26e3b50&gt;
+&lt;matplotlib.legend.Legend at 0x7f4ff3f59160&gt;
 </pre></div></div>
 </div>
 <div class="nboutput nblast docutils container">