reviision

Author: hweifluids

source/1_requirements.rst

@@ -6,7 +6,19 @@ Requirements and Quickstart
 Basic Environment
 -----------------
 
-This page summarizes the system requirements and dependencies of NekRS.
+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::
+  python -m ensurepip --upgrade
+
+Generally, the following dependencies can be installed via ``pip``, the Python package manager.
 
 1. `numpy <https://numpy.org>`__ version 1.21 or later  
 2. `matplotlib <https://matplotlib.org>`__ version 3.4 or later  
@@ -19,6 +31,10 @@ This page summarizes the system requirements and dependencies of NekRS.
 9. `pyvistaqt <https://github.com/pyvista/pyvistaqt>`__ version 0.11.2 or later  
 10. `PyQt5 <https://riverbankcomputing.com/software/pyqt/intro>`__ version 5.15.11 or later  
 
+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 <commands>`` mode. Please feel free about such thing under GUI mode.
 
 
 Add-on Libs

source/index.rst

@@ -20,15 +20,12 @@ Although, the new features would firstly be added to the GPU version, and the CP
 For the start, it is strongly suggested to begin with reading the review by Prof. George Haller in regard to LCS `here <https://www.georgehaller.com/reprints/annurev-fluid-010313-141322.pdf>`__, published on Annual Review of Fluid Mechanics, instead of directly use this toolkit without any theoretical foundation.
 Some of the theories can be found in this section, it is more encouraged to learn LCS theories and numerical methods by reading the technical papers.
 
-The author has invested countless off-work hours developing this software, with the goal of making such a powerful turbulence/complex-systems research tool by Professor Haller's team available to a wider audience and, through it, exploring charming phenomena in flow structures and instability. The author is not short of money and therefore does not accept donations or sponsorships. As the *"price"* for using this toolbox, if you publish a paper that employs it, you are asked to notify the author by email. These publications will be collected and listed in :ref:`References <references>` section for reference by peers. The author also encourages peers who have cited this toolbox for reference, even if they did not directly use it in their investigation, to inform the authors. Those works will likewise be advertised in the documentation and repository.
+The author has invested countless off-work hours developing this software, with the goal of making such a powerful turbulence/complex-systems research tool by Professor Haller's team available to a wider audience and, through it, exploring charming phenomena in flow structures and instability.
+The author is not short of money anymore and therefore does not accept donations or sponsorships. As the *"price"* for using this toolbox, if you publish a paper that employs it, you are asked to notify the author by email. These publications will be collected and listed in :ref:`References <references>` section for reference by peers. 
+The author also encourages peers who have cited this toolbox for reference to inform the author, even if they did not directly use it in their investigation. Those works would likewise be advertised in the documentation and repository.
 
 
 
-We recommend working through this user guide in the order below. At the very least, please
-read :ref:`The nekRS Input Files <input>` page before reading the :ref:`FAQs <detailed>`
-page, as some necessary concepts are introduced in this order.
-
-
 
 Table of Contents
 -----------------