Skip to content

Commit 15edbeb

Browse files
committed
minor
1 parent e822044 commit 15edbeb

5 files changed

Lines changed: 9 additions & 8 deletions

File tree

source/1_requirements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ You can install them after installing ``pip`` by:
5656
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.
5757

5858

59-
Add-on Libs
59+
Add-on Libs (Optional)
6060
-----------------
6161

6262
**1. 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.

source/3_numerical.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Eigenvalue Solver
186186
.. _numcompare:
187187

188188
Computational Density and Comparison
189-
==========================================
189+
----------------------------------------------
190190

191191
.. _numtips:
192192

source/7_command.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
Command-Line Mode (Commands)
44
============================
55

6-
This page describes how to perform
6+
This page describes how to perform FTLE computation under command mode via terminal and save results to standard ``.vts`` (Visualization Toolbox Structured data) files,
7+
which is a variation of ``.vtk`` format and supported by official ``.vtk`` API and many other post-processing platforms like ``ParaView``.

source/9_references.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ References
55

66
.. .. rubric:: References
77
8+
Cited and Suggested by ``Py3DFTLE``
9+
------------------------------------
810

911
.. [Lekien2005] Lekien, F., Marsden, J. "Tricubic interpolation in three dimensions," *International Journal for Numerical Methods in Engineering* **63** (2005).
1012

source/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ PyFTLE3D: 3D LCS Research Toolkit with GUI
44
.. note::
55

66
**The toolkit is undergoing an internal testing, and currently not publicly released. Who would like to use it in advance to release for non-profit use as early birds, please feel free contact me. The planned release time is 2025.06 - 2025.07 with high-freedom opensource license type, while the author still holds the right to change the release time. **
7+
78
**Terms marked with ``I.P.`` flag are under development. If they will be released with the toolkit at the same time is without my control due to my limited time and effort.**
9+
810
**- Huanxia with Regards.**
911

1012

@@ -19,11 +21,7 @@ As most computers have larger RAM than GPU memory, the toolkit also supports CPU
1921
Although, the new features would firstly be added to the GPU version, and the CPU version would be updated with a month-scale delay.
2022

2123
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.
22-
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.
23-
24-
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.
25-
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.
26-
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.
24+
Some of the theories can be found in this section, but it is still more encouraged to learn LCS theories and numerical methods by reading the technical papers.
2725

2826

2927

0 commit comments

Comments
 (0)