commit 5b0430b6f0319e8e3634bedb815a6f5737c76b93
parent 66ef44906c05c0dca5de1c268572a6092141a82f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 3 Dec 2018 15:13:26 +0100
Remove the binary package the High-Tune
Diffstat:
4 files changed, 66 insertions(+), 37 deletions(-)
diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-REMOTE=OVH:www/projects2
+REMOTE=OVH:www/projects
REMOTE_DIR=/$(shell basename ${REMOTE})
SUBDIRS=schiff solstice star-engine stardis kspectrum misc high-tune
diff --git a/high-tune/high-tune.html.in b/high-tune/high-tune.html.in
@@ -2,17 +2,17 @@
<h1>HTRDR - Image renderer of cloudy atmospheres</h1>
</header>
-<div class="news">
+<!--div class="news">
<p><b>High-Tune: RenDeRer ${VERSION}</b></p>
<ul>
- <li>GNU/Linux:
+ <li>Gitlab
<a href="downloads/High-Tune-${VERSION}-GNU-Linux64.tar.gz">tarball</a> /
<a href="downloads/High-Tune-${VERSION}-GNU-Linux64.tar.gz.sig">pgp</a></li>
<li>Sources:
<a href="downloads/High-Tune-${VERSION}-Sources.tar.gz">tarball</a> /
<a href="downloads/High-Tune-${VERSION}-Sources.tar.gz.sig">pgp</a></li>
</ul>
-</div>
+</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
@@ -76,52 +76,79 @@ 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>
+<p>No pre-compiled version of <code>htrdr</code> is provided; you have to
+compile it directly from its source tree. To do so, one can rely on the
+<code>high_tune</code> branch of the <a
+href="https://gitlab.com/meso-star/star-engine/tree/high_tune">Star-Engine
+project</a>: it provides CMake scripts that automates the download, the
+compilation and the installation of <code>htrdr</code> and its dependencies.
+This build procedure assumes the following prerequisites:
+
+<ul>
+ <li><a href=https://git-scm.com>git</a> source control as well its <a
+ href=https://git-lfs.github.com>Large File System</a> extension.</li>
+ <li><a href=https://gcc.gnu.org>GNU Compiler Collection</a> in version 4.8 or
+ higher.</li>
+ <li><a href⁼https://cmake.org>CMake</a> in version 3 or higher.</li>
+ <li><a href=https://www.unidata.ucar.edu/software/netcdf/>NetCDF</a> library
+ and headers in version 4 or higher.</li>
+ <li><a href=https://www.open-mpi.org/>OpenMPI</a> library and headers.</li>
+ <li>Optionally, the <a href=http://www.methods.co.nz/asciidoc/>AsciiDoc</a>
+ tool suite to generate the man pages of the reference documentation.</li>
+</ul>
+
+<h3>Build</h3>
+
+<p>Assuming that the aforementioned prerequisites are available, the build
+procedure is summed up to:
<pre class="code">
-$ source ~/High-Tune-${VERSION}-GNU-Linux64/etc/high_tune.profile
-$ htrdr -h
+~ $ git clone -b high_tune \
+ https://gitlab.com/meso-star/star-engine.git High-Tune-${VERSION}
+~ $ mkdir High-Tune-${VERSION}/build; cd High-Tune-${VERSION}/build
+~/High-Tune-${VERSION}/build $ cmake ../cmake
+~/High-Tune-${VERSION}/build $ make
</pre>
-<p>The <b>reference documentation</b> of the <code>htrdr</code> program and its
-associated file formats is provided trough man pages. Use the <code>man</code>
-command-line to consult it.</p>
+<h3>Package</h3>
+
+<p>Once built, you can package <code>htrdr</code> in an archive that can be
+deployed on compatible systems, <i>i.e.</i> systems whose C library, NetCDF
+library and MPI implementation are compatible with the system used to build
+<code>htrdr</code>.
<pre class="code">
-$ man htrdr
-$ man htrdr-image
-$ man htcp
-$ man htmie
+~/High-Tune-${VERSION}/build $ make pkg
+~/High-Tune-${VERSION}/build $ ls _Pkg/High-Tune-${VERSION}* # list generated archives
</pre>
+
+<h3>Run</h3>
-<p>Refer to the <a href=starter-pack.html>High-Tune: Starter Pack</a> to
-quickly run a <code>htrdr</code> rendering; this archive provides input data
-and scripts that are good starting points to use <code>htrdr</code>.
-
-<h3>Troubleshooting</h3>
-
-<p>The provided precompiled archive is built with libraries that might be
-incompatible with the ones available on your system. Typical symptoms are error
-messages displayed on invocation of the <code>htrdr</code> program such as:
+By default <code>htrdr</code> is installed in the <code>local</code>
+subdirectory of <code>High-Tune-${VERSION}</code>. Source the provided
+<code>high_tune.profile</code> file to register <code>htrdr</code> against the
+current shell.
<pre class="code">
-htrdr: /lib/libc.so.6: version GLIBC_2.27 not found (required by htrdr)
+~ $ source ~/High-Tune-${VERSION}/etc/high_tune.profile
+~ $ htrdr -h
</pre>
-<p>or
+<p>If the AsciiDoc tool suite was installed on <code>make</code>
+invocation, the <b>reference documentation</b> of the <code>htrdr</code>
+program and its associated file formats should be available through man pages.
+Use the <code>man</code> command-line to consult them.</p>
<pre class="code">
-htrdr: error while loading shared libraries: libmpi.so.20: ...
+~ $ man htrdr
+~ $ man htrdr-image
+~ $ man htcp
+~ $ man htmie
</pre>
-<p>As a workaround, you can build <code>htrdr</code> and its dependencies on
-your system, directly from its source tree. Refer to the <a
-href="https://gitlab.com/meso-star/star-engine/tree/high_tune">High-Tune
-branch</a> of the Star-Engine repository for more informations on how to
-download, compile and install <code>htrdr</code>.
+<p>Refer to the <a href=starter-pack.html>High-Tune: Starter Pack</a> to
+quickly run a <code>htrdr</code> rendering; this archive provides input data
+and scripts that are good starting points to use <code>htrdr</code>.
<h2>License</h2>
diff --git a/meso-menu.sh b/meso-menu.sh
@@ -69,7 +69,7 @@ print_high_tune_sub_menu() {
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/star-engine/tree/high_tune>Source code repository</a></li>"
+ echo " <li><a href=https://gitlab.com/meso-star/htrdr>Source code repository</a></li>"
echo ' </ul>'
echo ' <div id="info">'
echo ' <p>Copyright © 2018'
@@ -180,12 +180,12 @@ print_star_engine_sub_menu() {
if [ "$name" == "Overview" ]; then
echo ' <li id=cur>Overview</li>'
else
- echo " <li><a href=${root}/star-engine/star-engine.html>Overview</a></li>"
+ echo " <li><a href=${root}star-engine/star-engine.html>Overview</a></li>"
fi
if [ "$name" == "Downloads" ]; then
echo ' <li id=cur>Downloads</li>'
else
- echo " <li><a href=${root}/star-engine/star-engine-downloads.html>Downloads</a></li>"
+ echo " <li><a href=${root}star-engine/star-engine-downloads.html>Downloads</a></li>"
fi
echo " <li><a href=https://gitlab.com/meso-star/star-engine>Repository</a></li>"
echo ' </ul>'
diff --git a/star-engine/star-engine.html.in b/star-engine/star-engine.html.in
@@ -95,6 +95,8 @@ solvers for a wide range of purposes. Refer to the their associated
documentation for more informations.</p>
<ul>
+ <li><a href="../high-tune/high-tune.html">High-Tune: Renderer</a>: image
+ renderer of cloudy atmospheres</li>
<li><a href="../schiff/schiff.html">Schiff</a>: computes the radiative properties of
soft particles,</li>
<li><a href="../solstice/solstice.html">Solstice</a>: simulates concentrated solar
