You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/1_requirements.rst
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,9 @@ This page summarizes the system requirements and dependencies of PyFTLE3D.
10
10
11
11
Firstly, the following packages are supposed to be installed on your computer manually in advance.
12
12
13
-
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.
13
+
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.
14
14
15
-
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.
15
+
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.
16
16
17
17
3. `pip <https://pypi.org/project/pip/>`__ newest version, which is used for installing further dependencies. It can be installed by:
18
18
@@ -28,7 +28,7 @@ Generally, the following dependencies can be installed via ``pip``, the Python p
28
28
5. `pyevtk <https://github.com/paulo-herrera/PyEVTK>`__ version 1.4 or later
29
29
6. `numba <https://numba.pydata.org>`__ version 0.54 or later
30
30
7. `tqdm <https://tqdm.github.io>`__ version 4.62 or later
31
-
8. `cupy-cuda12x <https://cupy.dev>`__
31
+
8. `cupy-cuda12x <https://pypi.org/project/cupy-cuda12x/>`__ version 13.4.1 or later
32
32
9. `pyvistaqt <https://github.com/pyvista/pyvistaqt>`__ version 0.11.2 or later
33
33
10. `PyQt5 <https://riverbankcomputing.com/software/pyqt/intro>`__ version 5.15.11 or later
34
34
@@ -45,8 +45,9 @@ Add-on Libs
45
45
1. **ParaView**
46
46
47
47
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>`__.
48
+
For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Py3DFTLE``.
48
49
49
50
Quickstart
50
51
-----------------
51
52
An computation example coming with a set of our in-house downscaled Direct Navier-Stokes Simulation (DNS) data is provided, including :math:
52
-
The dataset can be downloaded from `here <https://noting.noting>`, and the case descriptions can be referred to paper [1]_.
53
+
The dataset can be downloaded from `here <https://noting.noting>`, and the case descriptions can be referred to paper [1].
0 commit comments