Skip to content

Commit e3b6b40

Browse files
committed
deploy: 15cb903
1 parent afe250b commit e3b6b40

6 files changed

Lines changed: 23 additions & 45 deletions

File tree

.doctrees/1_requirements.doctree

-1.91 KB
Binary file not shown.

.doctrees/environment.pickle

-18 Bytes
Binary file not shown.

1_requirements.html

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<ul class="current">
4747
<li class="toctree-l1 current"><a class="current reference internal" href="#">Requirements and Quickstart</a><ul>
4848
<li class="toctree-l2"><a class="reference internal" href="#hardware-and-platform">Hardware and Platform</a></li>
49-
<li class="toctree-l2"><a class="reference internal" href="#mainline-environment">Mainline Environment</a></li>
49+
<li class="toctree-l2"><a class="reference internal" href="#environment">Environment</a></li>
5050
<li class="toctree-l2"><a class="reference internal" href="#environment-overrides">Environment Overrides</a></li>
5151
<li class="toctree-l2"><a class="reference internal" href="#add-on-tools">Add-on Tools</a></li>
5252
<li class="toctree-l2"><a class="reference internal" href="#quickstart">Quickstart</a><ul>
@@ -95,18 +95,14 @@
9595
<span id="requirements"></span><h1>Requirements and Quickstart<a class="headerlink" href="#requirements-and-quickstart" title="Link to this heading"></a></h1>
9696
<section id="hardware-and-platform">
9797
<h2>Hardware and Platform<a class="headerlink" href="#hardware-and-platform" title="Link to this heading"></a></h2>
98-
<p>This page summarizes the supported mainline workflow of <code class="docutils literal notranslate"><span class="pre">Streamcenter+</span></code>.
99-
The current mainline is no longer the old Python package set. It is centered on a
100-
native CUDA FTLE solver together with a native Qt/VTK desktop GUI.
101-
The archived Python implementation is still preserved under <code class="docutils literal notranslate"><span class="pre">legacy/</span></code> in the code
102-
repository for reference and migration, but it is no longer the primary workflow
103-
described in this documentation.</p>
98+
<p><code class="docutils literal notranslate"><span class="pre">Streamcenter+</span></code> consists of a native CUDA FTLE solver together with a native
99+
Qt/VTK desktop GUI.</p>
104100
<p>The minimum practical requirements are listed as follows:</p>
105101
<ul class="simple">
106102
<li><p>At least 4 GB of system memory and about 10 GB of free disk space.</p></li>
107103
<li><p>A 64-bit Windows or Linux environment. The shipped install scripts currently target
108104
Windows and Debian/Ubuntu-style Linux systems with <code class="docutils literal notranslate"><span class="pre">apt</span></code>.</p></li>
109-
<li><p>An NVIDIA GPU together with a locally installed CUDA Toolkit for the mainline solver.</p></li>
105+
<li><p>An NVIDIA GPU together with a locally installed CUDA Toolkit for the solver.</p></li>
110106
</ul>
111107
<p>The solver configures <code class="docutils literal notranslate"><span class="pre">CMAKE_CUDA_ARCHITECTURES=native</span></code> by default, so the build
112108
machine is expected to have a visible local NVIDIA CUDA environment.</p>
@@ -116,14 +112,11 @@ <h2>Hardware and Platform<a class="headerlink" href="#hardware-and-platform" tit
116112
below roughly 200,000,000 Lagrangian particles per GiB of VRAM for the default
117113
double-sided still workflow, and lower than that for higher-order settings.</p>
118114
</section>
119-
<section id="mainline-environment">
120-
<h2>Mainline Environment<a class="headerlink" href="#mainline-environment" title="Link to this heading"></a></h2>
121-
<p>The native solver and the native GUI do not require Python or <code class="docutils literal notranslate"><span class="pre">pip</span></code> for their
122-
standard build-and-run path.
123-
Instead, the repository provides platform-specific installation scripts that prepare
124-
the CMake/CUDA/Qt/VTK toolchain directly.</p>
125-
<p>On Windows, <code class="docutils literal notranslate"><span class="pre">install.cmd</span></code> and <code class="docutils literal notranslate"><span class="pre">install.ps1</span></code> provision the following mainline
126-
dependencies:</p>
115+
<section id="environment">
116+
<h2>Environment<a class="headerlink" href="#environment" title="Link to this heading"></a></h2>
117+
<p>The repository provides platform-specific installation scripts that prepare the
118+
CMake/CUDA/Qt/VTK toolchain directly.</p>
119+
<p>On Windows, <code class="docutils literal notranslate"><span class="pre">install.cmd</span></code> and <code class="docutils literal notranslate"><span class="pre">install.ps1</span></code> provision the following dependencies:</p>
127120
<ul class="simple">
128121
<li><p><code class="docutils literal notranslate"><span class="pre">Git</span></code></p></li>
129122
<li><p><code class="docutils literal notranslate"><span class="pre">CMake</span></code></p></li>
@@ -168,8 +161,6 @@ <h2>Environment Overrides<a class="headerlink" href="#environment-overrides" tit
168161
<li><p><code class="docutils literal notranslate"><span class="pre">STREAMCENTERPLUS_VTK_ROOT</span></code></p></li>
169162
<li><p><code class="docutils literal notranslate"><span class="pre">STREAMCENTERPLUS_CUDA_ROOT</span></code></p></li>
170163
</ul>
171-
<p>For migration convenience, the renamed build scripts still accept the legacy
172-
<code class="docutils literal notranslate"><span class="pre">PY3DFTLE_*</span></code> environment variables as fallback inputs.</p>
173164
</section>
174165
<section id="add-on-tools">
175166
<h2>Add-on Tools<a class="headerlink" href="#add-on-tools" title="Link to this heading"></a></h2>
@@ -191,7 +182,7 @@ <h2>Add-on Tools<a class="headerlink" href="#add-on-tools" title="Link to this h
191182
</section>
192183
<section id="quickstart">
193184
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h2>
194-
<p>The steps below follow the current native mainline repository layout.
185+
<p>The steps below follow the current repository layout.
195186
They use the top-level install and build entry points and then launch the GUI or solver
196187
through the maintained wrapper scripts.</p>
197188
<section id="windows">
@@ -248,8 +239,7 @@ <h3>Linux (Debian/Ubuntu)<a class="headerlink" href="#linux-debian-ubuntu" title
248239
</section>
249240
<section id="notes-for-real-cases">
250241
<h2>Notes for Real Cases<a class="headerlink" href="#notes-for-real-cases" title="Link to this heading"></a></h2>
251-
<p>The mainline GUI always launches the native CUDA solver. There is no longer a
252-
Python/native backend selector in the supported workflow.</p>
242+
<p>The GUI launches the native CUDA solver.</p>
253243
<p>The parameter format remains <code class="docutils literal notranslate"><span class="pre">.par</span></code>-based.
254244
When preparing your own cases, update entries such as <code class="docutils literal notranslate"><span class="pre">vtk_folder</span></code> and
255245
<code class="docutils literal notranslate"><span class="pre">output_dir</span></code> so that they point to locations that actually exist on your machine.

_sources/1_requirements.rst.txt

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,15 @@ Requirements and Quickstart
66
Hardware and Platform
77
---------------------
88

9-
This page summarizes the supported mainline workflow of ``Streamcenter+``.
10-
The current mainline is no longer the old Python package set. It is centered on a
11-
native CUDA FTLE solver together with a native Qt/VTK desktop GUI.
12-
The archived Python implementation is still preserved under ``legacy/`` in the code
13-
repository for reference and migration, but it is no longer the primary workflow
14-
described in this documentation.
9+
``Streamcenter+`` consists of a native CUDA FTLE solver together with a native
10+
Qt/VTK desktop GUI.
1511

1612
The minimum practical requirements are listed as follows:
1713

1814
* At least 4 GB of system memory and about 10 GB of free disk space.
1915
* A 64-bit Windows or Linux environment. The shipped install scripts currently target
2016
Windows and Debian/Ubuntu-style Linux systems with ``apt``.
21-
* An NVIDIA GPU together with a locally installed CUDA Toolkit for the mainline solver.
17+
* An NVIDIA GPU together with a locally installed CUDA Toolkit for the solver.
2218

2319
The solver configures ``CMAKE_CUDA_ARCHITECTURES=native`` by default, so the build
2420
machine is expected to have a visible local NVIDIA CUDA environment.
@@ -30,16 +26,13 @@ below roughly 200,000,000 Lagrangian particles per GiB of VRAM for the default
3026
double-sided still workflow, and lower than that for higher-order settings.
3127

3228

33-
Mainline Environment
34-
--------------------
29+
Environment
30+
-----------
3531

36-
The native solver and the native GUI do not require Python or ``pip`` for their
37-
standard build-and-run path.
38-
Instead, the repository provides platform-specific installation scripts that prepare
39-
the CMake/CUDA/Qt/VTK toolchain directly.
32+
The repository provides platform-specific installation scripts that prepare the
33+
CMake/CUDA/Qt/VTK toolchain directly.
4034

41-
On Windows, ``install.cmd`` and ``install.ps1`` provision the following mainline
42-
dependencies:
35+
On Windows, ``install.cmd`` and ``install.ps1`` provision the following dependencies:
4336

4437
* ``Git``
4538
* ``CMake``
@@ -87,10 +80,6 @@ understand the following environment variables:
8780
* ``STREAMCENTERPLUS_VTK_ROOT``
8881
* ``STREAMCENTERPLUS_CUDA_ROOT``
8982

90-
For migration convenience, the renamed build scripts still accept the legacy
91-
``PY3DFTLE_*`` environment variables as fallback inputs.
92-
93-
9483
Add-on Tools
9584
------------
9685

@@ -114,7 +103,7 @@ Add-on Tools
114103
Quickstart
115104
----------
116105

117-
The steps below follow the current native mainline repository layout.
106+
The steps below follow the current repository layout.
118107
They use the top-level install and build entry points and then launch the GUI or solver
119108
through the maintained wrapper scripts.
120109

@@ -196,8 +185,7 @@ Without PowerShell, launch the built solver binary directly from
196185
Notes for Real Cases
197186
--------------------
198187

199-
The mainline GUI always launches the native CUDA solver. There is no longer a
200-
Python/native backend selector in the supported workflow.
188+
The GUI launches the native CUDA solver.
201189

202190
The parameter format remains ``.par``-based.
203191
When preparing your own cases, update entries such as ``vtk_folder`` and

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
107107
<ul>
108108
<li class="toctree-l1"><a class="reference internal" href="1_requirements.html">Requirements and Quickstart</a><ul>
109109
<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#hardware-and-platform">Hardware and Platform</a></li>
110-
<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#mainline-environment">Mainline Environment</a></li>
110+
<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#environment">Environment</a></li>
111111
<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#environment-overrides">Environment Overrides</a></li>
112112
<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#add-on-tools">Add-on Tools</a></li>
113113
<li class="toctree-l2"><a class="reference internal" href="1_requirements.html#quickstart">Quickstart</a></li>

0 commit comments

Comments
 (0)