Skip to content

Commit 7be1225

Browse files
committed
revision
1 parent 601b1e1 commit 7be1225

6 files changed

Lines changed: 10 additions & 7 deletions

File tree

source/1_requirements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _requirements:
22

33
Requirements and Quickstart
4-
======
4+
========================
55

66
Basic Runtime
77
-----------------

source/2_theory.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _theory:
22

33
Theory of FTLE and LCS
4-
======
4+
======================
55

6-
This page introduces the
6+
This page introduces the theory of Finite-Time Lyapunov Exponents (FTLE) and Lagrangian Coherent Structures (LCS). It covers the mathematical foundations and applications of these concepts in fluid dynamics and other fields.

source/4_input.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _input:
22

3-
The nekRS Input Files
3+
Input Data Files
44
=====================
55

66
This page describes the input file

source/8_faqs.rst

Whitespace-only changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _references:
2+
23
References
34
==========
45

source/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ PyFTLE3D: 3D LCS Research Toolkit with GUI
33

44
.. note::
55

6-
**Notice: 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.**
6+
**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.**
77
**- Huanxia with Regards.**
88

99

@@ -20,7 +20,7 @@ Although, the new features would firstly be added to the GPU version, and the CP
2020
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.
2121
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.
2222

23-
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. The author is not short of money 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 the “Articles” section for reference by peers. The author also encourages peers who have cited this toolbox for reference, even if they did not directly use it in their investigation, to inform the authors. Those works will likewise be advertised in the documentation and repository.
23+
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. The author is not short of money 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. The author also encourages peers who have cited this toolbox for reference, even if they did not directly use it in their investigation, to inform the authors. Those works will likewise be advertised in the documentation and repository.
2424

2525

2626

@@ -36,14 +36,16 @@ Table of Contents
3636
.. toctree::
3737
:maxdepth: 2
3838

39+
3940
1_requirements
4041
2_theory
4142
3_numerical
4243
4_input
4344
5_gui
4445
6_inputdeck
4546
7_command
46-
8_references
47+
8_faqs
48+
9_references
4749

4850

4951
.. Indices and tables

0 commit comments

Comments
 (0)