commit cf1a02b2cd06322bd21e618795c3d5bc1a115a92
parent 508d9b67eafaf1739e400f73fd9e3af3aade7124
Author: christophe coustet <christophe.coustet@meso-star.com>
Date: Fri, 20 Nov 2020 16:42:24 +0100
Add stardis CLI tools description
Diffstat:
1 file changed, 28 insertions(+), 1 deletion(-)
diff --git a/stardis/stardis.html.in b/stardis/stardis.html.in
@@ -183,7 +183,34 @@ the accumulated power/flux, etc.</p>
<h2 id="cli">Stardis CLI tools</h2>
-<p>TODO</p>
+<p>The stardis framework includes CLI software, namely <b>stardis</b> and
+<b>sgreen</b>, to use along with stardis-solver. Even if this software is
+intended as a reference implementation, it allows to easily exploit some of
+the functionalities of the solver.</p>
+
+<h3 id="stardis-cli">The stardis CLI </h3>
+
+<p>The main CLI tool of the stardis framework is <b>stardis</b>. It can be seen
+as a limited but easy-to-use front-end to the stardis solver. Depending on the
+provided command line arguments, it simulates a thermal system described
+through a simple text file and geometry files and produces various types of
+output, from simple Monte-Carlo results to infrared images or Green
+functions.</p>
+
+<p>The main limitation that the <b>stardis</b> CLI adds to those of
+stardis-solver is that property descriptions cannot be time or space dependent:
+each region of the system, delimited by a boundary, can have its own set of
+properties, but these properties must be constant when stardis-solver allows
+properties varying in time and space.</p>
+
+<h3 id="sgreen-cli">The sgreen CLI</h3>
+
+<p>The only purpose of <b>sgreen</b> is to post-process binary green-function
+files produced by the stardis CLI. It allows to apply a set of values to the
+initial and boundary conditions as well as the power and flux sources of the
+model to produce the same result a new simulation would produce. The obvious
+benefit of using the sgreen post-process instead of a new Monte-Carlo
+simulation is the tremendous improvement on computation time.</p>
<h2>Quick start</h2>
