commit e44d24fa461ba50e4e3f515eaf604b7a2e172f7b
parent 4f03182367f5bf1e69e8271194ed180a55020ec0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 13 May 2026 14:58:31 +0200
Minor change to the README file
Add a new line after each period that ends a sentence.
This convention follows that of man files written in mdoc, contributes
to the clarity of the source code, and simplifies the tracking of
changes. Updating a sentence may require reformatting it into 72
columns, which affects the entire block of text in question. In this
case, the change is now limited to the single sentence rather than the
entire paragraph.
Diffstat:
| M | README.md | | | 41 | ++++++++++++++++++++++------------------- |
1 file changed, 22 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -2,21 +2,23 @@
Star Schiff is a C library that estimates the radiative properties of
soft particles following an "Approximation Method for Short Wavelength
-or High-Energy Scattering" (L. Schiff, 1956). The Monte Carlo Method is
-used in order to solve Maxwell's equations within Schiff's
-approximation, as presented in
+or High-Energy Scattering" (L. Schiff, 1956).
+The Monte Carlo Method is used in order to solve Maxwell's equations
+within Schiff's approximation, as presented in
[Charon et al.2015](http://www.sciencedirect.com/science/article/pii/S0022407315003283).
The main advantages of using this method are the possibility to address
any shape of particle, and the results are provided with a numerical
-accuracy. The user has therefore the ability to increase the computation
-time to obtain more accurate results if needed.
+accuracy.
+The user has therefore the ability to increase the computation time to
+obtain more accurate results if needed.
Monte Carlo is used to estimate total cross-sections (absorption,
scattering and extinction cross-sections) in addition to the phase
function, its cumulative and its inverse cumulative, for a mixture of
-several particles. These set of particles is defined by its optical
-properties (refractive index, provided at various wavelengths) and a
-geometry distribution that controls the shape of the particles.
+several particles.
+These set of particles is defined by its optical properties (refractive
+index, provided at various wavelengths) and a geometry distribution that
+controls the shape of the particles.
## Prerequisites
@@ -38,31 +40,32 @@ Edit config.mk as needed, then run:
### Version 0.4.1
-Sets the required version of Star-SampPling to 0.12. This version fixes
-compilation errors with gcc 11 but introduces API breaks.
+Sets the required version of Star-SampPling to 0.12.
+This version fixes compilation errors with gcc 11 but introduces API
+breaks.
### Version 0.4
-- Update the `struct sschiff_geometry_distribution` data structure. The
- `sample` function now only samples the particle geometry. Its volume
- scaling is sampled through the new `sample_volume_scaling` function.
+- Update the `struct sschiff_geometry_distribution` data structure.
+ The `sample` function now only samples the particle geometry.
+ Its volume scaling is sampled through the new `sample_volume_scaling`
+ function.
This scaling factor is now sampled at the same frequency than the
particle orientation, i.e. several times per sampled particle
geometry.
-- Relax constraints on the minimum number of scattering angles. It is
+- Relax constraints on the minimum number of scattering angles. It is
now set to 2 rather than 3, i.e. the scattering can be purely forward
or backward.
-- Overall update of the project dependencies. Most notably, the update
- of the Star 3D library drastically improves the performances of
- sampling particles with the same shape.
+- Overall update of the project dependencies.
+ Most notably, the update of the Star 3D library drastically improves
+ the performances of sampling particles with the same shape.
- Add an option to avoid the analytic computations of wide angles.
## Copying
-Copyright (C) 2020, 2021, 2023 |Méso|Star> (contact@meso-star.com)
+Copyright (C) 2020, 2021, 2023 |Méso|Star> (contact@meso-star.com)
Copyright (C) 2015, 2016 Centre National de la Recherche Scientifique
Star-Schiff 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.
-
