Skip to content

Commit fa9aca8

Browse files
committed
deploy: 8c728cc
1 parent e9fdd53 commit fa9aca8

5 files changed

Lines changed: 10 additions & 17 deletions

File tree

.doctrees/environment.pickle

0 Bytes
Binary file not shown.

.doctrees/index.doctree

-4.82 KB
Binary file not shown.

_sources/index.rst.txt

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
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, 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.***
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**
55

66
PyFTLE3D is a Python-based research toolkit for computing and visualizing
77
Lagrangian coherent structures (LCS) in three-dimensional fluid flows and other complex systems by computing Finite Time Lyapunov Exponent.
8-
Coming with GUI and integrated environment, it is designed to be user-friendly and accessible, allowing peers to easily analyze and visualize LCS in their data
8+
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
99
with multiple OOTB numerical methods, with various computation density, accuracy, and focus preferences,
1010
with no need for researchers to have any programming knowledge.
1111
Certainly, it is also suitable for those with programming experience who want to customize their analysis.
1212

13-
The computation is accelerated by CUDA, the NVidia treasure, achieving over 30x speedup compared to the CPU version.
13+
The computation is accelerated by CUDA (Python Numba implement), achieving over 30x speedup compared to the CPU version.
14+
The author currently lacks the capability to develop with OpenCL, so for now only NVIDIA GPUs are supported for acceleration.
1415
As most of computers have larger RAM than GPU memory, the toolkit also supports CPU mode for large datasets on CPU systems.
1516
Although, the new features would firstly be added to the GPU version, and the CPU version would be updated with month-scale delay.
1617

17-
nekRS is a computational fluid dynamics code developed at :term:`ANL`, :term:`UIUC`, and :term:`PSU`.
18-
nekRS aims to leverage the present trend in :term:`GPU`-based :term:`HPC` systems to perform
19-
:term:`CFD` on :term:`GPU`-accelerated systems. By using the :term:`OCCA` library's unified
20-
:term:`API`, nekRS can run on :term:`CPUs<CPU>` and on :term:`GPU`-accelerated :term:`CPUs<CPU>` that
21-
support :term:`CUDA`, :term:`HIP`, or :term:`OpenCL`.
18+
2219

2320
This guide is intended to help new users get started with using nekRS, as well as serve as a
2421
reference for more advanced users. Because the :term:`Nek5000` code is somewhat of a predecessor to

index.html

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,17 @@
8383

8484
<section id="pyftle3d-research-toolkit-for-3d-lagrangian-coherent-structures-with-gui">
8585
<h1>PyFTLE3D: Research Toolkit for 3D Lagrangian coherent structures with GUI<a class="headerlink" href="#pyftle3d-research-toolkit-for-3d-lagrangian-coherent-structures-with-gui" title="Link to this heading"></a></h1>
86-
<p><strong>*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, 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.*</strong></p>
86+
<p><strong>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</strong></p>
8787
<p>PyFTLE3D is a Python-based research toolkit for computing and visualizing
8888
Lagrangian coherent structures (LCS) in three-dimensional fluid flows and other complex systems by computing Finite Time Lyapunov Exponent.
89-
Coming with GUI and integrated environment, it is designed to be user-friendly and accessible, allowing peers to easily analyze and visualize LCS in their data
89+
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
9090
with multiple OOTB numerical methods, with various computation density, accuracy, and focus preferences,
9191
with no need for researchers to have any programming knowledge.
9292
Certainly, it is also suitable for those with programming experience who want to customize their analysis.</p>
93-
<p>The computation is accelerated by CUDA, the NVidia treasure, achieving over 30x speedup compared to the CPU version.
93+
<p>The computation is accelerated by CUDA (Python Numba implement), achieving over 30x speedup compared to the CPU version.
94+
The author currently lacks the capability to develop with OpenCL, so for now only NVIDIA GPUs are supported for acceleration.
9495
As most of computers have larger RAM than GPU memory, the toolkit also supports CPU mode for large datasets on CPU systems.
9596
Although, the new features would firstly be added to the GPU version, and the CPU version would be updated with month-scale delay.</p>
96-
<p>nekRS is a computational fluid dynamics code developed at <a class="reference internal" href="glossary.html#term-ANL"><span class="xref std std-term">ANL</span></a>, <a class="reference internal" href="glossary.html#term-UIUC"><span class="xref std std-term">UIUC</span></a>, and <a class="reference internal" href="glossary.html#term-PSU"><span class="xref std std-term">PSU</span></a>.
97-
nekRS aims to leverage the present trend in <a class="reference internal" href="glossary.html#term-GPU"><span class="xref std std-term">GPU</span></a>-based <a class="reference internal" href="glossary.html#term-HPC"><span class="xref std std-term">HPC</span></a> systems to perform
98-
<a class="reference internal" href="glossary.html#term-CFD"><span class="xref std std-term">CFD</span></a> on <a class="reference internal" href="glossary.html#term-GPU"><span class="xref std std-term">GPU</span></a>-accelerated systems. By using the <a class="reference internal" href="glossary.html#term-OCCA"><span class="xref std std-term">OCCA</span></a> library’s unified
99-
<a class="reference internal" href="glossary.html#term-API"><span class="xref std std-term">API</span></a>, nekRS can run on <a class="reference internal" href="glossary.html#term-CPU"><span class="xref std std-term">CPUs</span></a> and on <a class="reference internal" href="glossary.html#term-GPU"><span class="xref std std-term">GPU</span></a>-accelerated <a class="reference internal" href="glossary.html#term-CPU"><span class="xref std std-term">CPUs</span></a> that
100-
support <a class="reference internal" href="glossary.html#term-CUDA"><span class="xref std std-term">CUDA</span></a>, <a class="reference internal" href="glossary.html#term-HIP"><span class="xref std std-term">HIP</span></a>, or <a class="reference internal" href="glossary.html#term-OpenCL"><span class="xref std std-term">OpenCL</span></a>.</p>
10197
<p>This guide is intended to help new users get started with using nekRS, as well as serve as a
10298
reference for more advanced users. Because the <a class="reference internal" href="glossary.html#term-Nek5000"><span class="xref std std-term">Nek5000</span></a> code is somewhat of a predecessor to
10399
nekRS, some aspects of the current nekRS design are selected to enable faster translation of

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)