commit fff05ad796213ead5c10944c935f4364ff895617
parent 2de5f34bf2977e56ad96452d97a05d66ffdc9307
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 19 Oct 2023 16:38:06 +0200
Wraps the README text in 72 columns
This matches the convention of plain text e-mails. It can therefore be
sent as a publication announcement e-mail without being reformatted.
Diffstat:
1 file changed, 15 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
Star-MonteCarlo tries to simplify the calculation of the estimate of a
user-defined integrator. It ensures the idenpendance of random sequences
-between threads and automates the calculation of expectation, variance and
-standard error.
+between threads and automates the calculation of expectation, variance
+and standard error.
## Requirements to build
@@ -23,30 +23,31 @@ Edit config.mk as needed, then run:
### Version 0.5
-Sets the required version of Star-SampPling to 0.12.1. The versions 0.12 and
-highers fix compilation errors with gcc 11 but introduces API breaks: the
-`ssp_rng_type` is no longer a structure but becomes an enumeration.
+Sets the required version of Star-SampPling to 0.12.1. The versions 0.12
+and highers fix compilation errors with gcc 11 but introduces API
+breaks: the `ssp_rng_type` is no longer a structure but becomes an
+enumeration.
### Version 0.4.1
- Add a progress log during computations.
-- Sets the CMake minimum version to 3.1: since CMake 3.20, version 2.8 has
- become obsolete.
+- Sets the CMake minimum version to 3.1: since CMake 3.20, version 2.8
+ has become obsolete.
### Version 0.4
- Remove the raw integration functionality.
- Rename the `max_steps` integrator attribute in `max_realisations`.
- Update the profile of the integrand function of the integrator: the
- identifier of the thread that invokes the integrand is provided has an input
- parameter.
-- Add the `smc_device_get_threads_count` function that returns the maximum
- number of threads used by the device.
+ identifier of the thread that invokes the integrand is provided has an
+ input parameter.
+- Add the `smc_device_get_threads_count` function that returns the
+ maximum number of threads used by the device.
## License
Copyright (C) 2015-2018, 2021-2023 |Méso|Star> (contact@meso-star.com)
-Star-MC is free software released under 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.
+Star-MC is free software released under 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.
