Update template

Author: hweifluids

.github/workflows/gh-pages.yml

@@ -17,11 +17,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Install system dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y doxygen
-
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
@@ -34,11 +29,6 @@ jobs:
       - name: Build HTML
         run: sphinx-build -b html source build/html
 
-      - name: Clean up nested Git metadata
-        run: |
-          find build/html -type d -name .git -prune -exec rm -rf {} +
-
-
       - name: Deploy to gh-pages
         uses: peaceiris/actions-gh-pages@v4
         with:

.gitignore

@@ -1,2 +1,2 @@
-source/doxygen/*
 build/
+codexlog/

Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = nekRSDoc
+SPHINXPROJ    = StreamcenterPlusDoc
 SOURCEDIR     = source
 BUILDDIR      = build
 

README.md

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

source/0_backup.rst

@@ -1,7 +1,7 @@
 .. _requirements:
 
 Requirements and Quickstart
-========================
+===========================
 
 Hardware and Hardware Requirements
 ----------------------------------
@@ -22,7 +22,7 @@ GPU acceleration is suggested for large dataset computation. Therefore, the requ
 Basic Environment
 -----------------
 
-This page summarizes the system requirements and dependencies of ``PyFTLE3D``.
+This page summarizes the system requirements and dependencies of ``Streamcenter+``.
 
 Firstly, the following packages are supposed to be installed on your computer manually in advance.
 
@@ -53,15 +53,15 @@ You can install them after installing ``pip`` by:
 
   pip install -r ./requirements.txt
 
-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.
+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.
 
 
 Add-on Libs (Optional)
------------------
+----------------------
 
 **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.
 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>`__. 
-For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Py3DFTLE``.
+For already-installed ParaView, set environment variable ``PARAVIEW_PATH`` pointing to the root dir of ParaView to enable integration from GUI of ``Streamcenter+``.
 
 Quickstart
 -----------------

source/1_requirements.rst

@@ -6,9 +6,11 @@ Theory of FTLE and LCS
 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.
 
 .. _steady:
+
 Steady LCS
 --------------
 
 .. _unsteady:
+
 Unsteady LCS
---------------
+--------------