commit 75a6dd8d141a5ead0c4ec497414a3f8f5c077320
parent 6bc8c7ce33f1de7f9b59cbe031a9d2d4f628cf83
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 14 Sep 2023 18:23:42 +0200
Rewrite the README file
Small changes to the overview. 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 | | | 59 | +++++++++++++++++------------------------------------------ |
1 file changed, 17 insertions(+), 42 deletions(-)
diff --git a/README.md b/README.md
@@ -1,50 +1,25 @@
# High-Tune: Sky
-This library loads and manages data representing a clear/cloudy sky. The
-atmospheric gas mixture is loaded from a
-[HTGOP](https://gitlab.com/meso-star/htgop) file while cloud properties are
-loaded from data stored with respect to the
-[HTCP](https://gitlab.com/meso-star/htcp/) fileformat. The optical properties
-of the clouds are finally retrieved from a
-[HTMie](https://gitlab.com/meso-star/htmie/) file. Once provided, the clouds
-can be repeated infinitely into the X and Y dimension.
-
-HTSky relies onto the [Star-VX](https://gitlab.com/meso-star/star-vx) library
-to build space partitioning data structures upon raw sky data. These structures
-can then be used in conjunction of null-collision algorithms to accelerate the
-tracking of a ray into this inhomogeneous medium, as described in [Villefranque
-et al.
-(2019)](https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2018MS001602).
-These accelerating structures are built with respect to an optical thickness
-criterion whose threshold is user defined. One can also fix the maximum
-resolution of the structures in order to constraint their memory consumption.
-Even though the building itself of the structures is quite efficient, computing
-their underlying data from the input files can be time consuming. So, once
-built, these structures can be stored into a file to drastically speed up the
-subsequent initialisation steps of the same sky. We point out that this file is
-valid as long as the provided HTGOP, HTCP and HTMie files are the ones used to
-build the cached structures. If not, an error is returned on sky creation.
+This C library loads and manages the data describing a verticaly stratified
+atmosphere, neglecting Earth's sphericity. The physical properties of 3D clouds
+are also supported.
## How to build
-This library is compatible GNU/Linux 64-bits. It relies on the
-[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build.
-It also depends on the
-[HTCP](https://gitlab.com/meso-star/htcp/),
-[HTGOP](https://gitlab.com/meso-star/htgop/),
-[HTMie](https://gitlab.com/meso-star/htmie/),
-[RSys](https://gitlab.com/vaplv/rsys/) and
-[Star-VX](https://gitlab.com/meso-star/star-vx/) libraries, and on
-[OpenMP](http://www.openmp.org) 1.2 to parallelize its computations.
-
-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 documentation](https://cmake.org/documentation)
-for further informations on CMake.
+- C compiler with OpenMP support
+- POSIX make
+- pkg-config
+- [High-Tune: Cloud Properties](https://gitlab.com/meso-star/htcp)
+- [High-Tune: Gas Optical Properties](https://gitlab.com/meso-star/htgop)
+- [High-Tune: Mie](https://gitlab.com/meso-star/htmie)
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star VoXel](https://gitlab.com/meso-star/star-vx)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
