htmie

commit b1a39db7f6bdf74e4bbad8a4bdf81a4181fb6f31
parent a4c9a214fcfbd759afcff54c5386cb3a50ebebdf
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 14 Nov 2018 12:16:31 +0100

Write the htmie man page

Diffstat:
M
cmake/CMakeLists.txt
 | 
22
++++++++++++++++++++++
A
doc/htmie.5.txt
 | 
56
++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 78 insertions(+), 0 deletions(-)
diff --git a/cmake/CMakeLists.txt b/cmake/CMakeLists.txt
@@ -73,6 +73,28 @@ set_target_properties(htmie PROPERTIES
 rcmake_setup_devel(htmie HTMIE ${VERSION} high_tune/htmie_version.h)
 
 ################################################################################
+# Man pages
+################################################################################
+find_program(A2X NAMES a2x a2x.py)
+if(NOT A2X)
+  message(WARNING
+    "The `a2x' program is missing. "
+    "The htmie man pages cannot be generated.")
+else()
+  set(_src ${PROJECT_SOURCE_DIR}/../doc/htmie.5.txt)
+  set(_dst ${CMAKE_CURRENT_BINARY_DIR}/htmie.5.txt)
+  add_custom_command(
+    OUTPUT htmie.5
+    COMMAND ${CMAKE_COMMAND} -E copy ${_src} ${_dst}
+    COMMAND ${A2X} -dmanpage -fmanpage ${CMAKE_CURRENT_BINARY_DIR}/htmie.5.txt
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Buid ROFF man page htmie.5"
+    VERBATIM)
+  add_custom_target(man-roff ALL DEPENDS htmie.5)
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/htmie.5 DESTINATION share/man/man5)
+endif()
+
+################################################################################
 # Test utilities
 ################################################################################
 if(NOT NO_TEST)
diff --git a/doc/htmie.5.txt b/doc/htmie.5.txt
@@ -0,0 +1,56 @@
+// Copyright (C) 2018 CNRS, |Meso|Star>, 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/>.
+:toc:
+
+htmie(5)
+=======
+
+NAME
+----
+htmie - High-Tune: Mie's data file format
+
+DESCRIPTION
+-----------
+
+*htmie* is the file format used by *htrdr*(1) to describe the optical
+properties of water droplets obtained by a Mie code. This format relies on the
+NetCDF data format [1]. To be a valid *htmie* file, the NetCDF file must
+defined the following variables:
+
+*lambda*::
+  One dimensional array of floating point data that lists the wavelengths
+  in nanometers for which the subsequents data are defined.
+
+*macs*::
+  One dimensional array of massic absorption cross-sections in kg of liquid
+  water in suspension.
+
+*mscs::
+  One dimensional array of massic scattering cross-sections in kg of liquid
+  water in suspension.
+
+*g*::
+  One dimensional array of asymetry parameter of the equivalent
+  Henyey-Greenstein phase function.
+
+NOTES
+-----
+1. Network Common Data Form -
+<https://www.unidata.ucar.edu/software/netcdf/>
+
+SEE ALSO
+--------
+*htrdr*(1)
+