commit bf92ba4ece0d650596412579601d61e1f809a54f
parent c050b533ddc981089bbc188510b1d6678d46c01d
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 20 Nov 2018 15:05:32 +0100
First version of the HTRDR overview
Diffstat:
1 file changed, 97 insertions(+), 0 deletions(-)
diff --git a/high-tune/high-tune.html.in b/high-tune/high-tune.html.in
@@ -0,0 +1,97 @@
+<header>
+ <h1>High-Tune: RenDeRer - Image renderer of cloudy atmospheres</h1>
+</header>
+
+<div class="news">
+ <p><b>Download High-Tune: RenDeRer ${VERSION}</b></p>
+ <ul>
+ <li>GNU/Linux:
+ <a href="downloads/High-Tune-RenDeRer-${VERSION}-GNU-Linux64.tar.gz">tarball</a> /
+ <a href="downloads/High-Tune-RenDeRer-${VERSION}-GNU-Linux64.tar.gz.sig">pgp</a></li>
+ </ul>
+ <ul>
+ <li>Sources:
+ <a href="downloads/High-Tune-RenDeRer-${VERSION}-Sources.tar.gz">zip</a> /
+ <a href="downloads/High-Tune-RenDeRer-${VERSION}-Sources.tar.gz.sig">pgp</a></li>
+ </ul>
+</div>
+
+<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.
+
+<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:
+it consists in simulating a given number of optical paths originating from the
+camera, directed into the atmosphere, taking into account light absorption and
+scattering phenomena. The computation is performed over the whole visible part
+of the spectrum, for the three components of the CIE 1931 XYZ colorimetric
+space that are subsequently recombined in order to obtain the final color for
+each pixel, and finally the whole image of the scene as seen from the required
+observation position.
+
+<p>During the simulation, <code>htrdr</code> <b>dynamically loads/unloads</b>
+cloud properties and thus it can handle clouds whose data do not feat in main
+memory. Furthermore, in addition of a <b>shared memory parallelism</b>,
+<code>htrdr</code> relies on the <a href="https://www.mpi-forum.org/">Message
+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 simple interface</h2>
+
+<p><code>htrdr</code> is a <b>command-line tool</b> that performs computations
+on input data, writes the rendered image and nothing more. No assumption is
+made on how input data are created excepted that they have to follow the
+expected file formats. In the same spirit, the output image is written in plain
+text, as a list of raw pixel estimations, making easier the processing of its
+data.
+
+<p>This thin interface is, by nature, particularly well suited to be
+<b>extended</b> and <b>integrated</b> into a any workflow. For instance, one
+can save the cloud properties directly in the "High-Tune: cloud properties"
+format (<code>htcp</code>) or use the <code>les2htcp</code> tool to convert
+cloud properties from <a
+href="https://www.unidata.ucar.edu/software/netcdf/">NetCDF</a> to
+<code>htcp</code>. In the same way, the output image can be post-treated
+through <a href="www.gnuplot.com">gnuplot</a> or converted in a regular PPM
+image by the <code>htpp</code> program, and then directly visualised in an
+image viewer as for instance <a href="https://feh.finalrewind.org/">feh</a> or
+<a href="https://imagemagick.org/script/display.php">display</a>.
+
+<h2>Quick start</h2>
+
+<p>Download the desired archive of <code>htrdr</code> and verify its integrity
+against its <a href=../misc/pgp_signatures.html>PGP signature</a>. Then extract
+it. Finally source the provided <code>high_tune.profile</code> file to register
+<code>htrdr</code> against the current shell.</p>
+
+<pre class="code">
+$ source ~/High-Tune-RenDeRer-${VERSION}-GNU-Linux64/etc/high_tune.profile
+$ htrdr -h
+</pre>
+
+<p>The <b>reference documentation</b> of the <code>htrdr</code> program and
+some of its associated file formats is provided trough man pages. Use the
+<code>man</code> command-line to consult it.</p>
+
+<pre class="code">
+$ man htrdr
+$ man htrdr-image
+$ man htcp
+$ man htmie
+</pre>
+
+<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>
