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 (2721B)

      1 # Solstice Post-Process
      2 
      3 Post-processing tools for Solstice outputs and associated tests.
      4 
      5 The sources of the post-processing tools are located in the src directory.
      6 The `themis' test is dynamically generated by building and running a dedicated
      7 code, whose source code is locates in the `themis' subdirectory.
      8 The `cyl' test, that is simple, is run from provided input files.
      9 
     10 All this code is written in C99, with no external dependencies.
     11 It can therefore be compiled by any C compiler that supports the C99 standard.
     12 To simplify compiling on POSIX-compatible systems, POSIX Makefiles are provided.
     13 They can be used not only to build the tools, but also to run solstice tests
     14 and to post-process their results.
     15 
     16 ## Requirements
     17 
     18 - C compiler (C99)
     19 - POSIX make
     20 - Solstice (to run the tests)
     21 
     22 ## How to build
     23 
     24 These programs, as part of the Solstice app suite, can be built on any x86-64
     25 POSIX system.
     26 
     27 Note that you will most likely want to build the entire Solstice suite rather
     28 than these programs alone. If so, a good starting point is the dedicated
     29 [Solstice web page](https://www.meso-star.com/solstice/install.html).
     30 
     31 First ensure that the make utility and a C99 compiler are installed on your
     32 system. Then, edit the config.mk file to meet your needs and build the project
     33 by running:
     34 
     35     make clean install
     36 
     37 ## Quick start
     38 
     39 Two examples are provided in the `cyl` and `themis` directories.
     40 Each contain a Makefile that automates a complete workflow, from scene
     41 generation, to post-processings with the provided tools, passing to
     42 Solstice computation.
     43 
     44 To run the test cases :
     45 
     46     make run
     47 
     48 ## Release notes
     49 
     50 ### Version 0.5
     51 
     52 - Cope with requirements of solstice 0.11, starting with new output format
     53   items.
     54 
     55 - Fix solpp and solppraw crash when reading on stdin.
     56 
     57 - Add man pages.
     58 
     59 ### Version 0.4
     60 
     61 - Replace CMake with a POSIX Makefile.
     62 
     63 ### Version 0.3.1
     64 
     65 - Fix VTK files generated by `solpp`: data were written as double while
     66   the type notified in the VTK file was float.
     67 
     68 ### Version 0.3
     69 
     70 - Handle the update of the file formats introduced by Solstice 0.8.1.
     71 
     72 ### Version 0.2
     73 
     74 - Add the `solmaps` post-processing tool that extracts the maps of flux
     75   from the result of a solstice simulation.
     76   Each map is then saved in a specific VTK file.
     77 - Fix the parsing of the per-receiver and per-primary results: the
     78   "back-side" estimations were not parsed.
     79 
     80 ### Version 0.1
     81 
     82 - Handle the update of the file formats introduced by Solstice 0.6
     83 
     84 ## License
     85 
     86 Copyright (C) 2017, 2018, 2025 |Méso|Star> (contact@meso-star.com)
     87 
     88 This is free softwares released under GPL v3+ license: GNU GPL version 3
     89 or later. You are welcome to redistribute them under certain conditions;
     90 refer to the COPYING file for details.