deploy: 2e2c303

Author: hweifluids

.doctrees/1_requirements.doctree

@@ -44,6 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Requirements and Quickstart</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#hardware-and-hardware-requirements">Hardware and Hardware Requirements</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#basic-environment">Basic Environment</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#add-on-libs">Add-on Libs</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#quickstart">Quickstart</a></li>
@@ -86,6 +87,21 @@
 
   <section id="requirements-and-quickstart">
 <span id="requirements"></span><h1>Requirements and Quickstart<a class="headerlink" href="#requirements-and-quickstart" title="Link to this heading"></a></h1>
+<section id="hardware-and-hardware-requirements">
+<h2>Hardware and Hardware Requirements<a class="headerlink" href="#hardware-and-hardware-requirements" title="Link to this heading"></a></h2>
+<p>The minimiums are listed as follows:</p>
+<ul class="simple">
+<li><p>Minimium 4GB RAM and 10GB free disk.</p></li>
+<li><p>Not sensitive to platform. Windows 11 and Ubuntu 22.04 are fully tested.</p></li>
+</ul>
+<p>GPU acceleration is suggested for large dataset computation. Therefore, the requirements for GPU acceleration is listed as follows:</p>
+<ul class="simple">
+<li><p>NVIDIA GPUs, with a minimum <a class="reference external" href="https://developer.nvidia.com/cuda-gpus">compute capability</a> of 5.0, i.e., later than GTX 750.</p></li>
+<li><p>It is suggested that, make <code class="docutils literal notranslate"><span class="pre">Nx</span></code> × <code class="docutils literal notranslate"><span class="pre">Ny</span></code> × <code class="docutils literal notranslate"><span class="pre">Nz</span></code> × <code class="docutils literal notranslate"><span class="pre">Nt</span></code> less than 200,000,000 Lagrangian particles on each Gigabyte of GPU memory for double-side computation under default numerical methods for one still. Generally half it under high-order computations.</p></li>
+</ul>
+<p>For example, you can execute on a 600×300×300 mesh for c.a. 80 time steps for a still.
+* The GPU requirements for dynamic LCS are undergoing experiments by the author.</p>
+</section>
 <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 <code class="docutils literal notranslate"><span class="pre">PyFTLE3D</span></code>.</p>

.doctrees/6_inputdeck.doctree

@@ -88,6 +88,10 @@
 
   <section id="input-deck-for-solver-parameters">
 <span id="inputdeck"></span><h1>Input Deck for Solver Parameters<a class="headerlink" href="#input-deck-for-solver-parameters" title="Link to this heading"></a></h1>
+<p>This section details the solver parameters in the structured input deck (<code class="docutils literal notranslate"><span class="pre">.par</span></code> file), which is finally read by the main solver.
+In GUI mode, it is also the only purpose for the preprocessor to write out, and serves as the mid-file format for GUI resolve.
+It includes the path pointing to data, indicates the path to save results, and determines the modes and numerical methods for the solver.
+In other words, if the data is placed properly, this <code class="docutils literal notranslate"><span class="pre">.par</span></code> it the only input file by the solver.</p>
 <section id="input-and-range-control">
 <h2>Input and Range Control<a class="headerlink" href="#input-and-range-control" title="Link to this heading"></a></h2>
 <table class="docutils align-default">
@@ -305,7 +309,7 @@ <h2>Dynamic LCS Window<a class="headerlink" href="#dynamic-lcs-window" title="Li
 <tr class="row-odd"><td></td>
 <td></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
-<td><p>Dynamic LCS computation based on sliding window. See <a class="reference internal" href="2_theory.html#unsteady"><span class="std std-ref">Unsteady LCS</span></a>.</p></td>
+<td><p>Dynamic LCS computation based on sliding window method. See <a class="reference internal" href="2_theory.html#unsteady"><span class="std std-ref">Unsteady LCS</span></a>.</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">win_size</span></code></p></td>
 <td><p>Window size for dynamic LCS</p></td>

.doctrees/environment.pickle

@@ -3,6 +3,22 @@
 Requirements and Quickstart
 ========================
 
+Hardware and Hardware Requirements
+----------------------------------
+
+The minimiums are listed as follows:
+
+* Minimium 4GB RAM and 10GB free disk.
+* Not sensitive to platform. Windows 11 and Ubuntu 22.04 are fully tested.
+
+GPU acceleration is suggested for large dataset computation. Therefore, the requirements for GPU acceleration is listed as follows:
+
+* NVIDIA GPUs, with a minimum `compute capability <https://developer.nvidia.com/cuda-gpus>`__ of 5.0, i.e., later than GTX 750.
+* It is suggested that, make ``Nx`` × ``Ny`` × ``Nz`` × ``Nt`` less than 200,000,000 Lagrangian particles on each Gigabyte of GPU memory for double-side computation under default numerical methods for one still. Generally half it under high-order computations.
+For example, you can execute on a 600×300×300 mesh for c.a. 80 time steps for a still.
+* The GPU requirements for dynamic LCS are undergoing experiments by the author.
+
+
 Basic Environment
 -----------------
 
@@ -11,9 +27,7 @@ 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.
 
 1. `Python <https://www.python.org/>`__ 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 `here <https://www.python.org/downloads/release/python-3130/?featured_on=pythonbytes>`__. Please select Python installer according to your system framework.
-
 2. `CUDA Toolkit <https://developer.nvidia.com/cuda-toolkit>`__ version 12.9 (`Download <https://developer.nvidia.com/cuda-toolkit-archive>`__). 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 `cupy`, and could cause unexpected performance decay and errors. See `cupy` documentation for more information.
-
 3. `pip <https://pypi.org/project/pip/>`__ newest version, which is used for installing further dependencies. It can be installed by:
 
 .. code-block::

1_requirements.html

@@ -3,6 +3,12 @@
 Input Deck for Solver Parameters
 ================================
 
+This section details the solver parameters in the structured input deck (``.par`` file), which is finally read by the main solver.
+In GUI mode, it is also the only purpose for the preprocessor to write out, and serves as the mid-file format for GUI resolve.
+It includes the path pointing to data, indicates the path to save results, and determines the modes and numerical methods for the solver.
+In other words, if the data is placed properly, this ``.par`` it the only input file by the solver.
+
+
 Input and Range Control
 ---------------------------------
 
@@ -95,7 +101,7 @@ Dynamic LCS Window
 +===================+======================================================+=========================+=========================================================================================================+
 | ``dyn_mode``      | Dynamic LCS mode selector                            | (``0``)                 | Treat this input as a steady whole, generating still results. See :ref:`steady`.                        |
 +-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
-|                   |                                                      | ``1``                   | Dynamic LCS computation based on sliding window. See :ref:`unsteady`.                                   |
+|                   |                                                      | ``1``                   | Dynamic LCS computation based on sliding window method. See :ref:`unsteady`.                            |
 +-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+
 | ``win_size``      | Window size for dynamic LCS                          | ``<float>``             | The window size in frames for each batch of computation. Available under ``dyn_mode=1``.                |
 +-------------------+------------------------------------------------------+-------------------------+---------------------------------------------------------------------------------------------------------+

6_inputdeck.html

@@ -104,6 +104,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="1_requirements.html">Requirements and Quickstart</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#hardware-and-hardware-requirements">Hardware and Hardware Requirements</a></li>
 <li class="toctree-l2"><a class="reference internal" href="1_requirements.html#basic-environment">Basic Environment</a></li>
 <li class="toctree-l2"><a class="reference internal" href="1_requirements.html#add-on-libs">Add-on Libs</a></li>
 <li class="toctree-l2"><a class="reference internal" href="1_requirements.html#quickstart">Quickstart</a></li>