rnatm

Load and structure data describing an atmosphere
git clone git://git.meso-star.fr/rnatm.git
Log | Files | Refs | README | LICENSE

README.md (3470B)


      1 # Rad-Net ATMosphere
      2 
      3 This C library loads and manages data describing an atmosphere.
      4 
      5 ## Requirements
      6 
      7 - C compiler with OpenMP support
      8 - POSIX make
      9 - pkg-config
     10 - [Rad-Net Scattering Functions](https://gitlab.com/meso-star/rnsf)
     11 - [Rad-Net String List](https://gitlab.com/meso-star/rnsl)
     12 - [RSys](https://gitlab.com/vaplv/rsys)
     13 - [Star AeRoSol](https://gitlab.com/meso-star/star-aerosol)
     14 - [Star Buffer](https://gitlab.com/meso-star/star-buffer)
     15 - [Star CorrelatedK](https://gitlab.com/meso-star/star-ck)
     16 - [Star Mesh](https://gitlab.com/meso-star/star-mesh)
     17 - [Star Scattering Functions](https://gitlab.com/meso-star/star-sf)
     18 - [Star Unstructured Volumetric Mesh](https://gitlab.com/meso-star/star-uvm)
     19 - [Star VoXel](https://gitlab.com/meso-star/star-vx)
     20 
     21 ## Installation
     22 
     23 Edit config.mk as needed, then run:
     24 
     25     make clean install
     26 
     27 ## Release notes
     28 
     29 ### Version 0.2
     30 
     31 - Add the rnatm tool to facilitate verification of input data and the
     32   library.
     33   This is actually the `test_rnatm` test, which has become an external
     34   tool to offer users a quick way to verify their system data.
     35 - Improves the building system.
     36   Simplify it by doing everything in one place (the Makefile).
     37   Add macros to control installation subdirectories
     38 
     39 ###  Version 0.1
     40 
     41 - Fix voxelization deadlock.
     42 - Fix of a bug when calculating the octree definition: the definition
     43   should be equal to 0, which would result in an error.
     44 - Fix the calculation of radiative coefficients. They were erroneous
     45   when the gas band overlapped several aerosol bands: the aerosol
     46   average was wrongly reduced to the integration domain.
     47 - Write the man pages directly in mdoc's roff macros, instead of using
     48   the scdoc markup language as a source for man pages.
     49 - Replace CMake by Makefile as build system.
     50 - Update compiler and linker flags to increase the security and
     51   robustness of generated binaries.
     52 - Provide a pkg-config file to link the library as an external
     53   dependency.
     54 
     55 ### Version 0.0.1
     56 
     57 Fix several bugs when volumetric meshes of the components are not
     58 identical:
     59 
     60 - Fix the `rnatm_sample_component` function. The cumulative was
     61   calculated assuming that all components are either present or absent
     62   at the queried position. Thus, the accumulation was only correct when
     63   the volumetric meshes were the same for all components.
     64 - Fix the calculation of the minimum radiative coefficient of a voxel in
     65   the octree. It was simply miscalculated and its value might not be the
     66   minimum.
     67 - Fix the accumulation of radiative coefficients in the voxels of the
     68   octree.  When the volumetric meshes were not the same for all
     69   components, some voxels could be "emptied" during the accumulation.
     70 
     71 ## Copyrights
     72 
     73 Copyright (C) 2022, 2023, 2025 Centre National de la Recherche Scientifique  
     74 Copyright (C) 2022, 2023, 2025 Institut Pierre-Simon Laplace  
     75 Copyright (C) 2022, 2023, 2025 Institut de Physique du Globe de Paris  
     76 Copyright (C) 2022, 2023, 2025 [|Méso|Star>](https://www.meso-star.com) (contact@meso-star.com)  
     77 Copyright (C) 2022, 2023, 2025 Observatoire de Paris  
     78 Copyright (C) 2022, 2023, 2025 Université de Reims Champagne-Ardenne  
     79 Copyright (C) 2022, 2023, 2025 Université de Versaille Saint-Quentin  
     80 Copyright (C) 2022, 2023, 2025 Université Paul Sabatier
     81 
     82 ## License
     83 
     84 Rad-Net Atmosphere is free software released under the GPL v3+ license:
     85 GNU GPL version 3 or later. You are welcome to redistribute it under
     86 certain conditions; refer to the COPYING file for details.