htrdr

commit b9b7b4083f3f104c3a5b677fb08c72470df357b2
parent 568db904efed5d552ba9e73d794670d779787db9
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Fri,  9 May 2025 09:31:08 +0200

atmosphere: structure the man's sources with comments

They make reading easier

Diffstat:
M
doc/htrdr-atmosphere.1.in
 | 
30
++++++++++++++++++++++++++++++

1 file changed, 30 insertions(+), 0 deletions(-)
diff --git a/doc/htrdr-atmosphere.1.in b/doc/htrdr-atmosphere.1.in
@@ -23,9 +23,15 @@
 .Dd January 24, 2024
 .Dt HTRDR-ATMOSPHERE 1
 .Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Name and Short description
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh NAME
 .Nm htrdr-atmosphere
 .Nd simulate radiative transfer in cloudy atmospheres
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Summary of options
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh SYNOPSIS
 .Nm
 .Op Fl dfhRrv
@@ -46,6 +52,9 @@
 .Op Fl t Ar threads_count
 .Op Fl V Ar x , Ns Ar y , Ns Ar z
 .Fl a Pa atmosphere
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Detailed description
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh DESCRIPTION
 .Nm
 simulates radiative transfer in scenes composed of an atmospheric gas
@@ -421,6 +430,9 @@ Make
 .Nm
 verbose.
 .El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Output image
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh OUTPUT IMAGE
 Images calculated by
 .Nm
@@ -429,6 +441,7 @@ are saved in
 format.
 This section describes the nature and arrangement of image data
 depending on the type of calculation performed.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Ss XYZ image
 For an image rendering in the visible part of the spectrum
 .Pq default behavior or option Fl s Cm cie_xyz ,
@@ -441,6 +454,7 @@ average radiance of the pixel.
 The second value is its associated standard deviation.
 The fourth and final pair records the microsecond estimate of the
 computation time per radiative path and its standard error.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Ss Longwave image
 For infrared calculations
 .Pq option Fl s Cm lw= Ns Ar wlen_min , Ns Ar wlen_max
@@ -456,6 +470,7 @@ The fifth and sixth pixel components are not used.
 Finally, the last 2 components of the pixel record the estimate in
 microseconds of the computation time per radiative path and its standard
 error.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Ss Shortwave image
 For shortwave calculations
 .Pq option Fl s Cm sw= Ns Ar wlen_min , Ns Ar wlen_max
@@ -474,8 +489,14 @@ components that store the estimate of the radiative path computation
 time
 .Pq in microseconds
 and its standard error.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Returned status
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh EXIT STATUS
 .Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Examples of use
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh EXAMPLES
 Render a clear sky scene, i.e. a scene without any cloud, whose sun is at
 zenith.
@@ -623,6 +644,9 @@ N="$(grep -ce "^# vtk" output)"
 sed /^---$/d output \\
 | csplit -f octree -k - %^#\\ vtk% /^#\\ vtk/ {$((${N}-2))}
 .Ed
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" References
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh SEE ALSO
 .Xr mpirun 1 ,
 .Xr htcp 5 ,
@@ -654,6 +678,9 @@ Highly Resolved Cloudy Atmospheres
 .%D 2019
 .%U https://dx.doi.org/10.1029/2018MS001602
 .Re
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Used and implemented standards
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh STANDARDS
 .Rs
 .%A International Organization for Standardization / CIE
@@ -674,6 +701,9 @@ Highly Resolved Cloudy Atmospheres
 .%D July 1997
 .%T MPI-2: Extensions to The Message-Passing Interface
 .Re
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\" Brief implementation history
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh HISTORY
 .Nm
 has been initially developed as part of