Skip to content

Commit 2b0b42a

Browse files
committed
Update 1_requirements.rst
1 parent 41f414f commit 2b0b42a

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

source/1_requirements.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ This page summarizes the system requirements and dependencies of PyFTLE3D.
1010

1111
Firstly, the following packages are supposed to be installed on your computer manually in advance.
1212

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.
1414

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.
1616

1717
3. `pip <https://pypi.org/project/pip/>`__ newest version, which is used for installing further dependencies. It can be installed by:
1818

@@ -28,7 +28,7 @@ Generally, the following dependencies can be installed via ``pip``, the Python p
2828
5. `pyevtk <https://github.com/paulo-herrera/PyEVTK>`__ version 1.4 or later
2929
6. `numba <https://numba.pydata.org>`__ version 0.54 or later
3030
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
3232
9. `pyvistaqt <https://github.com/pyvista/pyvistaqt>`__ version 0.11.2 or later
3333
10. `PyQt5 <https://riverbankcomputing.com/software/pyqt/intro>`__ version 5.15.11 or later
3434

@@ -45,8 +45,9 @@ Add-on Libs
4545
1. **ParaView**
4646

4747
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``.
4849

4950
Quickstart
5051
-----------------
5152
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

Comments
 (0)