commit 521d570cbebe738d902126f39134170f214577ae
parent c84566d204fe58bb82381cf05c40db3fb2d0e6aa
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 18 Jul 2022 14:48:15 +0200
Add the README file
Diffstat:
| A | README.md | | | 49 | +++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 49 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,49 @@
+# Rad-Net ATMopshere
+
+This C library loads and manages data from atmosphere. The gas volumetric mesh
+is described by a [Star-Mesh](https://gitlab.com/meso-star/star-mesh) file
+while its radiative properties are stored in a
+[Star-CorrelatedK](https://gitlab.com/meso-star/star-ck) file. Its temperature
+is recorded per node in a
+[Star-Buffer](https://gitla.com/meso-star/star-buffer) file. Aerosol volumetric
+meshes are also Star-Mesh geometries and their radiative properties are stored
+in [Star-Aerosol](https://gitlab.com/meso-star/star-aerosol) files. The
+properties of the phase functions are finally listed in files following the
+[Rad-Net Scattering Function](https://gitlab.com/meso-star/rnsf) file format.
+
+## How to build
+
+This library is compatible with 64-bits POSIX systems. It relies the
+[CMake](http://www.cmake.org) and the
+[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
+on the [Rad-Net Scattering Function](https://gitlab.com/meso-star/rnsf),
+[RSys](https://gitlab.com/vaplv/rsys/),
+[Star-Aerosol](https://gitlab.com/meso-star/star-aerosol),
+[Star-Buffer](https://gitlab.com/meso-star/star-buffer),
+[Star-CorrelatedK](https://gitlab.com/meso-star/star-ck) and
+[Star-Mesh](https://gitlab.com/meso-star/star-mesh) libraries. It optionally
+depends on [scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if available, is used
+to generate the man pages.
+
+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.
+
+## Copyright notice
+
+Copyright (C) 2022 Centre National de la Recherche Scientifique
+Copyright (C) 2022 Institut de Physique du Globe de Paris
+Copyright (C) 2022 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>)
+Copyright (C) 2022 Université de Reims Champagne-Ardenne
+Copyright (C) 2022 Université de Versaille Saint-Quentin
+Copyright (C) 2022 Université Paul Sabatier (<contact@laplace.univ-tlse.fr>)
+
+## License
+
+Rad-Net Atmosphere is free software released under the GPL v3+ license: GNU GPL
+version 3 or later. You are welcome to redistribute it under certain
+conditions; refer to the COPYING file for details.
