commit 2dd4f184b4d9491265455392519bfcb0864bab3f
parent 49784ad1397ea9b366efeb01c3a8d5b35741af49
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 9 Apr 2026 11:39:08 +0200
Indicate that the shell scripts comply with the POSIX standard
Previously, the README file only mentioned GNU Bash scripts.
Diffstat:
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -2,20 +2,20 @@
The Stardis: Starter Pack is a collection of input data sets ready for
use with `stardis`, over a few examples.
-It also provides GNU Bash scripts that make easier the invocation of the
-`stardis` program.
+It also provides POSIX shell scripts that make easier the invocation of
+the `stardis` program.
It gives an overview of the required input data and the features of
`stardis`.
## Quick start
Assuming that `stardis` is correctly installed and registered against
-your current GNU Bash shell, simply run the GNU bash script of the
+your current POSIX shell, simply run the POSIX shell script of the
example that you want to run.
For instance:
~/Stardis-StarterPack $ cd heatsink
- ~/Stardis-StarterPack/heatsink $ bash run_medium_computation.sh
+ ~/Stardis-StarterPack/heatsink $ sh run_medium_computation.sh
On script invocation, `stardis` is ran according to the data of the
example and the simulation parameters defined in the `USER PARAMETERS`
@@ -32,9 +32,9 @@ Only thermal conduction is considered in this example.
The interest of this example is to be able to compare with an
unstationary analytical solution.
-The 3 provided bash scripts illustrate 3 main features of Stardis: the
-*probe computation*, the *visualization of thermal paths* and the *Green
-function evaluation*.
+The 3 provided POSIX shell scripts illustrate 3 main features of
+Stardis: the *probe computation*, the *visualization of thermal paths*
+and the *Green function evaluation*.
#### Geometric data and physical properties
@@ -87,7 +87,7 @@ Assuming the current shell directory is `~/Stardis-StarterPack/cube` and
that the `stardis` program is registered against the current shell, you
can run the script using the following command:
- ~/Stardis-StardisPack/cube $ bash ./run_probe_computation.sh
+ ~/Stardis-StardisPack/cube $ sh ./run_probe_computation.sh
You can also simply invoke the `stardis` program in order to compute the
temperature at the center of the cube at steady state, by using the
@@ -98,7 +98,7 @@ following command:
Please refer to the
[stardis](https://www.meso-star.com/projects/stardis/man/man1/stardis.1.html)
man page for an explanation about command-line options.
-The Bash script can be edited and modified.
+The shell script can be edited and modified.
For instance, in section `USER PARAMETERS`, the number of Monte-Carlo
samples or the value of the probe time can be changed.
