Skip to content

Commit 7bc7a96

Browse files
committed
update to Streamcenter+ version
1 parent 35f0cf8 commit 7bc7a96

9 files changed

Lines changed: 376 additions & 50 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
source/doxygen/*
22
build/
3+
codexlog/

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = nekRSDoc
7+
SPHINXPROJ = StreamcenterPlusDoc
88
SOURCEDIR = source
99
BUILDDIR = build
1010

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Py3DFTLE-GPU Documentation
1+
# Streamcenter+ Documentation
22

3-
This repository contains documentation of the [Py3DFTLE](https://github.com/hweifluids/Py3DFTLE-GPU) project
4-
using the [Sphinx](http://www.sphinx-doc.org/) documentation framework. A read the docs website
5-
is hosted [here](https://fluids.ac/Py3DFTLE-Doc/).
3+
This repository contains the Sphinx documentation sources for `Streamcenter+`.
4+
The documentation corresponds to the current mainline project, whose workflow is centered on a
5+
native C++/CUDA solver and a Qt/VTK desktop GUI, while the earlier Python implementation is
6+
retained only as a legacy archive.
67

78
## How to build locally
89

source/1_requirements.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _requirements:
22

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

66
Hardware and Hardware Requirements
77
----------------------------------
@@ -22,7 +22,7 @@ GPU acceleration is suggested for large dataset computation. Therefore, the requ
2222
Basic Environment
2323
-----------------
2424

25-
This page summarizes the system requirements and dependencies of ``PyFTLE3D``.
25+
This page summarizes the system requirements and dependencies of ``Streamcenter+``.
2626

2727
Firstly, the following packages are supposed to be installed on your computer manually in advance.
2828

@@ -53,15 +53,15 @@ You can install them after installing ``pip`` by:
5353
5454
pip install -r ./requirements.txt
5555
56-
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.
56+
When it does not work, consider if your current dir is incorrect. It should be run from the project root of ``Streamcenter+`` when undergoing configurations and under :ref:`command-line <command>` mode. Please feel free about such thing under GUI mode.
5757

5858

5959
Add-on Libs (Optional)
60-
-----------------
60+
----------------------
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.
6363
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>`__.
64-
For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Py3DFTLE``.
64+
For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Streamcenter+``.
6565

6666
Quickstart
6767
-----------------

0 commit comments

Comments
 (0)