Skip to content

Commit a7e2527

Browse files
committed
Update index.rst
1 parent 6480307 commit a7e2527

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

source/index.rst

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
PyFTLE3D: Research Toolkit for 3D Lagrangian coherent structures with GUI
22
===================================================
33

4-
**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. - Huanxia with Regards.**
4+
.. note::
5+
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. - Huanxia with Regards.
7+
58

69
PyFTLE3D is a Python-based research toolkit for computing and visualizing Lagrangian coherent structures (LCS) in three-dimensional fluid flows and other complex systems by computing Finite Time Lyapunov Exponent (FTLE) field.
710
Coming with GUI and integrated runtime, it is designed to be user-friendly and accessible, allowing peers to easily analyze and visualize LCS in their data, with no need for researchers to have any programming knowledge, just like using postprocessing software such as ParaView or Tecplot.
@@ -13,26 +16,15 @@ The author currently lacks the capability to develop with OpenCL, so for now onl
1316
As most computers have larger RAM than GPU memory, the toolkit also supports CPU mode for large datasets on CPU systems.
1417
Although, the new features would firstly be added to the GPU version, and the CPU version would be updated with a month-scale delay.
1518

16-
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.
19+
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.
1720
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.
1821

19-
This guide is intended to help new users get started with using nekRS, as well as serve as a
20-
reference for more advanced users. Because the :term:`Nek5000` code is somewhat of a predecessor to
21-
nekRS, some aspects of the current nekRS design are selected to enable faster translation of
22-
:term:`Nek5000` input files into nekRS input files. Throughout this documentation, all such
23-
:term:`Nek5000`-oriented settings will be referred to as "legacy" settings. Because these
24-
:term:`Nek5000`-oriented settings require proficiency in Fortran, structured text formats,
25-
and several additional input files, all new users are encouraged to adopt the nekRS-based problem setup.
2622

2723
We recommend working through this user guide in the order below. At the very least, please
2824
read :ref:`The nekRS Input Files <input>` page before reading the :ref:`FAQs <detailed>`
2925
page, as some necessary concepts are introduced in this order.
3026

31-
.. note::
3227

33-
This documentation is a work in progress, and will undergo big changes as more
34-
features are added to nekRS. Please open issues to track any missing information
35-
at the github repository `here <https://github.com/aprilnovak/nekRSDoc>`__.
3628

3729
Table of Contents
3830
-----------------

0 commit comments

Comments
 (0)