commit dbb5171b35e9a6dbb8e6fdd6405e524f6c9aea02
parent e0d16801808d5eab16c594fd9c94ede6899eef17
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 26 Sep 2023 09:49:19 +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 | | | 58 | ++++++++++++++++++++++------------------------------------ |
1 file changed, 22 insertions(+), 36 deletions(-)
diff --git a/README.md b/README.md
@@ -1,42 +1,28 @@
# Rad-Net ATMosphere
-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.
+This C library loads and manages data describing an atmosphere.
-## How to build
+## Requirements
-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),
-[RNSL](https://gitlab.com/meso-star/rnsl),
-[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),
-[Star-Mesh](https://gitlab.com/meso-star/star-mesh),
-[Star-ScatteringFunctions](https://gitlab.com/meso-star/star-sf),
-[Star-UnstructuredVolumetricMesh](https://gitlab.com/meso-star/star-uvm),
-[Star-VoXel](https://gitlab.com/meso-star/star-vx)
-libraries, and on [OpenMP](https://www.openmp.org) 1.2 to parallelize its
-computations. It optionally depends on [scdoc](https://sr.ht/~sircmpwn/scdoc/)
-which, if available, is used to generate the man pages.
+- C compiler
+- POSIX make
+- pkg-config
+- [Rad-Net String List](https://gitlab.com/meso-star/rnsl)
+- [Rad-Net Scattering Functions](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)
+- [Star Mesh](https://gitlab.com/meso-star/star-mesh)
+- [Star Scattering Functions](https://gitlab.com/meso-star/star-sf)
+- [Star Unstructured Volumetric Mesh](https://gitlab.com/meso-star/star-uvm)
+- [Star VoXel](https://gitlab.com/meso-star/star-vx)
-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.
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -54,12 +40,12 @@ Fix several bugs when volumetric meshes of the components are not identical:
When the volumetric meshes were not the same for all components, some voxels
could be "emptied" during the accumulation.
-## Copyright notice
+## Copyrights
Copyright (C) 2022, 2023 Centre National de la Recherche Scientifique
Copyright (C) 2022, 2023 Institut Pierre-Simon Laplace
Copyright (C) 2022, 2023 Institut de Physique du Globe de Paris
-Copyright (C) 2022, 2023 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>)
+Copyright (C) 2022, 2023 [|Méso|Star>](https://www.meso-star.com) (contact@meso-star.com)
Copyright (C) 2022, 2023 Observatoire de Paris
Copyright (C) 2022, 2023 Université de Reims Champagne-Ardenne
Copyright (C) 2022, 2023 Université de Versaille Saint-Quentin
