htcp

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

README.md (2735B)

      1 # High-Tune: Cloud Properties
      2 
      3 This project defines a file format for storing the properties of liquid
      4 water suspended in clouds. See `htcp.5` for the format specification. A
      5 C library is provided for loading files in this format.
      6 
      7 To facilitate interoperability, the `les2htcp` tool converts data to
      8 htcp format from a
      9 [netCDF](https://www.unidata.ucar.edu/software/netcdf/) file. While the
     10 netCDF format is widely adopted there is no standard or common practice
     11 for describing cloud properties, whether in terms of data layout,
     12 variable names or units. The htcp format was developed to circumvent
     13 this problem: it is a simple file format, independent of netCDF-based
     14 data formatting, leaving data conversion to third-party translation
     15 tools. `les2htcp` is one such tool. See `les2htcp.1` for a complete
     16 descritpion.
     17 
     18 ## Requirements
     19 
     20 - C compiler
     21 - POSIX make
     22 - pkg-config
     23 - netCDF4
     24 - [RSys](https://gitlab.com/vaplv/rsys)
     25 - [mandoc](https://mandoc.bsd.lv)
     26 
     27 ## Installation
     28 
     29 Edit config.mk as needed, then run:
     30 
     31     make clean install
     32 
     33 ## Release notes
     34 
     35 ### Version 0.2
     36 
     37 - Make corrections to manual pages.
     38 - Improve the build system.
     39   Simplify it by doing everything in one place (the Makefile).
     40   Add macros to control installation sub-directories.
     41 
     42 ### Version 0.1
     43 
     44 - Write the man pages directly in mdoc's roff macros, instead of using
     45   the intermediate scdoc source.
     46 - Replace CMake by Makefile as build system.
     47 - Update compiler and linker flags to increase the security and
     48   robustness of generated binaries.
     49 - Provide a pkg-config file to link the library as an external
     50   dependency.
     51 
     52 ### Version 0.0.5
     53 
     54 Fix a typo in the les2htcp man page
     55 
     56 ### Version 0.0.4
     57 
     58 - Use scdoc rather than asciidoc as file format for man sources.
     59 - Make internal shell scripts POSIX compliant.
     60 
     61 ### Version 0.0.3
     62 
     63 - Fix a man page error: the RCT field was named "liquid vapor mixing
     64   report" rather than "liquid _water_ mixing report".
     65 - Miscellaneous minor corrections to log messages.
     66 
     67 ### Version 0.0.2
     68 
     69 Fix the les2htcp man page. The units were incorrect for the water vapor
     70 mixing ratio and the liquid water mixing ratio.
     71 
     72 ### Version 0.0.1
     73 
     74 - Fix warnings and compilation errors when using the netCDF library in
     75   version 4.4.0.
     76 - Fix compilation errors on systems with GNU C library version less than
     77   2.19.
     78 
     79 ## Copyright
     80 
     81 Copyright (C) 2018, 2020-2023, 2025, 2025 |Méso|Star> (contact@meso-star.com)  
     82 Copyright (C) 2018 Centre National de la Recherche Scientifique  
     83 Copyright (C) 2018 Université Paul Sabatier
     84 
     85 ## License
     86 
     87 `htcp` and `les2htcp` are free software released under the GPL v3+
     88 license: GNU GPL version 3 or later. You are welcome to redistribute
     89 them under certain conditions; refer to the COPYING file for details.