commit 6a5c7fd4b5014a0d1f25df72f557b1477b8fff71 parent a3fc7537eee74c31bbecd3e63c227709b7142c18 Author: Vincent Forest <vincent.forest@meso-star.com> Date: Mon, 18 Jul 2016 10:22:19 +0200 Add a README file Diffstat:
| A | README.md | | | 35 | +++++++++++++++++++++++++++++++++++ |
1 file changed, 35 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,35 @@ +# Solstice Solver + +The purpose of this library is to integrate the solar flux in complex solar +facilities. It has been developed in the scope of the Solstice project, in +collaboration with the +[Laboratory of Excellence Solstice](http://www.labex-solstice.fr) and the +[PROMES](http://www.promes.cnrs.fr/index.php?page=home-en) laboratory of the +National Center for Scientific Research ([CNRS](http://www.cnrs.fr/index.php)). + +## How to build + +The Solstice-Solver library relies on the [CMake](http://www.cmake.org) and the +[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. +It also depends on the +[RSys](https://gitlab.com/vaplv/rsys/), +[Star-3D](https://gitlab.com/meso-star/star-3d/) and +[Star-SP](https://gitlab.com/meso-star/star-sp/) libraries as well as on the +[OpenMP](http://www.openmp.org) 1.2 specification to parallelize its +computations. + +First ensure that CMake and a compiler that implements the OpenMP 1.2 +specification are installed on your system. Then install the RCMake package as +well as all the aforementioned prerequisites. Finally generate the project from +the `cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH` +variable the install directories of its dependencies. + +## Licenses + +Solstice-Solver is developed by [|Meso|Star>](http://www.meso-star.com) for the +[National Center for Scientific Research](http://www.cnrs.fr/index.php) (CNRS). +It is a free software copyright (C) CNRS 2016 and it is released under the +[OSI](http://opensource.org)-approved GPL v3+ license. You are welcome to +redistribute it under certain conditions; refer to the COPYING file for +details. +