schiff

Estimate the radiative properties of soft particless
git clone git://git.meso-star.com/schiff.git
Log | Files | Refs | README | LICENSE

README.md (1888B)


      1 # Schiff
      2 
      3 The purpose of this program is to estimate the radiative properties of soft
      4 particles with an "Approximation Method for Short Wavelength or High-Energy
      5 Scattering" (L. Schiff, 1956). It relies on the model detailed in "Monte Carlo
      6 Implementation of Schiff's Approximation for Estimating Radiative Properties of
      7 Homogeneous, Simple\-Shaped and Optically Soft Particles: Application to
      8 Photosynthetic Micro-Organisms"
      9 ([Charon et al. 2015](http://www.sciencedirect.com/science/article/pii/S0022407315003283)).
     10 
     11 ## How to build
     12 
     13 The library relies on the [CMake](http://www.cmake.org) and the
     14 [RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also depends
     15 on the
     16 [LibYAML](http://pyyaml.org/wiki/LibYAML),
     17 [RSys](https://gitlab.com/vaplv/rsys/),
     18 [Star-3D](https://gitlab.com/meso-star/star-3d/),
     19 [Star-Schiff](https://gitlab.com/meso-star/star-schiff/) and
     20 [Star-SP](https://gitlab.com/meso-star/star-sp/) libraries.
     21 
     22 First ensure that CMake is installed on your system. Then install the RCMake
     23 package as well as all the aforementioned prerequisites. Then generate the
     24 project from the `cmake/CMakeLists.txt` file by appending to the
     25 `CMAKE_PREFIX_PATH` variable the install directories of its dependencies.
     26 
     27 ## How to use
     28 
     29 Refer to the
     30 [manual pages](https://gitlab.com/meso-star/schiff/tree/master/doc)
     31 for informations on the schiff program, the list of its options and the file
     32 formats on which it relies.
     33 
     34 ## Release notes
     35 
     36 ### Version 0.3.1
     37 
     38 - Reformat the man pages.
     39 
     40 ## License
     41 
     42 Schiff is developed by [|Meso|Star>](http://www.meso-star.com) for the
     43 the [National Center for Scientific Research](http://www.cnrs.fr/index.php)
     44 (CNRS). It is a free software copyright (C) CNRS 2015-2016 released under the
     45 [OSI](http://opensource.org)-approved GPLv3+ license. You are welcome to
     46 redistribute it under certain conditions; refer to the COPYING file for
     47 details.