commit 000be6987d49ff4e636bc5fab616a11a768899c6
parent a42d6441808810ce709563d5cafbd67dd6604956
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 6 Jan 2021 11:10:14 +0100
Cleanup Stardis and add the its Starter-Pack page
Diffstat:
14 files changed, 110 insertions(+), 108 deletions(-)
diff --git a/stardis/IGBT.png b/stardis/IGBT.png
@@ -1 +0,0 @@
-#$# git-wad 2c69cb40ba4ab4d0997c3b42f4465cc9491b3c0d488ee8ef9fcc8f3fba09e215 140140
-\ No newline at end of file
diff --git a/stardis/IR_rendering.jpg b/stardis/IR_rendering.jpg
@@ -0,0 +1 @@
+#$# git-wad 1ec3c95eef834ff5d392e7d572e42af1e70ad720b820342f4c392369740a2fbe 36425
+\ No newline at end of file
diff --git a/stardis/Makefile b/stardis/Makefile
@@ -14,15 +14,16 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
STARDIS-VERSION=0.11.0-r1
+STARDIS-STARTER-PACK-VERSION=0.0.0
-SRC = stardis.html.in green_script.js
+SRC = stardis.html.in
IMG = foam.png IGBT.png syrthes.png
.PHONY: all clean default publish
default: all
all: ${SRC}
- @bash stardis.sh ${STARDIS-VERSION}
+ @bash stardis.sh ${STARDIS-VERSION} ${STARDIS-STARTER-PACK-VERSION}
clean:
rm stardis.html
diff --git a/stardis/downloads/Stardis-Starter-Pack-0.0.0.tar.gz b/stardis/downloads/Stardis-Starter-Pack-0.0.0.tar.gz
@@ -0,0 +1 @@
+#$# git-wad 777f0b24e578fd9e1053ec86048a4816a199c24979cc4ebbe48bbf49abbd180c 943467
+\ No newline at end of file
diff --git a/stardis/foam.jpg b/stardis/foam.jpg
@@ -0,0 +1 @@
+#$# git-wad 46e13f7e67c73e2c127419203c85c5a5ed44673b46d7c5815e1c4ceb95b4c615 160863
+\ No newline at end of file
diff --git a/stardis/foam.png b/stardis/foam.png
@@ -1 +0,0 @@
-#$# git-wad e55b1199c3b694d7775ddcb1351968abb561d5d432286f86b228acf875c5886e 250278
-\ No newline at end of file
diff --git a/stardis/foam_path.jpg b/stardis/foam_path.jpg
@@ -0,0 +1 @@
+#$# git-wad 851ff8df36e26e6f0297fc531c1e0e421ff9f7b687cc3337d552689b10ce527c 116763
+\ No newline at end of file
diff --git a/stardis/green_script.js b/stardis/green_script.js
@@ -1,21 +0,0 @@
-
-function Green(Form) {
- var p = Number(document.getElementById('P').value);
- var t1 = Number(document.getElementById('T_1').value);
- var t2 = Number(document.getElementById('T_2').value);
- var res = t1*0.001700680272109 + t2*0.998299319727891
- + p*1.71947879151661;
- var sig= t1*t1*0.001700680272109 + t2*t2 * 0.998299319727891
- + p*p * 6.00196092927171
- + 2*p*t1*0.002939175670268 + 2*p*t2*1.71653961584634
- - res * res;
- var std = Math.sqrt(sig/9997);
- document.getElementById('T_res').value= res.toFixed(4);
- document.getElementById('T_res_std').value = std.toFixed(4);
- return res;
-}
-
-function ClearRes() {
- document.getElementById('T_res').value = "?" ;
- document.getElementById('T_res_std').value = "?" ;
-}
diff --git a/stardis/heatsink.jpg b/stardis/heatsink.jpg
@@ -0,0 +1 @@
+#$# git-wad e06ed62a5cb4c7119d39fb439d9efc10b380e3a7dcffa63b93158acb57f17e1c 143257
+\ No newline at end of file
diff --git a/stardis/heatsinkx50.jpg b/stardis/heatsinkx50.jpg
@@ -0,0 +1 @@
+#$# git-wad 5e6d3974a85a7b22211a3d1b136bfec2f1db9a0fd5cbeb4ae09c913c0ac932c2 362946
+\ No newline at end of file
diff --git a/stardis/overwiew.md b/stardis/overwiew.md
@@ -1,64 +0,0 @@
-# Overview
-
-Stardis designates both a thermal calculation library and a code application.
-
-The Stardis platform aims to implement in a code the know-how in terms of
-statistical formulation of coupled thermal transfer
-(conduction-radiation-convection) in complex geometries.
-
-This know-how is based both on methodological advances in terms of modeling from
-a statistical point of view and reformulation in path space of complex energy
-systems (EDStar link) and on techniques developped by the computer graphics
-community allowing to process complex geometries (link PBRT, Embree ?)
-
-Thanks to the skills of Meso-Star engineers and the close collaboration with the
-members of the EDStar group, we are now able to develop, distribute and develop
-the Stardis platform.
-
-Beyond the use of Stardis as a thermal calculation code, we address to
-researchers, engineers, teachers, students wishing to fully appropriate the
-statistical formulation of thermal, from theoretical concepts to computer
-implementation. That is why we have chosen to distribute Stardis under a free
-license which guarantees the use, study, modification and redistribution of
-codes.
-
-Meso-Star provides a wide range of technical offer like thermal study,
-consulting and participating in R&D projects.
-
-For people specifically interested in Stardis we provide a support and
-maintenance service by joining the stardis consortium.
-
-
-## Stardis-solver
-
-Stardis-solver is the library that implements Monte-Carlo algorithms. These
-statistically explore the space of thermal paths in a 3D or 2D scene.
-
-Stardis-solver don't require some 3D (or 2D) volumic meshing. The medium are
-only represented by the boundary meshing.
-
-Stardis-solver can be integrated in your own data production workflow from CAD
-to solver. You can also use the Stardis code (see below) which is our proposal to
-interfacing the Stardis-solver.
-
-### Realease notes
-
-## Stardis
-
-Stardis is a code that allows the use of Stardis-solver library. We propose a
-simple interface to load 3D scene where the medium are represented by some STL
-files.
-
-Stardis allows to affect the materials properties (thermal conductivity, density
-...) to the medium and configuring the boundary conditions.
-
-### A straight interface
-
-### Realease notes
-
-## Licence
-
-Stardis and Stardis-solver are free software released under the GPLv3+ license:
-GNU GPL version 3 or later. You can freely study, modify or extend it. You are
-also welcome to redistribute it under certain conditions; refer to the license
-for details.
diff --git a/stardis/stardis.html.in b/stardis/stardis.html.in
@@ -71,13 +71,13 @@ purposes:<p>
<li><b>Sensitivity analysis</b>: the <a href="#green">Green functions</a> of
the system (estimated and stored during an initial Monte-Carlo computation)
- can be reused for subsequent (very fast) post-processing computations.
+ can be reused for subsequent (very fast) post-processing computations.
This makes it possible to
explore the sensitivity of any given result to the variations of a boundary
or initial condition, or internal power source. This technique is only a
small part of a family of so-called "symbolic" Monte-Carlo algorithms that
make possible to achieve the same sensitivity analysis, but for any thermal
- parameter (for instance: the conductiviy of a given solid, a convective
+ parameter (for instance: the conductivity of a given solid, a convective
exchange coefficient or the emissivity of a solid).</li>
</ul>
@@ -92,8 +92,17 @@ post-processing. See below for more information on each of these components.<p>
<h2 id="solver">Stardis-Solver</h2>
+<div class="img" style="width: 18em">
+ <a href="foam_path.jpg"><img src="foam_path.jpg" alt="foam_path"></a>
+ <div class="caption">
+ Example of conductive path sampled by Stardis in a foam geometry: it starts
+ from the probe position (green point) and after several diffusive steps
+ reaches a boundary condition (red point).
+ </div>
+</div>
+
<p><a href=https://gitlab.com/meso-star/stardis-solver.git>Stardis-Solver</a>
-is the core library of Stardis: it simulates coupled convecto - conducto -
+is the core library of Stardis: it simulates coupled convecto - conducto -
radiative heat transfers by sampling thermal paths that explore space and time
until a boundary condition or an initial condition is found. Note that this
path formulation does not require <b>any volumetric mesh</b>: in addition of
@@ -139,6 +148,18 @@ on the following hypothesis:</p>
<p>The remaining of this section describes the main functionalities provided by
Stardis-Solver upon the aforementonned hypothesis.</p>
+<div class="img" style="width: 18em">
+ <a href="IR_rendering.jpg"><img src="IR_rendering.jpg" alt="IR_rendering"></a>
+ <div class="caption">
+ Infrared image of a foam geometry. This rendering was performed by
+ Stardis-Solver without the knowledge of the temperature field. The radiative
+ paths that begin at the camera will propagate alternately in conductive,
+ convective and radiative path until reaching a boundary or a limit condition.
+ We point out that this computation is provided as an example of the <a
+ href="starter-pack.html">Stardis: Starter Pack</a>.
+ </div>
+</div>
+
<h3>Probe computation</h3>
<p>Stardis-Solvers compute the temperature at any given position (spatial and
@@ -190,12 +211,15 @@ the accumulated power/flux, etc.</p>
<h2 id="cli">Stardis CLI tools</h2>
-<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>
+<p>The stardis framework includes Command Line Interface (CLI) software, namely
+<a href="man/man1/stardis.1.html">
+stardis</a> and <a
+href="man/man1/sgreen.1.html">sgreen</a>,
+to use along with Stardis-Solver. Even if these softwares are intended as
+reference implementations, they allow to easily exploit some of the
+functionalities of the solver.</p>
-<h3 id="stardis-cli">The stardis CLI </h3>
+<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
@@ -205,7 +229,7 @@ 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:
+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>
diff --git a/stardis/stardis.sh b/stardis/stardis.sh
@@ -19,8 +19,8 @@ set -e
source ../meso-menu.sh
-if [ $# -lt 1 ]; then
- echo "Usage: $0 VERSION"
+if [ $# -lt 2 ]; then
+ echo "Usage: $0 VERSION VERSION_PACK"
exit 1
fi
@@ -36,8 +36,8 @@ dir_temp=$(mktemp -d) # Working directory
# Sign the package
################################################################################
tput bold; echo ">>> Stardis packages"; tput sgr0
-archs=$(find downloads -regex "^.*/Stardis-[0-9]+\.[0-9]+\.[0-9]+-.*zip" \
- -o -regex "^.*/Stardis-[0-9]+\.[0-9]+\.[0-9]+-.*tar.gz")
+archs=$(find "./downloads" -regex "^.*/Stardis-.*[0-9]+\.[0-9]+\.[0-9]+.*tar.gz")
+
sign_something=0
for arch in $archs; do
if [ ! -f $arch.sig ]; then
@@ -60,6 +60,8 @@ cd $dir_temp
arch=Stardis-$1-GNU-Linux64
cp "$dir_curr/downloads/$arch.tar.gz" .
tar xzf $arch.tar.gz
+sdis_spk=Stardis-Starter-Pack-$2
+tar xzf $dir_curr/downloads/$sdis_spk.tar.gz $sdis_spk/README.md
cd $dir_curr
################################################################################
@@ -80,8 +82,6 @@ sgreen_release_notes=$($markdown $arch/share/doc/sgreen/README.md \
| sed '/^<h2>License<\/h2>/,$d')
cd $dir_curr
-
-
################################################################################
# Generate the overview page
################################################################################
@@ -121,6 +121,62 @@ echo "Write stardis-downloads.html"
} > stardis-downloads.html;
################################################################################
+# Generate the starter pack
+################################################################################
+echo "Write starter-pack.html"
+
+$markdown $dir_temp/$sdis_spk/README.md \
+ | sed 's/<pre><code>/<pre class=code>/g' \
+ | sed 's/<\/code><\/pre>/\<\/pre\>/g' \
+ > $dir_temp/$sdis_spk/README.html
+
+intro=$(cat $dir_temp/$sdis_spk/README.html \
+ | sed 1d \
+ | sed '/^<h2>Content<\/h2>/,$d')
+
+content=$(cat $dir_temp/$sdis_spk/README.html \
+ | sed '/^<h2>Content<\/h2>/,$!d' \
+ | sed 1d \
+ | sed '/^<h2>Copyright notice<\/h2>/,$d')
+
+license=$(cat $dir_temp/$sdis_spk/README.html \
+ | sed '/^<h2>Copyright notice<\/h2>/,$!d' \
+ | sed 's/opyright (C)/opyright \©/g')
+
+{
+ print_header Stardis Starter-Pack
+
+ echo "<header>"
+ echo " <h1>Stardis: Starter Pack</h1>"
+ echo "</header>"
+ echo "<div class="news">"
+ echo " <p><b>Stardis: Starter Pack $2</b></p>"
+ echo " <ul>"
+ echo " <li><a href=\"downloads/Stardis-Starter-Pack-$2.tar.gz\">tarball</a> /"
+ echo " <a href=\"downloads/Stardis-Starter-Pack-$2.tar.gz.sig\">pgp</a></li>"
+ echo " </ul>"
+ echo "</div>"
+
+ echo "$intro"
+
+ echo "<h2>Content</h2>"
+ echo "<div class=\"img\" style=\"padding-top:3em; width: 17em\">"
+ echo " <a href=\"heatsink.jpg\"><img src=\"heatsink.jpg\" alt=\"heatsink\"></a>"
+ echo " <a href=\"heatsinkx50.jpg\"><img src=\"heatsinkx50.jpg\" alt=\"heatsinkx50\"></a>"
+ echo " <a href=\"foam.jpg\"><img src=\"foam.jpg\" alt=\"foam\"></a>"
+ echo " <div class=\"caption\">"
+ echo " Geometries of the heatsink, the multiple heatsinks and the foam"
+ echo " provided by the Starter Pack and used in its examples."
+ echo " </div>"
+ echo "</div>"
+
+ echo "$content"
+ echo "$license"
+
+ print_footer
+} > starter-pack.html
+
+################################################################################
# Generate the reference documentation
################################################################################
for((i=0; i<${#stardis_man_pages[@]}; ++i)); do
diff --git a/stardis/syrthes.png b/stardis/syrthes.png
@@ -1 +0,0 @@
-#$# git-wad 182335e0acb1d96f362b54921b9ae7a617540c6cc66f6803c394b4f72d8ec33b 122112
-\ No newline at end of file