commit dbe3d97fc20131d11b80279a41d993f3266b21a3
parent e53a7cc1f139e35cf962e5f2a9039d80d310f63b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 5 Sep 2018 10:18:09 +0200
Add a README file
Diffstat:
| A | README.md | | | 50 | ++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 50 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,50 @@
+# Solstice Post-Process
+
+## Overview
+
+Collection of command-line tools that post-process the outputs of
+[Solstice](https://gitlab.com/meso-star/solstice.git). In addition, this code
+base contains programs that generate input files used for Solstice.
+
+The sources of the post-processing tools are located at the root of the
+repository. Each sub-directories contain the sources of programs used to
+generate the Solstice input files of a specific solar plant.
+
+All these programs are written in standard C, without external dependencies.
+They can thus be compiled by any C compiler that supports the C99 standard.
+Anyway, to simplify the build process on GNU-compliant systems, GNU/Makefiles
+are provided. These Makefiles are used not only to build the programs, but also
+to run solstice simulations on generated input files and to post-process their
+outputs.
+
+## Release notes
+
+### Version 0.3.1
+
+- Fix VTK files generated by `solpp`: data were written as double while the
+ type notified in the VTK file was float.
+
+### Version 0.3
+
+- Handle the update of the file formats introduced by Solstice 0.8.1.
+
+### Version 0.2
+
+- Add the `solmaps` post-processing tool that extracts the maps of flux from
+ the result of a solstice simulation. Each map is then saved in a specific VTK
+ file.
+- Fix the parsing of the per-receiver and per-primary results: the "back-side"
+ estimations where not parsed.
+
+### Version 0.1
+
+- Handle the update of the file formats introduced by Solstice 0.6
+
+## License
+
+Solstice Post-Process is Copyright (C) |Meso|Star> 2017-2018
+(<contact@meso-star.com>). It is released under the GPL v3+ license. It is
+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.
+
