commit 42bee2fba23f408638eea77280e0598e96c25006
parent 1f779fa67a1533204ca1b0622c6bb55f1af117b2
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 28 Nov 2018 13:52:59 +0100
Remove references to LES in the man pages
Diffstat:
2 files changed, 24 insertions(+), 31 deletions(-)
diff --git a/doc/htcp.5.txt b/doc/htcp.5.txt
@@ -26,8 +26,7 @@ DESCRIPTION
*htcp* is a binary file format that describes properties on liquid water
content in suspension within clouds. The *les2htcp*(1) command can be used to
-generate a *htcp* file from cloud properties resulting of a Large Eddy
-Simulation and saved in a "Meso-NH like" NetCDF file format [1].
+generate a *htcp* file from cloud properties saved in a NetCDF file format.
The cloud properties are actually spatio temporal double precision floating
point data, structured in a 4D grid whose definition and spatial origin is
@@ -97,10 +96,6 @@ significant bytes are stored first.
<padding> ::= [ BYTE ... ]
-------
-NOTES
------
-1. Meso-NH - <http://mesonh.aero.obs-mip.fr/mesonh54/Welcome>
-
SEE ALSO
--------
*les2htcp*(1)
diff --git a/doc/les2htcp.1.txt b/doc/les2htcp.1.txt
@@ -24,13 +24,12 @@ les2htcp - convert cloud properties from NetCDF to htcp(5) file format
SYNOPSIS
--------
[verse]
-*les2htcp* [_option_] ... -i __LES__
+*les2htcp* [_option_] ... -i __NetCDF__
DESCRIPTION
-----------
-*les2htcp* generates a *htcp*(5) file from cloud properties computed by a
-Large Eddy Simulation and saved in a NetCDF file [1]. Expected variables in
-the submitted NetCDF file are:
+*les2htcp* generates a *htcp*(5) file from cloud properties stores in a NetCDF
+file [1]. Expected variables in the submitted NetCDF file are:
* _W_E_direction_ *and* _S_N_direction_: one dimensional list of position of the
center of each cell along the West-East and South-North horizontal axis,
@@ -60,9 +59,9 @@ the submitted NetCDF file are:
OPTIONS
-------
*-c*::
- Advanced checks on the validity of the submitted _LES_ file with respect to
- the *les2htcp* prerequisites on the NetCDF data. Note that this option can
- increase significantly the conversion time.
+ Advanced checks on the validity of the submitted _NetCDF_ file with respect
+ to the *les2htcp* prerequisites on the NetCDF data. Note that this option
+ can increase significantly the conversion time.
*-f*::
Force overwrite of the _output_ file.
@@ -70,7 +69,7 @@ OPTIONS
*-h*::
List short help and exit.
-*-i* _LES_::
+*-i* _NetCDF_::
NetCDF file to convert.
*-m* _float-to-meter_::
@@ -82,12 +81,12 @@ OPTIONS
*-p* _page-size_::
Targeted page size in bytes; must be a power of 2. The size of the converted
- LES data and their starting address into the *htcp*(5) file are aligned
+ NetCDF data and their starting address into the *htcp*(5) file are aligned
according to _page-size_. By default, _page-size_ is 4096 bytes.
*-q*::
Write nothing to _output_. Might be used in conjunction of the *-c* option
- to only check the submitted _LES_.
+ to only check the submitted _NetCDF_.
*-v*::
Display version information and exit.
@@ -95,25 +94,25 @@ OPTIONS
EXAMPLES
--------
-Convert the *LES_clouds.nc* NetCDF file. Write the resulting *htcp*(5) file in
+Convert the *clouds.nc* NetCDF file. Write the resulting *htcp*(5) file in
*cloud.htcp* excepted if the file already exists; in this case an error is
notified, the program stops and the *cloud.htcp* file remains unchanged:
- $ les2htcp -i LES_clouds.nc -o clouds.htcp
+ $ les2htcp -i clouds.nc -o clouds.htcp
-Convert the *LES_clouds_km.nc* file to *htcp*(5) file format. Use the *-f*
-option to write the output file *clouds.htcp* even though it already exists.
-The *LES_clouds_km.nc* file to convert has its spatial unit in kilo-meters
-while the *htcp*(5) file formats assumes meters: use the *-m 1000* option to
-map kilo-meters to meters:
+Convert the *clouds_km.nc* file to *htcp*(5) file format. Use the *-f* option
+to write the output file *clouds.htcp* even though it already exists. The
+*clouds_km.nc* file to convert has its spatial unit in kilo-meters while the
+*htcp*(5) file formats assumes meters: use the *-m 1000* option to map
+kilo-meters to meters:
- $ les2htcp -i LES_clouds_km.nc -m 1000 -o clouds.htcp
+ $ les2htcp -i clouds_km.nc -m 1000 -o clouds.htcp
-Check that the submitted *LES_clouds.nc* file is valid regarding the
+Check that the submitted *clouds.nc* file is valid regarding the
*les2htcp* constraints. Use the *-q* option to disable the generation of
output data:
- $ les2htcp -c -i LES_clouds.nc -q
+ $ les2htcp -c -i clouds.nc -q
NOTES
-----
@@ -122,12 +121,11 @@ NOTES
COPYRIGHT
---------
-*les2htcp* is copyright © 2018 CNRS, Université Paul Sabatier
+Copyright © 2018 CNRS, Université Paul Sabatier
<contact-edstar@laplace.univ-tlse.fr>, |Meso|Star> <contact@meso-star.com>.
-License GPLv3+: GNU GPL version 3 or later
-<https://gnu.org/licenses/gpl.html>. This is a free software. You are free to
-change and redistribute it. There is NO WARRANTY, to the extent permitted by
-law.
+*les2htcp* is free software released under the GPLv3+ license: GNU GPL version
+3 or later <https://gnu.org/licenses/gpl.html>. You are free to change and
+redistribute it. There is NO WARRANTY, to the extent permitted by law.
SEE ALSO
--------
