commit 9d5414b4ba1c7bcd97b483be175ea620059330f7
parent 03b1dbbec7441b21f3d197ed7cc17b52bad1efb3
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 28 Nov 2018 11:58:49 +0100
Add the High-Tune: Starter Pack web page
Diffstat:
6 files changed, 144 insertions(+), 21 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ schiff.html
stardis.html
about.html
high-tune.html
+starter-pack.html
pgp_signatures.html
solstice.html
solstice-downloads.html
diff --git a/high-tune/Makefile b/high-tune/Makefile
@@ -14,6 +14,7 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
HTRDR-VERSION=0.0.0
+HTRDR-STARTER-PACK-VERSION=0.0.0
SRC = high-tune.html.in high-tune.sh
IMG = DZVAR.png
@@ -22,7 +23,7 @@ IMG = DZVAR.png
default: all
all: ${SRC}
- @sh high-tune.sh ${HTRDR-VERSION}
+ @sh high-tune.sh ${HTRDR-VERSION} ${HTRDR-STARTER-PACK-VERSION}
publish:
rsync -avzr high-tune.html ${IMG} downloads man ${REMOTE}/high-tune/
diff --git a/high-tune/high-tune.html.in b/high-tune/high-tune.html.in
@@ -16,14 +16,14 @@
<p>High Tune: RenDeRer (<code>htrdr</code>) is a part of the <a
href=http://www.umr-cnrm.fr/high-tune/>High-Tune</a> project: it illustrates
-the implementation of efficient <b>radiative transfer</b> algorithms in
-<b>inhomogeneous media</b>. It is actually an <b>image renderer</b> in the
-visible part of the spectrum, for scenes composed of an atmospheric gas
-mixture, clouds and a ground. It uses spectral data that should be provided for
-the pressure and temperature atmospheric vertical profile, the liquid water
-content in suspension within the clouds that is a result of Large Eddy
-Simulation computations, and the optical properties of water droplets that have
-been obtained from a Mie code.
+the implementation of <b>radiative transfer</b> algorithms in <b>inhomogeneous
+media</b>. It is actually an <b>image renderer</b> in the visible part of the
+spectrum, for scenes composed of an atmospheric gas mixture, clouds and a
+ground. It uses spectral data that should be provided for the pressure and
+temperature atmospheric vertical profile, the liquid water content in
+suspension within the clouds that is a result of Large Eddy Simulation
+computations, and the optical properties of water droplets that have been
+obtained from a Mie code.
<p><code>htrdr</code> evaluates the intensity incoming on each pixel of the
sensor array. The underlying algorithm is based on a <b>Monte-Carlo</b> method:
@@ -43,12 +43,12 @@ Passing Interface</a> specification to parallelise its computations in a
<b>distribute memory</b> environment; the <code>htrdr</code> binary can thus be
run either directly or through a MPI process launcher like <code>mpirun</code>.
-<h2>A straight interface</h2>
+<h2> A straight interface</h3>
<div class="img" style="width: 16em">
<a href="DZVAR.png">
<img src="DZVAR.png" alt="Repeated clouds">
- </a>
+ </A>
<div class="caption">
Example of a cloudy scene rendered with <code>htrdr</code>
</div>
@@ -99,7 +99,9 @@ $ man htmie
<h2>License</h2>
-<p><code>htrdr</code> is free software released under the GPLv3+ license: GNU
-GPL version 3 or later. You are welcome to redistribute it under certain
-conditions; refer to the
-<a href="https://www.gnu.org/licenses/gpl.html">license</a> for details.</p>
+<p><code>htrdr</code> is <b>free software</b> released under the GPLv3+
+license: GNU GPL version 3 or later. You can freely study, modify or extend
+them. You are also welcome to redistribute them under certain conditions; refer
+to the <a href="https://www.gnu.org/licenses/gpl.html">license</a> for
+details.</p>
+
diff --git a/high-tune/high-tune.sh b/high-tune/high-tune.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
@@ -64,6 +64,13 @@ echo "Write high-tune.html"
print_footer
} > high-tune.html
+echo "Write starter-pack.html"
+{
+ print_header High-Tune Starter-Pack
+ VERSION_PACK=$2 envsubst < starter-pack.html.in;
+ print_footer
+} > starter-pack.html
+
################################################################################
# Generate the reference documentation
################################################################################
diff --git a/high-tune/starter-pack.html.in b/high-tune/starter-pack.html.in
@@ -0,0 +1,107 @@
+<header>
+ <h1>High-Tune: Starter Pack</h1>
+</header>
+
+<div class="news">
+ <p><b>High-Tune: Starter Pack ${VERSION_PACK}</b></p>
+ <ul>
+ <li><a href="downloads/High-Tune-Starter-Pack-${VERSION_PACK}.tar.gz">tarball</a> /
+ <a href="downloads/High-Tune-Starter-Pack-${VERSION_PACK}.tar.gz.sig">pgp</a></li>
+ </ul>
+</div>
+
+<p>The High-Tune: Starter Pack contains <b>input data</b> necessary to perform
+renderings with <code>htrdr</code>. It also provides <b>bash scripts</b> that
+make easier the invocation of the <code>htrdr</code> program and the
+description of the scene to render.
+
+<h2>Content</h2>
+
+<h3>Atmospheric profile</h3>
+
+<p>The <code>ecrad_opt_prop.txt</code> file defines the gas optical properties
+provided for the pressure and temperature atmospheric vertical profile. These
+data were generated with the <a
+href="https://www.ecmwf.int/en/elibrary/16901-ecrad-new-radiation-scheme-ifs">ECRAD</a>
+software and are saved according to the High-Tune: Gas Optical Properties file
+format.
+
+<h3>Clouds</h3>
+
+<p>The files contained in the <code>clouds</code> subdirectory store the liquid
+water content in suspension within clouds that is a result of <b>Large Eddy
+Simulations</b> performed with the <a
+href="http://mesonh.aero.obs-mip.fr/mesonh54">Meso-NH</a> model. The data are
+formatted according to the <a href="man/man5/htcp.5.html">High-Tune: Cloud
+Properties</a> file format. Available files are:
+
+<ul>
+ <li><code>DZVAR.1.ARMCU.008.diaKCL.htcp</code></li>
+ <li><code>L25.1.FIRE.012.htcp</code></li>
+ <li><code>L12km.1.BOMEX.005</code></li>
+</ul>
+
+<h3>Water droplets properties</h3>
+
+<p>The <code>Mie_LUT_Cloud.nc</code> file stores the optical properties of water
+droplets obtained from a <b>Mie code</b>. This NetCDF file is formatted according to
+the <a href="man/man5/htmie.5.html">High-Tune: Mie</a> file format.
+
+<h3>Ground geometries</h3>
+
+<p>The <code>models</code> subdirectory contains ground geometries saved in the
+<a href="http://www.martinreddy.net/gfx/3d/OBJ.spec">OBJ</a> file format.
+Available geometries are:
+
+<ul>
+ <li><code>models/plane.obj</code>: quad centered in 0 whose size along the X
+ and Y dimension is 10 meters.</li>
+ <li><code>models/mountain.obj</code>: geometry representing mountains. The OBJ
+ lower bound is 0 while its upper bound is [10000, 10000, 700] which means
+ that its size along the X and Y axis is 10 kilometers while the highest
+ mountain peaks at 700 meters. Note that the geometry is carefully designed to
+ be <b>cyclic</b>: it can be repeated along the X and Y axis without visual
+ glitches.</li>
+</ul>
+
+<h3>Scene description</h3>
+
+<p>The <code>scenes</code> subdirectory stores bash scripts describing scenes
+from the aforementioned data (atmosphere, clouds, <i>etc.</i>) and how to
+render them (image definition, point of view, <i>etc.</i>). These files are
+actually input files for the <code>ht-run.sh</code> script.
+
+<h3>Run script</h3>
+
+<p>The <code>ht-run.sh</code> bash script builds and runs a <code>htrdr</code>
+command line from a scene file submitted as input.
+
+<h2>Install and run</h2>
+
+<p>Download the High-Tune: Starter-Pack archive and verify its integrity
+against its <a href="../misc/pgp_signatures.html">PGP signature</a>. Then
+extract it. Assuming that <code>htrdr</code> is installed and registered in the
+current shell, one can invoke a <code>htrdr</code> rendering as bellow:
+
+<pre class="code">
+$ cd ~/High-Tune-Starter-Pack-${VERSION_PACK}
+High-Tune-Starter-Pack-${VERSION_PACK} $ bash ht-run.sh scenes/DZVAR2
+</pre>
+
+<p>With <code>~/High-Tune-Starter-Pack-${VERSION_PACK}</code> the directory
+where the Starter Pack is installed. The resulting image
+<code>DZVAR2_1280x720x128.txt</code> is stored in the <a
+href="man/man5/htrdr-image.5.html">htrdr-image</a> file format. Use the <a
+href="man/man1/htpp.1.html">htpp</a> program to convert it in a regular PPM
+file that can be then displayed with a regular image viewer.
+
+<pre class="code">
+High-Tune-Starter-Pack-${VERSION_PACK} $ htpp -o DZVAR2.ppm DZVAR2_1280x720x128.txt
+</pre>
+
+<h2>License</h2>
+High-Tune: Starter Pack is released under the GPLv3+ license: GNU GPL version 3
+or later. You can freely study, modify or extend them. You are also welcome to
+redistribute them under certain conditions; refer to the <a
+href="https://www.gnu.org/licenses/gpl.html">license</a> for details.</p>
+
diff --git a/meso-menu.sh b/meso-menu.sh
@@ -63,10 +63,15 @@ print_high_tune_sub_menu() {
done
echo ' </ul>'
echo ' <ul>'
+ if [ "$name" == "Starter-Pack" ]; then
+ echo " <li id=cur>Starter Pack</li>"
+ else
+ echo " <li><a href=${root}high-tune/starter-pack.html>Starter Pack</a></li>"
+ fi
echo " <li><a href=https://gitlab.com/meso-star/htrdr>Source code repository</a></li>"
echo ' </ul>'
echo ' <div id="info">'
- echo ' <p>High-Tune copyright © 2018'
+ echo ' <p>Copyright © 2018'
echo ' <a href="https://www.meso-star.com">|Méso|Star></a>,'
echo ' National Center for Scientific Research (CNRS),'
echo ' Université Paul Sabatier.'
@@ -106,7 +111,7 @@ print_schiff_sub_menu() {
echo ' <div id="info">'
echo ' <p>Schiff is developped by <a'
echo ' href="https://www.meso-star.com">|Méso|Star></a> for the'
- echo ' National Center for Scientific Research. It is copyright ©'
+ echo ' National Center for Scientific Research. Copyright ©'
echo ' 2016-2017 <a href="http://www.cnrs.fr/index.php">CNRS</a>.</p>'
echo ' </div>'
echo ' </div>'
@@ -156,7 +161,7 @@ print_solstice_sub_menu() {
echo ' the <a href="https://www.labex-solstice.fr">LABoratory of'
echo ' EXcellence Solstice</a> (LABEX) and the <a'
echo ' href="http://www.promes.cnrs.fr/index.php?page=home-en">PROMES</a>'
- echo ' laboratory of the National Center for Scientific Research. It is copyright'
+ echo ' laboratory of the National Center for Scientific Research. Copyright'
echo ' © 2016-2018 <a href="http://www.cnrs.fr/index.php">CNRS</a>.</p>'
echo ' <p>Visit the <a href="https://www.labex-solstice.fr/solstice-software">'
echo ' LABEX Solstice web page</a> for complementary informations and examples.</p>'
@@ -184,7 +189,7 @@ print_star_engine_sub_menu() {
echo " <li><a href=https://gitlab.com/meso-star/star-engine>Repository</a></li>"
echo ' </ul>'
echo ' <div id="info">'
- echo ' <p>Star-Engine is copyright © 2015-2018 <a'
+ echo ' <p>Copyright © 2015-2018 <a'
echo ' href="https://www.meso-star.com">|Méso|Star></a></p>'
echo ' </div>'
echo ' </div>'
