Skip to content

Commit 3db6226

Browse files
committed
Update 1_requirements.rst
1 parent ac87030 commit 3db6226

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

source/1_requirements.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Requirements and Quickstart
66
Basic Environment
77
-----------------
88

9-
This page summarizes the system requirements and dependencies of PyFTLE3D.
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

@@ -17,6 +17,7 @@ Firstly, the following packages are supposed to be installed on your computer ma
1717
3. `pip <https://pypi.org/project/pip/>`__ newest version, which is used for installing further dependencies. It can be installed by:
1818

1919
.. code-block::
20+
2021
python -m ensurepip --upgrade
2122
2223
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
3536
You can install them after installing ``pip`` by:
3637

3738
.. code-block::
39+
3840
pip install -r ./requirements.txt
3941
4042
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.
4143

4244

4345
Add-on Libs
4446
-----------------
45-
1. **ParaView**
47+
**1. ParaView**
4648

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>`__.
4851
For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Py3DFTLE``.
4952

5053
Quickstart
5154
-----------------
5255
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

Comments
 (0)