commit b6565033b4ea3ecaf1f803d97b97fb8c59818974
parent 1f639f5a234c238bd2dd874b451782ce3ee39672
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 12 Jan 2023 14:11:35 +0100
planeto: reference, compile and install the rnrl man page
Diffstat:
4 files changed, 84 insertions(+), 91 deletions(-)
diff --git a/cmake/doc/CMakeLists.txt b/cmake/doc/CMakeLists.txt
@@ -39,7 +39,8 @@ set(MAN_SOURCES
${HTRDR_DOC_DIR}/htrdr.1.scd
${HTRDR_DOC_DIR}/htrdr-image.5.scd
${HTRDR_DOC_DIR}/htrdr-materials.5.scd
- ${HTRDR_DOC_DIR}/htrdr-obj.5.scd)
+ ${HTRDR_DOC_DIR}/htrdr-obj.5.scd
+ ${HTRDR_DOC_DIR}/rnrl.5.scd)
if(HTRDR_BUILD_ATMOSPHERE)
configure_file(${HTRDR_DOC_DIR}/htrdr-atmosphere.1.scd.in
diff --git a/doc/htrdr-planeto.1.scd.in b/doc/htrdr-planeto.1.scd.in
@@ -271,7 +271,7 @@ launcher such as *mpirun*(1) to distribute the rendering on several computers.
_wlen-min_ and _wlen-max_ are equal, the calculation is monochromatic. Here,
*sw* means shortwaves, i.e. the radiation source is external to the medium
(option *-S*).
-
+
*-T* _optical-thickness_
Optical thickness used as a criterion to construct atmospheric acceleration
structures. Its default value is
@@ -420,6 +420,7 @@ and redistribute it. There is NO WARRANTY, to the extent permitted by law.
*mpirun*(1),
*mrumtl*(5),
*rnpfi*(5),
+*rnrl*(5),
*rnsf*(5),
*rnsl*(5),
*sars*(5),
diff --git a/doc/rnrl.5.scd b/doc/rnrl.5.scd
@@ -0,0 +1,80 @@
+rnrl(5)
+
+; Copyright (C) 2018-2019, 2022-2023 Centre National de la Recherche Scientifique
+; Copyright (C) 2020-2022 Institut Mines Télécom Albi-Carmaux
+; Copyright (C) 2022-2023 Institut de Physique du Globe de Paris
+; Copyright (C) 2018-2023 |Méso|Star> (contact@meso-star.com)
+; Copyright (C) 2022-2023 Université de Reims Champagne-Ardenne
+; Copyright (C) 2022-2023 Université de Versaille Saint-Quentin
+; Copyright (C) 2018-2019, 2022-2023 Université Paul Sabatier
+;
+; This program is free software: you can redistribute it and/or modify
+; it under the terms of the GNU General Public License as published by
+; the Free Software Foundation, either version 3 of the License, or
+; (at your option) any later version.
+;
+; This program is distributed in the hope that it will be useful,
+; but WITHOUT ANY WARRANTY; without even the implied warranty of
+; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+; GNU General Public License for more details.
+;
+; You should have received a copy of the GNU General Public License
+; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# NAME
+
+rnsr - Rad-Net Radiance List file format
+
+# DESCRIPTION
+
+*rnrl* is a binary file format for storing a list of spectrally varying
+radiances. The radiances (in W/m²/sr/m) are listed by wavelength (in nm)
+sorted in ascending order.
+
+A *rnrl* file is actually a Star-Buffer file (see *sbuf*(5)). It starts with a
+header of 4 64-bit integers describing the layout of the data. The first integer
+is a power of two (usually 4096) which defines the size of the memory page in
+bytes on which the list of radiances by wavelength aligns (_pagesize_). The
+second integer is the _size_ of the array, that is, the number of wavelengths
+for which a radiance is defined. Finally, the remaining 2 integers store the
+memory size (16 bytes) and memory alignment (16 bytes) of a radiance per
+wavelength.
+
+The fill bytes follow the file header to align the radiances by wavelength to
+_pagesize_.
+
+Each item in the list is composed of 2 double-precision floating-point values:
+the wavelength in nanometers and its corresponding radiance in W/m²/sr/m.
+
+The end of the file is eventually padded with dummy bytes to ensure that the
+overall file size is a multiple of _pagesize_.
+
+# BINARY FILE FORMAT
+
+Data are encoded with respect to the little endian bytes ordering, i.e. least
+significant bytes are stored first.
+
+```
+<rnsr> ::= <pagesize> <size> 16 16
+ <padding>
+ <radiances>
+ <padding>
+
+<pagesize> ::= UINT64
+<size> ::= UINT64 # Number of items stored
+
+---
+
+<radiances> ::= <property> ... ...
+<property> ::= <wavelength> <radiance>
+<wavelength> ::= DOUBLE # in nanometer
+<radiance> ::= DOUBLE # in W/m²/sr/m
+
+---
+
+<padding> ::= [ BYTE ... ] # Ensure alignement
+```
+
+# SEE ALSO
+
+*sbuf*(5)
diff --git a/doc/rnrl.scd b/doc/rnrl.scd
@@ -1,89 +0,0 @@
-rnrl(5)
-
-; Copyright (C) 2018-2019, 2022-2023 Centre National de la Recherche Scientifique
-; Copyright (C) 2020-2022 Institut Mines Télécom Albi-Carmaux
-; Copyright (C) 2022-2023 Institut de Physique du Globe de Paris
-; Copyright (C) 2018-2023 |Méso|Star> (contact@meso-star.com)
-; Copyright (C) 2022-2023 Université de Reims Champagne-Ardenne
-; Copyright (C) 2022-2023 Université de Versaille Saint-Quentin
-; Copyright (C) 2018-2019, 2022-2023 Université Paul Sabatier
-;
-; This program is free software: you can redistribute it and/or modify
-; it under the terms of the GNU General Public License as published by
-; the Free Software Foundation, either version 3 of the License, or
-; (at your option) any later version.
-;
-; This program is distributed in the hope that it will be useful,
-; but WITHOUT ANY WARRANTY; without even the implied warranty of
-; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-; GNU General Public License for more details.
-;
-; You should have received a copy of the GNU General Public License
-; along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-# NAME
-
-rnsr - Rad-Net Radiance List file format
-
-# DESCRIPTION
-
-*rnrl* is a binary file format for storing a list of spectrally varying
-radiances. The radiances (in W/m²/sr/m) are listed by wavelength (in nm)
-sorted in ascending order.
-
-A *rnrl* file is actually a Star-Buffer file (see *sbuf*(5)). It starts with a
-header of 4 64-bit integers describing the layout of the data. The first integer
-is a power of two (usually 4096) that defines the size of the memory page in
-bytes to which the list of per wavelength radiances aligns (_pagesize_). The
-second integer is the _size_ of the array, i.e. the number of wavelength for
-which a radiance is defined. Finally, the 2 remaining integers store the memory
-size (16 bytes, i.e. 2 double precision values) and the memory alignment (16
-bytes) of a per wavelength radiance.
-
-An *rnrl* file is actually a Star-Buffer file (see *sbuf*(5)). It starts with a
-header of 4 64-bit integers describing the layout of the data. The first integer
-is a power of two (usually 4096) which defines the size of the memory page in
-bytes on which the list of radiances by wavelength aligns (_pagesize_). The
-second integer is the _size_ of the array, that is, the number of wavelengths
-for which a radiance is defined. Finally, the remaining 2 integers store the
-memory size (16 bytes) and memory alignment (16 bytes) of a radiance per
-wavelength.
-
-The fill bytes follow the file header to align the radiances by wavelength to
-_pagesize_.
-
-Each item in the list is composed of 2 double-precision floating-point values:
-the wavelength in nanometers and its corresponding radiance in W/m²/sr/m.
-
-The end of the file is eventually padded with dummy bytes to ensure that the
-overall file size is a multiple of _pagesize_.
-
-# BINARY FILE FORMAT
-
-Data are encoded with respect to the little endian bytes ordering, i.e. least
-significant bytes are stored first.
-
-```
-<rnsr> ::= <pagesize> <size> 16 16
- <padding>
- <radiances>
- <padding>
-
-<pagesize> ::= UINT64
-<size> ::= UINT64 # Number of items stored
-
----
-
-<radiances> ::= <property> ... ...
-<property> ::= <wavelength> <radiance>
-<wavelength> ::= DOUBLE # in nanometer
-<radiance> ::= DOUBLE # in W/m²/sr/m
-
----
-
-<padding> ::= [ BYTE ... ] # Ensure alignement
-```
-
-# SEE ALSO
-
-*sbuf*(5)
