commit e33750a92b1b95fc48b257372298655f7d03c033
parent be103d67264032cd8aec8c4b95604c4298b849ae
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 5 Sep 2023 16:51:35 +0200
Rewrite the README file
Rework the overview section. Addition of a section on project
requirements and dependencies. Complete rewrite of the installation
procedure concerning the use of POSIX make instead of CMake as the first
build system.
Diffstat:
| M | README.md | | | 62 | +++++++++++++++++++++++++++++++------------------------------- |
| M | les2htcp.1 | | | 2 | +- |
2 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
@@ -1,32 +1,32 @@
# High-Tune: Cloud Properties
-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
-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
-fit in the main memory.
-
-## How to build
-
-The `les2htcp` program and `htcp` library are compatible GNU/Linux 64-bits.
-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.
-Both eventually depend on [scdoc](https://sr.ht/~sircmpwn/scdoc/)
-which, if available, is used to generate the man pages.
-
-To build them, first ensure that CMake is installed on your system. Then
-install the RCMake package as well as the aforementioned prerequisites. Finally
-generate the project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the install directories of its dependencies. The
-resulting project can be edited, built, tested and installed as any CMake
-project. Refer to the [CMake](https://cmake.org/documentation) for further
-informations on CMake.
+This project defines a file format for storing the properties of liquid water
+suspended in clouds. See `htcp.5` for the format specification. A C library is
+provided for loading files in this format.
+
+To facilitate interoperability, the `les2htcp` tool converts data to htcp
+format from a [netCDF](https://www.unidata.ucar.edu/software/netcdf/) file.
+While the netCDF format is widely adopted there is no standard or common
+practice for describing cloud properties, whether in terms of data layout,
+variable names or units. The htcp format was developed to circumvent this
+problem: it is a simple file format, independent of netCDF-based data
+formatting, leaving data conversion to third-party translation tools.
+`les2htcp` is one such tool. See `les2htcp.1` for a complete descritpion.
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- netCDF4
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [mandoc](https://mandoc.bsd.lv)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -56,14 +56,14 @@ mixing ratio and the liquid water mixing ratio.
4.4.0.
- Fix compilation errors on systems with GNU C library version less than 2.19.
-## Copyright notice
+## Copyright
-Copyright (C) 2018, 2020-2023 |Méso|Star> (<contact@meso-star.com>)
-Copyright (C) 2018 Centre National de la Recherche Scientifique
+Copyright (C) 2018, 2020-2023 |Méso|Star> (contact@meso-star.com)
+Copyright (C) 2018 Centre National de la Recherche Scientifique
Copyright (C) 2018 Université Paul Sabatier
## License
`htcp` and `les2htcp` are free software released under the GPL v3+ license: GNU
-GPL version 3 or later. You are welcome to redistribute it under certain
+GPL version 3 or later. You are welcome to redistribute them under certain
conditions; refer to the COPYING file for details.
diff --git a/les2htcp.1 b/les2htcp.1
@@ -160,7 +160,7 @@ option to disable file conversion:
.Pp
.Dl les2htcp -c -i clouds.nc -q
.Sh SEE ALSO
-.Xr htrdr 1
+.Xr htrdr 1 ,
.Xr sysconf 3 ,
.Xr htcp 5
.Sh STANDARDS
