commit cc61e667ebd03116a90c8e09fb385d247d00e9bc
parent feb1d2707285be017aa861790a5ef07ee2e7e4ec
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 18 Aug 2025 17:35:16 +0200
ART: finalize the markdown translation
Diffstat:
10 files changed, 361 insertions(+), 399 deletions(-)
diff --git a/art/Makefile b/art/Makefile
@@ -89,15 +89,15 @@ hr_ppart.html: hr_ppart.md art_build.sh $(HR_PPART_IMG)
@echo "Building $@"
@$(SHELL) art_build.sh hr_ppart > $@
-ppart_lw.html: ppart_lw.html.in Tb.svg art_build.sh
+ppart_lw.html: ppart_lw.md Tb.svg art_build.sh
@echo "Building $@"
@$(SHELL) art_build.sh ppart_lw > $@
-ppart_sw.html: ppart_sw.html.in si_flux.svg art_build.sh
+ppart_sw.html: ppart_sw.md si_flux.svg art_build.sh
@echo "Building $@"
@$(SHELL) art_build.sh ppart_sw > $@
-karine.html: karine.html.in art_build.sh Makefile $(KARINE_IMG)
+karine.html: karine.md art_build.sh Makefile $(KARINE_IMG)
@echo "Building $@"
@$(SHELL) art_build.sh karine $(KARINE_VERSION) > $@
diff --git a/art/art_build.sh b/art/art_build.sh
@@ -58,14 +58,14 @@ hr_ppart()
ppart_lw()
{
print_header -s ART -n PPart_LW -r ../
- cat ppart_lw.html.in
+ md2html ppart_lw.md
print_footer
}
ppart_sw()
{
print_header -s ART -n PPart_SW -r ../
- cat ppart_sw.html.in
+ md2html ppart_sw.md
print_footer
}
@@ -77,7 +77,7 @@ karine()
fi
print_header -s ART -n Karine -r ../
- VERSION="$1" envsubst < karine.html.in
+ sed "s/@VERSION@/$1/g" karine.md | md2html
print_footer
}
diff --git a/art/hr_ppart.md b/art/hr_ppart.md
@@ -46,6 +46,8 @@ recompile from scratch only (when include files are modified).
If only source files are modified, the `make all` command will recompile
modified files.
+### Run
+
HR\_PPart has been parallelized, which means you will have to launch it
using the "mpirun" command:
diff --git a/art/karine.html.in b/art/karine.html.in
@@ -1,129 +0,0 @@
-<header>
- <h1>Karine
- <span class=subtitle>
- K-distribution Atmospheric Radiation & Infrared Net Exchanges
- </span>
- </h1>
-</header>
-
-<div class="news">
- <p><b>Download Karine ${VERSION}</b></p>
- <ul>
- <li>Sources:
- <a href="downloads/karine${VERSION}.tgz">tarball</a> /
- <a href="downloads/karine${VERSION}.tgz.sig">pgp</a></li>
- <li>Manual:
- <a href="downloads/karine${VERSION}_manual.pdf">pdf</a></li>
- </ul>
-</div>
-
-<p>This code performs radiative transfer computations in the LW spectral
-region, for a absorbing, emitting and scattering atmosphere. karine uses the
-k-distribution spectral model (and the CK hypothesis for inhomogeneities).
-Radiative transfer results that are computed are: fluxes (upward, downward,
-net), the radiative budget (average per layer) and its gas-gas, gas-ground and
-gas-space components, and the Net Exchange Rate matrix. All results are
-provided for each spectral interval the input data is defined for, and is also
-spectrally integrated.</p>
-
-<h3>Physical model</h3>
-
-<p>The inhomogeneous atmosphere is represented as a succession of homogeneous
-slabs. The temperature profile is taken as linear between layers centres. In
-each layer, absorption and scattering properties must be provided for the gas
-mixture (k-distribution data set), for a water cloud, and for aerosols.
-Reflection by the ground is taken into account.</p>
-
-<h3>Numerical method</h3>
-
-<p>Karine is based on a Monte-Carlo algorithm. In addition to the possibility
-to take into account scattering, this method has the advantage to compute a
-statistical uncertainty over each result; this uncertainty can be interpreted
-in terms of a numerical error. In this respect, the Monte-Carlo method is
-considered as a reference method: the numerical uncertainty can be lowered as
-much as necessary by increasing the number of realisations.</p>
-
-<h3>Net Exchange Formalism</h3>
-
-<p>The Monte-Carlo algorithm consists in computing the Net Exchange Rate
-between each couple (i,j) of atmospheric layers (+ ground and space). See
-figures for examples. This formalism provides a graphical representation of all
-radiative net exchanges in the atmospheres: dominant and non-dominant terms can
-be immediately identified, for any given spectral interval.</p>
-
-<div style="display: inline-block;">
- <div style="float: left; width: 16em">
- <a href="pne_mls_cs.svg"><img src="pne_mls_cs.svg" alt="pne_mls_cs"></a>
- </div>
- <div style="float: left; width: 16em">
- <a href="pne_mls_ac.svg"><img src="pne_mls_ac.svg" alt="pne_mls_ac"></a>
- </div>
- <div style="float: left; width: 16em">
- <a href="venus_ner.svg"><img src="venus_ner.svg" alt="venus_ner"></a>
- </div>
-</div>
-
-<div style="display: inline-block;">
- <div style="float: left; width: 16em">
- <div class="caption">
- Matrix of Net Exchange Rates, spectrally integrated over the LW interval
- (4-100 micrometers) for a standard clear-sky Mid-Latitude Summer
- atmospheric profile.
- </div>
- </div>
- <div style="float: left; width: 16em">
- <div class="caption">
- Matrix of Net Exchange Rates, spectrally integrated over the LW interval
- (4-100 micrometers) for a standard Mid-Latitude Summer atmospheric profile,
- in the presence of three water clouds.
- </div>
- </div>
- <div style="float: left; width: 16em">
- <div class="caption">
- Matrix of Net Exchange Rates, spectrally integrated over the LW interval
- (1.71-250 micrometers) for the Venus atmosphere.
- </div>
- </div>
-</div>
-
-<h2>Installation</h2>
-
-<b>Prerequisites</b>: a fortran compiler (no external libraries are needed). It
-should work fine with common compilers (gfortran, ifort, pgfortran,
-<i>etc.</i>).
-
-<p>Download and uncompress the <code>.tgz</code> archive. Then you can try to
-compile the <code>karine</code> executable: go to the main karine directory,
-then use the <code>make all</code> command to compile. The most common sources
-of failure can be fixed by editing the <code>Makefile</code> file in order to
-check compilation options (and more specifically options related to the target
-architecture and optimisations). Whenever you modify a source file, you can
-re-compile using the <code>make all</code> command. But in the case you have to
-modify a include file, you will have to erase all existing object files first
-using the <code>make clean</code> command, before recompiling from scratch
-using the <code>make all</code> command again.</p>
-
-<h2>Usage</h2>
-
-<p>Please refer to the documentation in order to produce the
-<code>/data/atmos_data.txt</code> input data file required by karine. A example
-program (<code>make_data</code>) is provided in the <code>/data</code>
-directory: use the <code>f0</code> script in order to compile it, but this
-program will only produce a dummy data set (not a physical configuration). The
-user has the possibility to set many options and input data by editing the
-<code>options.in</code> and <code>data.in</code> input data files. Please refer
-to the documentation for a description of the content of these files.</p>
-
-<h2>License</h2>
-
-<p>Copyright © 2014-2018 <a
-href="mailto:contact@meso-star.com">|Méso|Star></a>.<br>
-Copyright © 2008-2014 Centre National de la Recherche Scientifique
-(CNRS), Institut Mines-Télécom Albi-Carmaux, Université Paul Sabatier.</p>
-
-<p>Karine is free software released under the GPLv2+ license: GNU GPL version 2
-or later. x You can freely study, modify or extend it. You are also welcome to
-redistribute it under certain conditions; refer to the <a
-href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">license</a>
-for details.</p>
-
diff --git a/art/karine.md b/art/karine.md
@@ -0,0 +1,118 @@
+# Karine
+
+This code performs radiative transfer computations in the LW spectral
+region, for a absorbing, emitting and scattering atmosphere.
+`karine` uses the k-distribution spectral model (and the CK hypothesis
+for inhomogeneities).
+Radiative transfer results that are computed are: fluxes (upward,
+downward, net), the radiative budget (average per layer) and its
+gas-gas, gas-ground and gas-space components, and the Net Exchange Rate
+matrix.
+All results are provided for each spectral interval the input data is
+defined for, and is also spectrally integrated.
+
+## Physical model
+
+The inhomogeneous atmosphere is represented as a succession of
+homogeneous slabs.
+The temperature profile is taken as linear between layers centres.
+In each layer, absorption and scattering properties must be provided for
+the gas mixture (k-distribution data set), for a water cloud, and for
+aerosols.
+Reflection by the ground is taken into account.
+
+## Numerical method
+
+Karine is based on a Monte-Carlo algorithm.
+In addition to the possibility to take into account scattering, this
+method has the advantage to compute a statistical uncertainty over each
+result; this uncertainty can be interpreted in terms of a numerical
+error.
+In this respect, the Monte-Carlo method is considered as a reference
+method: the numerical uncertainty can be lowered as much as necessary by
+increasing the number of realisations.
+
+## Net Exchange Formalism
+
+The Monte-Carlo algorithm consists in computing the Net Exchange Rate
+between each couple (i,j) of atmospheric layers (+ ground and space).
+See figures for examples.
+This formalism provides a graphical representation of all radiative net
+exchanges in the atmospheres: dominant and non-dominant terms can be
+immediately identified, for any given spectral interval.
+
+[](pne_mls_cs.svg)
+
+> Matrix of Net Exchange Rates, spectrally integrated over the LW
+> interval (4-100 micrometers) for a standard clear-sky Mid-Latitude
+> Summer atmospheric profile.
+
+
+[](pne_mls_ac.svg)
+
+> Matrix of Net Exchange Rates, spectrally integrated over the LW
+> interval (4-100 micrometers) for a standard Mid-Latitude Summer
+> atmospheric profile, in the presence of three water clouds.
+
+[](venus_ner.svg)
+
+> Matrix of Net Exchange Rates, spectrally integrated over the LW
+> interval (1.71-250 micrometers) for the Venus atmosphere.
+
+## Quick start
+
+Karine @VERSION@:
+
+- Sources: [tarball](downloads/karine@VERSION@.tgz) /
+ [pgp](downloads/karine@VERSION@.tgz.sig)
+- Manual: [pdf](downloads/karine@VERSION@_manual.pdf)
+
+### Prerequisites
+
+Only a fortran compiler is needed (no external libraries).
+The `gfortran` compiler has been used for development.
+
+
+### Installation
+
+Download and uncompress the `.tgz` archive.
+Then you can try to compile the `karine` executable: go to the main
+karine directory, then use the `make all` command to compile.
+The most common sources of failure can be fixed by editing the
+`Makefile` file in order to check compilation options (and more
+specifically options related to the target architecture and
+optimisations).
+Whenever you modify a source file, you can re-compile using the `make
+all` command.
+But in the case you have to modify a include file, you will have to
+erase all existing object files first using the `make clean` command,
+before recompiling from scratch using the `make all` command again.
+
+## Usage
+
+Please refer to the documentation in order to produce the
+`/data/atmos_data.txt` input data file required by karine.
+A example program (`make_data`) is provided in the `/data` directory:
+use the `f0` script in order to compile it, but this program will only
+produce a dummy data set (not a physical configuration).
+The user has the possibility to set many options and input data by
+editing the `options.in` and `data.in` input data files.
+Please refer to the documentation for a description of the content of
+these files.
+
+## License
+
+Copyright © 2014-2018 |Méso|Star>
+([contact@meso-star.com](mailto:contact@meso-star.com))
+Copyright © 2008-2014 Centre National de la Recherche Scientifique (CNRS)
+Copyright © 2008-2014 Institut Mines-Télécom Albi-Carmaux
+Copyright © 2008-2014 Université Paul Sabatier
+
+
+Karine is free software released under the GPLv2+ license: GNU GPL
+version 2 or later.
+You can freely study, modify or extend it. You are also welcome to
+redistribute it under certain conditions;
+refer to the
+[license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) for
+details.
diff --git a/art/kspectrum.md b/art/kspectrum.md
@@ -107,6 +107,8 @@ Also, the code has been implemented with the obsessions of:
## Quickstart
+Kspectrum @VERSION@:
+
- Sources: [tarball](downloads/kspectrum@VERSION@.tgz) /
[pgp](downloads/kspectrum@VERSION@.tgz.sig)
- Installation script: [bash](downloads/install_kspectrum@VERSION@.bash)
diff --git a/art/ppart_lw.html.in b/art/ppart_lw.html.in
@@ -1,134 +0,0 @@
-<header>
- <h1>PPart LW
- <span class=subtitle>
- Plane-Parallel atmospheric radiative transfer - LongWave
- </span>
- </h1>
-</header>
-
-<div class="news">
- <p><b>Download PPart_LW</b></p>
- <ul>
- <li>Sources:
- <a href="downloads/ppart_lw.tgz">tarball</a> /
- <a href="downloads/ppart_lw.tgz.sig">pgp</a></li>
- </ul>
-</div>
-
-<p>The purpose of PPart_LW is to perform radiative transfer computations using
-k-distribution data sets (that can be produced by <a
-href="kdistribution.html">Kdistribution</a>, or any other code). This code is
-based on analytic radiative transfer solutions that are valid only in the case
-of a emitting and absorbing, but non-scattering, atmosphere. This code should
-therefore be used, in the case of the terrestrial atmosphere, for clear-sky LW
-computations only.</p>
-
-<h2>Installation</h2>
-
-<div class="img" style="width: 20em">
- <a href="Tb.svg">
- <img src="Tb.svg" alt="Tb">
- </a>
- <div class="caption">
- Brightness temperature in the [4-20] micrometers range, for a Mid-Latitude
- Summer standard atmospheric profile.
- </div>
-</div>
-
-<p>Download and extract the archive (<code>tar -zxvf ppart_lw.tgz</code>); then
-move into the <code>PPart_LW</code> directory, and use the <code>make
-all</code> command to compile. You should use the <code>make clean</code>
-command in the case you want to recompile from scratch only (when include files
-are modified). If only source files are modified, the <code>make all</code>
-command will recompile modified files.</p>
-
-<p>PPart_LW has been parallelized, which means you will have to launch it using
-the <code>mpirun</code> command:</p>
-
-<pre class=code>
-mpirun -np <NPROCS> ./PPart.exe
-</pre>
-
-<p>with <code><NPROCS></code> the number of processes requested for the
-computation; MacOS users might encounter a error where the OS considers the
-user requested a number of processes higher than recommended. You can bypass it
-using the <code>-oversubscribe</code> option:</p>
-
-<pre class=code>
-mpirun -oversubscribe -np <NPROCS> ./PPart.exe
-</pre>
-
-<p><b>Prerequistes</b>: only a fortran compiler is needed (no external
-libraries). the gfortran compiler has been used for development, but other
-common compilers should work too (ifort, pgfortran, <i>etc.</i>)</p>
-
-<h2>Usage</h2>
-
-<p>The code can run either using a pre-computed (and provided) k-distribution
-data set among 5 standard atmospheric profiles, or from a user-defined spectral
-data file. This user-defined spectral data file should be name
-<code>ecrad_opt_prop.txt</code>, and located into the <code>/data</code>
-directory. The format of this file can be found in the
-<code>/Doc/gas_opt_prop.pdf</code> documentation file, and a example
-<code>/Doc/input.for</code> source file provides a fortran subroutine for
-reading this file. A example <code>ecrad_opt_prop.txt</code> file is provided
-in the <code>/data</code> directory (for the Mid-Latitude Summer profile).</p>
-
-<p>Simulation input is provided through the <code>data.in</code> and
-<code>options.in</code> files (located in the main <code>PPart_LW</code>
-directory):</p>
-
-<!--div class="img" style="width: 20em">
- <a href="NER_animation.gif">
- <img src="NER_animation.gif" alt="NER">
- </a>
- <div class="caption">
- Matrix of Net Exchange Rates in a Mid-Latitude Summer standard atmosphere,
- as a function of the wavelength (each frame is for a given spectral
- interval). The NER between layers i and j is found at the intersection
- between column index i and row index j ; the ground is the first element
- and space is the last element.
- </div>
-</div-->
-
-<ul>
- <li>the <code>options.in</code> file provides the possibility to use either a
- (provided) standard atmospheric data set or a user-defined spectral data set
- (in this case, the <code>/data/ecrad_opt_prop.txt</code> file has to be
- found). It provides the possibility to use a specular or diffuse reflective
- ground, and the possibility to perform the spectral integration over a
- limited number of spectral intervals. Then the user should specify whether a
- angular integration should be performed or a single-direction radiative
- transfer computation is required. Finally, the user can disable the
- computation of a NER matrix for every spectral interval.</li>
-
- <li>the <code>data.in</code> file lets the user specify the spectral
- integration domain (if a limited spectral domain should be used), and the
- direction to use for a single-direction radiative transfer computation.
- Finally, the user should specify the index of the standard atmospheric
- profile to use, when the corresponding option has been selected.</li>
-
-</ul>
-
-<p>Results are located into the <code>/results</code> directory; several
-gnuplot scripts are provided in order to visualise various results. When a NER
-matrix has been computed for every spectral interval, a script named
-<code>anim.bash</code> can be found in the <code>/results/NER_animation</code>
-directory; this script will produce a animated gif of these NER matrices (the
-spectral interval evolving with time). This script requires the GraphicsMagick
-package.</p>
-
-
-<h2>License</h2>
-
-<p>Copyright © 2014-2018 <a
-href="mailto:contact@meso-star.com">|Méso|Star></a>.<br>
-Copyright © 2010-2014 Institut Mines-Télécom Albi-Carmaux, Université
-Bordeaux 1.</p>
-
-<p>PPart_LW is free software released under the GPLv2+ license: GNU GPL version 2
-or later. You can freely study, modify or extend it. You are also welcome to
-redistribute it under certain conditions; refer to the <a
-href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">license</a>
-for details.</p>
-
diff --git a/art/ppart_lw.md b/art/ppart_lw.md
@@ -0,0 +1,111 @@
+# PPart\_LW
+
+The purpose of PPart\_LW is to perform radiative transfer computations using
+k-distribution data sets (that can be produced by
+[Kdistribution](kdistribution.html), or any other code).
+This code is based on analytic radiative transfer solutions that are
+valid only in the case of a emitting and absorbing, but non-scattering,
+atmosphere.
+This code should therefore be used, in the case of the terrestrial
+atmosphere, for clear-sky LW computations only.
+
+[](Tb.svg)
+
+> Brightness temperature in the [4-20] micrometers range, for a
+> Mid-Latitude Summer standard atmospheric profile.
+
+## Quick start
+
+- Sources: [tarball](downloads/ppart_lw.tgz) /
+ [pgp](downloads/ppart_lw.tgz.sig)
+
+### Prerequisites
+
+Only a fortran compiler is needed (no external libraries).
+The `gfortran` compiler has been used for development.
+
+### Installation
+
+Download and extract the archive (`tar -zxvf ppart_lw.tgz`); then move
+into the `PPart_LW` directory, and use the `make all` command to
+compile.
+You should use the `make clean` command in the case you want to
+recompile from scratch only (when include files are modified).
+If only source files are modified, the `make all` command will recompile
+modified files.
+
+### Run
+
+PPart\_LW has been parallelized, which means you will have to launch it
+using the `mpirun` command:
+
+ mpirun -np <NPROCS> ./PPart.exe
+
+with `<NPROCS>` the number of processes requested for the
+computation;
+MacOS users might encounter a error where the OS considers the user
+requested a number of processes higher than recommended.
+You can bypass it using the `-oversubscribe` option:
+
+ mpirun -oversubscribe -np <NPROCS> ./PPart.exe
+
+## Usage
+
+The code can run either using a pre-computed (and provided)
+k-distribution data set among 5 standard atmospheric profiles, or from a
+user-defined spectral data file.
+This user-defined spectral data file should be name
+`ecrad_opt_prop.txt`, and located into the `/data` directory. The format
+of this file can be found in the `/Doc/gas_opt_prop.pdf` documentation
+file, and a example `/Doc/input.for` source file provides a fortran
+subroutine for reading this file.
+An example `ecrad_opt_prop.txt` file is provided in the `/data`
+directory (for the Mid-Latitude Summer profile).
+
+Simulation input is provided through the `data.in` and `options.in`
+files (located in the main `PPart_LW` directory):
+
+- the `options.in` file provides the possibility to use either a
+ (provided) standard atmospheric data set or a user-defined spectral
+ data set (in this case, the `/data/ecrad_opt_prop.txt` file has to be
+ found).
+ It provides the possibility to use a specular or diffuse reflective
+ ground, and the possibility to perform the spectral integration over a
+ limited number of spectral intervals.
+ Then the user should specify whether a angular integration should be
+ performed or a single-direction radiative transfer computation is
+ required.
+ Finally, the user can disable the computation of a NER matrix for
+ every spectral interval.
+
+- the `data.in` file lets the user specify the spectral integration
+ domain (if a limited spectral domain should be used), and the
+ direction to use for a single-direction radiative transfer
+ computation.
+ Finally, the user should specify the index of the standard atmospheric
+ profile to use, when the corresponding option has been selected.
+
+Results are located into the `/results` directory; several gnuplot
+scripts are provided in order to visualise various results.
+When a NER matrix has been computed for every spectral interval, a
+script named `anim.bash` can be found in the `/results/NER_animation`
+directory;
+this script will produce a animated gif of these NER matrices (the
+spectral interval evolving with time).
+This script requires the GraphicsMagick package.
+
+
+## License
+
+Copyright © 2014-2018 |Méso|Star>
+([contact@meso-star.com](mailto:contact@meso-star.com))
+Copyright © 2010-2014 Institut Mines-Télécom Albi-Carmaux
+Copyright © 2010-2014 Université Bordeaux 1
+
+PPart\_LW is free software released under the GPLv2+ license: GNU GPL version 2
+or later.
+You can freely study, modify or extend it.
+You are also welcome to redistribute it under certain conditions; refer
+to the
+[license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) for
+details.
diff --git a/art/ppart_sw.html.in b/art/ppart_sw.html.in
@@ -1,130 +0,0 @@
-<header>
- <h1>PPart SW
- <span class=subtitle>
- Plane-Parallel atmospheric radiative transfer - ShortWave
- </span>
- </h1>
-</header>
-
-<div class="news">
- <p><b>Download PPart_SW</b></p>
- <ul>
- <li>Sources:
- <a href="downloads/ppart_sw.tgz">tarball</a> /
- <a href="downloads/ppart_sw.tgz.sig">pgp</a></li>
- </ul>
-</div>
-
-
-<p>The purpose of PPart_SW is to perform radiative transfer computations using
-k-distribution data sets (that can be produced by <a
-href="kdistribution.html">Kdistribution</a>, or any other code). This code is
-based on analytic radiative transfer solutions that are valid only in the case
-of a emitting and absorbing, but non-scattering, atmosphere. This code should
-therefore not be used in the case of the SW domain. However, Rayleigh
-scattering is not actually taken into account by the code. It can be used as a
-toy-model in which only the transmission of incoming SW radiation is taken into
-account (as well as the emitted radiation when the atmosphere is hot
-enough).</p>
-
-<h2>Installation</h2>
-
-<div class="img" style="width: 20em">
- <a href="si_flux.svg">
- <img src="si_flux.svg" alt="si_flux">
- </a>
- <div class="caption">
- Spectrally integrated SW flux profiles (upward, downward and net) as a
- function of altitude for a Mid-Latitude Summer standard atmosphere.
- </div>
-</div>
-
-<p>Download and extract the archive (<code>tar -zxvf ppart_sw.tgz</code>); then
-move into the <code>PPart_SW</code> directory, and use the <code>make
-all</code> command to compile. You should use the <code>make clean</code>
-command in the case you want to recompile from scratch only (when include files
-are modified). If only source files are modified, the <code>make all</code>
-command will recompile modified files.</p>
-
-<p>PPart_SW has been parallelized, which means you will have to launch it using
-the <code>mpirun</code> command:</p>
-
-<pre class=code>
-mpirun -np <NPROCS> ./PPart.exe
-</pre>
-
-<p>with <code><NPROCS></code> the number of processes requested for the
-computation; MacOS users might encounter a error where the OS considers the
-user requested a number of processes higher than recommended. You can bypass it
-using the <code>-oversubscribe</code> option:</p>
-
-<pre class=code>
-mpirun -oversubscribe -np <NPROCS> ./PPart.exe
-</pre>
-
-<p><b>Prerequistes</b>: only a fortran compiler is needed (no external
-libraries). the gfortran compiler has been used for development, but other
-common compilers should work too (ifort, pgfortran, <i>etc.</i>)</p>
-
-<h2>Usage</h2>
-
-<p>The code can run either using a pre-computed (and provided) k-distribution data
-set among 5 standard atmospheric profiles, or from a user-defined spectral data
-file. This user-defined spectral data file should be name
-<code>ecrad_opt_prop.txt</code> and located into the <code>data</code>
-directory. The format of this file can be found in the
-<code>/Doc/gas_opt_prop.pdf</code> documentation file, and a example
-<code>/Doc/input.for</code> source file provides a fortran subroutine for
-reading this file. A example <code>ecrad_opt_prop.txt</code> file is provided
-in the <code>/data</code> directory (for the Mid-Latitude Summer profile).</p>
-
-<p>Since this code has been adapted to the SW range, it also needs the incoming
-SW solar radiation at the top of the atmosphere. This data has to be provided
-in the <code>/data/incoming_sw.txt</code> input data file. A example file is
-provided in the case of the Earth atmosphere. It should be usable for other
-planets of the solar system by rescaling the values of the input solar
-flux.</p>
-
-<p>Simulation input is provided through the <code>data.in</code> and
-<code>options.in</code> files (located in the main <code>PPart_SW</code>
-directory):</p>
-
-<ul>
- <li> the <code>options.in</code> file provides the possibility to use either
- a (provided) standard atmospheric data set or a user-defined spectral data
- set (in this case, the <code>/data/ecrad_opt_prop.txt</code> file has to be
- found). It provides the possibility to use a specular or diffuse reflective
- ground, and the possibility to perform the spectral integration over a
- limited number of spectral intervals. Then the user should specify whether a
- angular integration should be performed or a single-direction radiative
- transfer computation is required. Finally, the user can disable the
- computation of a NER matrix for every spectral interval.</li>
-
- <li> the <code>data.in</code> file lets the user specify the spectral
- integration domain (if a limited spectral domain should be used), and the
- direction to use for a single-direction radiative transfer computation.
- Finally, the user should specify the index of the standard atmospheric
- profile to use, when the corresponding option has been selected.</li>
-</ul>
-
-<p>Results are located into the <code>/results</code> directory; several
-gnuplot scripts are provided in order to visualise various results. When a NER
-matrix has been computed for every spectral interval, a script named
-<code>anim.bash</code> can be found in the <code>/results/NER_animation</code>
-directory; this script will produce a animated gif of these NER matrices (the
-spectral interval evolving with time). This script requires the GraphicsMagick
-package.</p>
-
-<h2>License</h2>
-
-<p>Copyright © 2014-2018 <a
-href="mailto:contact@meso-star.com">|Méso|Star></a>.<br>
-Copyright © 2010-2014 Institut Mines-Télécom Albi-Carmaux, Université
-Bordeaux 1.</p>
-
-<p>PPart_SW is free
-software released under the GPLv2+ license: GNU GPL version 2 or later. You
-can freely study, modify or extend it. You are also welcome to redistribute it
-under certain conditions; refer to the <a
-href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">license</a>
-for details.</p>
diff --git a/art/ppart_sw.md b/art/ppart_sw.md
@@ -0,0 +1,122 @@
+# PPart\_SW
+
+The purpose of PPart\_SW is to perform radiative transfer computations
+using k-distribution data sets (that can be produced by
+[Kdistribution](kdistribution.html), or any other code).
+This code is based on analytic radiative transfer solutions that are
+valid only in the case of a emitting and absorbing, but non-scattering,
+atmosphere.
+This code should therefore not be used in the case of the SW domain.
+However, Rayleigh scattering is not actually taken into account by the
+code.
+It can be used as a toy-model in which only the transmission of incoming
+SW radiation is taken into account (as well as the emitted radiation
+when the atmosphere is hot enough).
+
+[](si_flux.svg)
+
+> Spectrally integrated SW flux profiles (upward, downward and net) as a
+> function of altitude for a Mid-Latitude Summer standard atmosphere.
+
+## Quick start
+
+- Sources: [tarball](downloads/ppart_sw.tgz) /
+ [pgp](downloads/ppart_sw.tgz.sig)
+
+### Prerequisites
+
+Only a fortran compiler is needed (no external libraries).
+The `gfortran` compiler has been used for development.
+
+### Installation
+
+Download and extract the archive (`tar -zxvf ppart_sw.tgz`); then move
+into the `PPart_SW` directory, and use the `make all` command to
+compile.
+You should use the `make clean` command in the case you want to
+recompile from scratch only (when include files are modified).
+If only source files are modified, the `make all` command will recompile
+modified files.
+
+### Run
+
+PPart\_SW has been parallelized, which means you will have to launch it
+using the `mpirun` command:
+
+ mpirun -np <NPROCS> ./PPart.exe
+
+with <NPROCS> the number of processes requested for the computation;
+MacOS users might encounter a error where the OS considers the user
+requested a number of processes higher than recommended.
+You can bypass it using the `-oversubscribe` option:
+
+ mpirun -oversubscribe -np <NPROCS> ./PPart.exe
+
+## Usage
+
+The code can run either using a pre-computed (and provided)
+k-distribution data set among 5 standard atmospheric profiles, or from a
+user-defined spectral data file.
+This user-defined spectral data file should be name `ecrad_opt_prop.txt`
+and located into the `data` directory.
+The format of this file can be found in the `/Doc/gas_opt_prop.pdf`
+documentation file, and a example `/Doc/input.for` source file provides
+a fortran subroutine for reading this file.
+A example `ecrad_opt_prop.txt` file is provided in the `/data` directory
+(for the Mid-Latitude Summer profile).
+
+Since this code has been adapted to the SW range, it also needs the
+incoming SW solar radiation at the top of the atmosphere.
+This data has to be provided in the `/data/incoming_sw.txt` input data
+file.
+A example file is provided in the case of the Earth atmosphere.
+It should be usable for other planets of the solar system by rescaling
+the values of the input solar flux.
+
+Simulation input is provided through the `data.in` and `options.in`
+files (located in the main `PPart_SW` directory):
+
+- the `options.in` file provides the possibility to use either a
+ (provided) standard atmospheric data set or a user-defined spectral
+ data set (in this case, the `/data/ecrad_opt_prop.txt` file has to be
+ found).
+ It provides the possibility to use a specular or diffuse reflective
+ ground, and the possibility to perform the spectral integration over a
+ limited number of spectral intervals.
+ Then the user should specify whether a angular integration should be
+ performed or a single-direction radiative transfer computation is
+ required.
+ Finally, the user can disable the computation of a NER matrix for
+ every spectral interval.
+
+- the `data.in` file lets the user specify the spectral integration
+ domain (if a limited spectral domain should be used), and the
+ direction to use for a single-direction radiative transfer
+ computation.
+ Finally, the user should specify the index of the standard atmospheric
+ profile to use, when the corresponding option has been selected.
+
+Results are located into the `/results` directory;
+several gnuplot scripts are provided in order to visualise various
+results.
+When a NER matrix has been computed for every spectral interval, a
+script named `anim.bash` can be found in the `/results/NER_animation`
+directory;
+this script will produce a animated gif of these NER matrices (the
+spectral interval evolving with time).
+This script requires the GraphicsMagick package.
+
+## License
+
+Copyright © 2014-2018 |Méso|Star>
+([contact@meso-star.com](mailto:contact@meso-star.com))
+Copyright © 2010-2014 Institut Mines-Télécom Albi-Carmaux
+Copyright © 2010-2014 Université Bordeaux 1
+
+PPart\_SW is free software released under the GPLv2+ license: GNU GPL version 2
+or later.
+You can freely study, modify or extend it.
+You are also welcome to redistribute it under certain conditions; refer
+to the
+[license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) for
+details.
