schiff

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

README.md (2592B)

      1 # Schiff
      2 
      3 The purpose of this program is to estimate the radiative properties of
      4 soft particles with an "Approximation Method for Short Wavelength or
      5 High-Energy Scattering" (L. Schiff, 1956).
      6 It relies on the model detailed in "Monte Carlo Implementation of
      7 Schiff's Approximation for Estimating Radiative Properties of
      8 Homogeneous, Simple\-Shaped and Optically Soft Particles: Application to
      9 Photosynthetic Micro-Organisms"
     10 ([Charon et al. 2015](http://www.sciencedirect.com/science/article/pii/S0022407315003283)).
     11 
     12 ## Prerequisites
     13 - C compiler
     14 - POSIX make
     15 - pkg-config
     16 - [LibYAML](http://pyyaml.org/wiki/LibYAML),
     17 - [RSys](https://www.meso-star.com/git/rsys)
     18 - [Star-3D](https://www.meso-star.com/git/star-3d)
     19 - [Star-Schiff](https://www.meso-star.com/git/star-schiff)
     20 - [Star-SP](https://www.meso-star.com/git/star-sp)
     21 
     22 ## Installation
     23 
     24 Edit config.mk as needed, then run:
     25 
     26     make clean install
     27 
     28 ## Release notes
     29 
     30 ### Version 0.5
     31 
     32 - Replace CMake by Makefile as build system.
     33 - Update compiler and linker flags to increase the security and
     34   robustness of generated binaries.
     35 - Convert the manual from man to mdoc.
     36 - Thoroughly review the man pages to make them clearer.
     37 - Improve the portability of test scripts by converting them from
     38   GNU/Bash to the POSIX shell.
     39 
     40 ### Version 0.4.2
     41 
     42 Sets the required version of Star-SampPling to 0.12.
     43 This version fixes compilation errors with gcc 11 but introduces API
     44 breaks.
     45 
     46 ### Version 0.4.1
     47 
     48 Displays the time spent constructing the geometric distribution, writing
     49 the sampled geometries, and performing the calculations.
     50 
     51 ### Version 0.4
     52 
     53 - Set the minimum number of scattering angles to 2 rather than the
     54   previous and arbitrary limit fixed to 100.
     55 - Fix a bug in the generation of the shape of the helical pipe.
     56 - Update the short help of the command as well as the man pages.
     57 - Add the `-D` option that discards all computations for large
     58   scattering angles.
     59 - Add the `--version` that prints the current version of the `schiff`
     60   command.
     61 
     62 ### Version 0.3.1
     63 
     64 - Reformat the man pages.
     65 
     66 ## License
     67 
     68 Copyright (C) 2015, 2016, 2026 Centre National de la Recherche Scientifique  
     69 Copyright (C) 2026 Clermont Auvergne INP  
     70 Copyright (C) 2026 Institut Mines Télécom Albi-Carmaux  
     71 Copyright (C) 2017, 2019-2021, 2026 |Méso|Star> (contact@meso-star.com)  
     72 Copyright (C) 2026 Université de Lorraine  
     73 Copyright (C) 2026 Université de Toulouse
     74 
     75 Schiff is free software released under the GPL v3+ license: GNU GPL
     76 version 3 or later. You are welcome to redistribute it under certain
     77 conditions; refer to the COPYING file for details.