solstice-pp

Post-processing utilities for the solstice app
git clone git://git.meso-star.com/solstice-pp.git
Log | Files | Refs | README | LICENSE

README.md (2140B)

      1 # Solstice Post-Process
      2 
      3 Solstice resuts post-processing tools.
      4 In addition, the code base contains programs that generate input files
      5 for systems to be simulated by Solstice.
      6 
      7 The sources of the post-processing tools are located at the root of the
      8 repository.
      9 Each sub-directory contains the sources of the programs used to generate
     10 the Solstice input files for a specific solar power plant.
     11 
     12 All these programs are written in standard C, with no external
     13 dependencies.
     14 They can therefore be compiled by any C compiler that supports the C99
     15 standard.
     16 However, to simplify the compilation process on POSIX-compatible
     17 systems, POSIX Makefiles are supplied.
     18 These are used not only to build the programs, but also to run solstice
     19 simulations on the generated input files and to post-process their
     20 results.
     21 
     22 ## Requirements
     23 
     24 - C compiler (C99)
     25 - POSIX make
     26 - Solstice (optional for test cases)
     27 
     28 ## Installation
     29 
     30 Edit config.mk as needed, then run:
     31 
     32     make clean install
     33 
     34 ## Quick start
     35 
     36 Two examples are provided in the `cyl` and `themis` directories.
     37 Each contain a Makefile that automate a complete workflow, from scene
     38 generation, to post-processings with the provided tools, passing to
     39 Solstice computation.
     40 
     41 To run the test cases :
     42 
     43     make run
     44 
     45 ## Release notes
     46 
     47 ### Version 0.3.1
     48 
     49 - Fix VTK files generated by `solpp`: data were written as double while
     50   the type notified in the VTK file was float.
     51 
     52 ### Version 0.3
     53 
     54 - Handle the update of the file formats introduced by Solstice 0.8.1.
     55 
     56 ### Version 0.2
     57 
     58 - Add the `solmaps` post-processing tool that extracts the maps of flux
     59   from the result of a solstice simulation.
     60   Each map is then saved in a specific VTK file.
     61 - Fix the parsing of the per-receiver and per-primary results: the
     62   "back-side" estimations were not parsed.
     63 
     64 ### Version 0.1
     65 
     66 - Handle the update of the file formats introduced by Solstice 0.6
     67 
     68 ## License
     69 
     70 Copyright (C) 2017, 2018, 2025 |Méso|Star> (contact@meso-star.com)
     71 
     72 This is free softwares released under GPL v3+ license: GNU GPL version 3
     73 or later. You are welcome to redistribute them under certain conditions;
     74 refer to the COPYING file for details.