deploy: 3db6226

Author: hweifluids

.doctrees/1_requirements.doctree

@@ -87,13 +87,16 @@
 <span id="requirements"></span><h1>Requirements and Quickstart<a class="headerlink" href="#requirements-and-quickstart" title="Link to this heading"></a></h1>
 <section id="basic-environment">
 <h2>Basic Environment<a class="headerlink" href="#basic-environment" title="Link to this heading"></a></h2>
-<p>This page summarizes the system requirements and dependencies of PyFTLE3D.</p>
+<p>This page summarizes the system requirements and dependencies of <code class="docutils literal notranslate"><span class="pre">PyFTLE3D</span></code>.</p>
 <p>Firstly, the following packages are supposed to be installed on your computer manually in advance.</p>
 <ol class="arabic simple">
 <li><p><a class="reference external" href="https://www.python.org/">Python</a> version 3.13. Later version than 3.8 till 3.13 should work properly, but was not fully tested. The official download could be found at <a class="reference external" href="https://www.python.org/downloads/release/python-3130/?featured_on=pythonbytes">here</a>. Please select Python installer according to your system framework.</p></li>
 <li><p><a class="reference external" href="https://developer.nvidia.com/cuda-toolkit">CUDA Toolkit</a> version 12.9 (<a class="reference external" href="https://developer.nvidia.com/cuda-toolkit-archive">Download</a>). All versions crossing 12.x.x should theoretically work, but only 12.9 was fully tested. Ealier versions could work as well, but it requires a different version of <cite>cupy</cite>, and could cause unexpected performance decay and errors. See <cite>cupy</cite> documentation for more information.</p></li>
 <li><p><a class="reference external" href="https://pypi.org/project/pip/">pip</a> newest version, which is used for installing further dependencies. It can be installed by:</p></li>
 </ol>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">ensurepip</span> <span class="o">--</span><span class="n">upgrade</span>
+</pre></div>
+</div>
 <p>Generally, the following dependencies can be installed via <code class="docutils literal notranslate"><span class="pre">pip</span></code>, the Python package manager.</p>
 <ol class="arabic simple">
 <li><p><a class="reference external" href="https://numpy.org">numpy</a> version 1.21 or later</p></li>
@@ -108,20 +111,22 @@ <h2>Basic Environment<a class="headerlink" href="#basic-environment" title="Link
 <li><p><a class="reference external" href="https://riverbankcomputing.com/software/pyqt/intro">PyQt5</a> version 5.15.11 or later</p></li>
 </ol>
 <p>You can install them after installing <code class="docutils literal notranslate"><span class="pre">pip</span></code> by:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="o">./</span><span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
+</pre></div>
+</div>
 <p>When it does not work, consider if your current dir is incorrect. It should be run from the project root of <code class="docutils literal notranslate"><span class="pre">Py3DFTLE</span></code> when undergoing configurations and under <a class="reference internal" href="7_command.html#command"><span class="std std-ref">command-line</span></a> mode. Please feel free about such thing under GUI mode.</p>
 </section>
 <section id="add-on-libs">
 <h2>Add-on Libs<a class="headerlink" href="#add-on-libs" title="Link to this heading"></a></h2>
-<ol class="arabic simple">
-<li><p><strong>ParaView</strong></p></li>
-</ol>
-<p>ParaView is a powerful beloved open-source visualization platform based on vtk that can be used to visualize the results of 3D FTLE computations. We also integrated the ParaView entrance into our GUI, so you can directly open ParaView from it. The ParaView installation-free package (v6.0) can be downloaded from <a class="reference external" href="https://www.paraview.org/paraview-downloads/download.php?submit=Download&amp;version=v6.0&amp;type=binary&amp;os=Windows&amp;downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip">official</a>.
+<p><strong>1. ParaView</strong></p>
+<p>ParaView is a powerful beloved open-source visualization platform based on <em>vtk</em> that can be used to visualize the results of 3D FTLE computations. We also integrated the ParaView entrance into our GUI, so you can directly open ParaView from it.
+The ParaView installation-free package (v6.0) can be downloaded from <a class="reference external" href="https://www.paraview.org/paraview-downloads/download.php?submit=Download&amp;version=v6.0&amp;type=binary&amp;os=Windows&amp;downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip">official</a>.
 For already-installed ParaView, set environment variable <code class="docutils literal notranslate"><span class="pre">PARAVIEW_PATH</span></code> pointing to the root dir of ParaView to enable integration from GUI of <code class="docutils literal notranslate"><span class="pre">Py3DFTLE</span></code>.</p>
 </section>
 <section id="quickstart">
 <h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h2>
 <p>An computation example coming with a set of our in-house downscaled Direct Navier-Stokes Simulation (DNS) data is provided, including :math:
-The dataset can be downloaded from <cite>here &lt;https://noting.noting&gt;</cite>, and the case descriptions can be referred to paper [1].</p>
+The dataset can be downloaded from <cite>here &lt;https://noting.noting&gt;__</cite>, and the case descriptions can be referred to paper [1].</p>
 </section>
 </section>
 

.doctrees/environment.pickle

@@ -6,7 +6,7 @@ Requirements and Quickstart
 Basic Environment
 -----------------
 
-This page summarizes the system requirements and dependencies of PyFTLE3D.
+This page summarizes the system requirements and dependencies of ``PyFTLE3D``.
 
 Firstly, the following packages are supposed to be installed on your computer manually in advance.
 
@@ -17,6 +17,7 @@ Firstly, the following packages are supposed to be installed on your computer ma
 3. `pip <https://pypi.org/project/pip/>`__ newest version, which is used for installing further dependencies. It can be installed by:
 
 .. code-block::
+    
   python -m ensurepip --upgrade
 
 Generally, the following dependencies can be installed via ``pip``, the Python package manager.
@@ -35,19 +36,21 @@ Generally, the following dependencies can be installed via ``pip``, the Python p
 You can install them after installing ``pip`` by:
 
 .. code-block::
+
   pip install -r ./requirements.txt
 
 When it does not work, consider if your current dir is incorrect. It should be run from the project root of ``Py3DFTLE`` when undergoing configurations and under :ref:`command-line <command>` mode. Please feel free about such thing under GUI mode.
 
 
 Add-on Libs
 -----------------
-1. **ParaView**
+**1. ParaView**
 
-ParaView is a powerful beloved open-source visualization platform based on vtk that can be used to visualize the results of 3D FTLE computations. We also integrated the ParaView entrance into our GUI, so you can directly open ParaView from it. The ParaView installation-free package (v6.0) can be downloaded from `official <https://www.paraview.org/paraview-downloads/download.php?submit=Download&version=v6.0&type=binary&os=Windows&downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip>`__. 
+ParaView is a powerful beloved open-source visualization platform based on *vtk* that can be used to visualize the results of 3D FTLE computations. We also integrated the ParaView entrance into our GUI, so you can directly open ParaView from it.
+The ParaView installation-free package (v6.0) can be downloaded from `official <https://www.paraview.org/paraview-downloads/download.php?submit=Download&version=v6.0&type=binary&os=Windows&downloadFile=ParaView-6.0.0-RC1-MPI-Windows-Python3.12-msvc2017-AMD64.zip>`__. 
 For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Py3DFTLE``.
 
 Quickstart
 -----------------
 An computation example coming with a set of our in-house downscaled Direct Navier-Stokes Simulation (DNS) data is provided, including :math:
-The dataset can be downloaded from `here <https://noting.noting>`, and the case descriptions can be referred to paper [1].
+The dataset can be downloaded from `here <https://noting.noting>__`, and the case descriptions can be referred to paper [1].