htcp

Properties of water suspended in clouds
git clone git://git.meso-star.fr/htcp.git
Log | Files | Refs | README | LICENSE

commit 11d04c99aa173cd3a702fa5edad6c7fc1de3947b
parent 250fb252c3fc095f2f77b92bd1ab9496481ab8b6
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Tue,  5 Sep 2023 16:16:18 +0200

netCDF typography update

In the man page and README file, netCDF starts with an uppercase letter
instead of the lowercase letter defined in its standard specification.

Diffstat:
MREADME.md | 6+++---
Mles2htcp.1 | 18+++++++++---------
2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md @@ -3,7 +3,7 @@ This project describes the htcp binary fileformat that is used to store the some properties of a cloud. The provided `les2htcp` command line tool extracts these properties from a LES output stored in a -[NetCDF](https://www.unidata.ucar.edu/software/netcdf/) file, and converts them +[netCDF](https://www.unidata.ucar.edu/software/netcdf/) file, and converts them in the `htcp` fileformat. Finally, a library is provided to load the `htcp` fileformat. Since the data to load can be huge, this library silently loads/unloads them dynamically allowing to process data that are too large to @@ -16,7 +16,7 @@ They rely on the [CMake](http://www.cmake.org) and the [RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. They also depend on the [RSys](https://gitlab.com/vaplv/rsys/) library. Furthermore, the `les2htcp` tool depends on the -[NetCDF](https://www.unidata.ucar.edu/software/netcdf/) C library. +[netCDF](https://www.unidata.ucar.edu/software/netcdf/) C library. Both eventually depend on [scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if available, is used to generate the man pages. @@ -52,7 +52,7 @@ mixing ratio and the liquid water mixing ratio. ### Version 0.0.1 -- Fix warnings and compilation errors when using the NetCDF library in version +- Fix warnings and compilation errors when using the netCDF library in version 4.4.0. - Fix compilation errors on systems with GNU C library version less than 2.19. diff --git a/les2htcp.1 b/les2htcp.1 @@ -19,7 +19,7 @@ .Os .Sh NAME .Nm les2htcp -.Nd convert cloud properties from NetCDF to +.Nd convert cloud properties from netCDF to .Xr htcp 5 .Sh SYNOPSIS .Nm @@ -32,8 +32,8 @@ .Nm generates a .Xr htcp 5 -file from cloud properties stored in a NetCDF file\ [1]. -The variables expected in the submitted NetCDF file are: +file from cloud properties stored in a netCDF file. +The variables expected in the submitted netCDF file are: .Bl -dash -offset indent .It .Va W_E_direction @@ -86,7 +86,7 @@ Advanced checks of the validity of the input .Ar netcdf file against .Nm -prerequisites on NetCDF data. +prerequisites on netCDF data. Note that this option can significantly increase conversion time. .It Fl f Forces overwriting of @@ -95,7 +95,7 @@ file. .It Fl h Display short help. .It Fl i Ar netcdf -NetCDF file to convert. +netCDF file to convert. .It Fl m Ar float_to_meter Scale factor to be applied to floating-point number .Li 1.0 to convert it to meters. By default, it is set to @@ -112,14 +112,14 @@ which is the default value Writes nothing to the output. Can be used in conjunction with the .Fl c -option to check only the validity of the input NetCDF. +option to check only the validity of the input netCDF. .It Fl v Display the version number and exit. .El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES -Convert the NetCDF +Convert the netCDF .Pa clouds.nc file. The resulting @@ -133,7 +133,7 @@ file remains unchanged: .Pp .Dl les2htcp -i clouds.nc -o clouds.htcp .Pp -Converts NetCDF file +Converts netCDF file .Pa clouds_km.nc to .Xr htcp 5 @@ -150,7 +150,7 @@ option to perform the conversion: .Pp .Dl les2htcp -i clouds_km.nc -m 1000 -o clouds.htcp .Pp -Check that the NetCDF file +Check that the netCDF file .Pa clouds.nc is a valid input file for .Nm .