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
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Requirements and Quickstart
6
6
Basic Environment
7
7
-----------------
8
8
9
-
This page summarizes the system requirements and dependencies of PyFTLE3D.
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
@@ -17,6 +17,7 @@ Firstly, the following packages are supposed to be installed on your computer ma
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
19
19
.. code-block::
20
+
20
21
python -m ensurepip --upgrade
21
22
22
23
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
35
36
You can install them after installing ``pip`` by:
36
37
37
38
.. code-block::
39
+
38
40
pip install -r ./requirements.txt
39
41
40
42
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.
41
43
42
44
43
45
Add-on Libs
44
46
-----------------
45
-
1. **ParaView**
47
+
**1. ParaView**
46
48
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>`__.
49
+
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.
50
+
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
51
For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Py3DFTLE``.
49
52
50
53
Quickstart
51
54
-----------------
52
55
An computation example coming with a set of our in-house downscaled Direct Navier-Stokes Simulation (DNS) data is provided, including :math:
53
-
The dataset can be downloaded from `here <https://noting.noting>`, and the case descriptions can be referred to paper [1].
56
+
The dataset can be downloaded from `here <https://noting.noting>__`, and the case descriptions can be referred to paper [1].
0 commit comments