solstice-resources.md (5019B)
1 # Additional resources 2 3 <span id="ABG"/> 4 5 ## Beginner's guide 6 7 The *Solstice Absolute Beginner's Guide* is designed to introduce enough 8 concepts and functionalities that you will be able to autonomously use 9 the Solstice program. 10 The tutorial itself is provided in a pdf file while the Solstice 11 resources on which it relies - i.e. input files \- are available in a 12 separate archive. 13 14 ### Downloads 15 16 - [Beginner's Guide](downloads/Solstice-ABG.pdf) 17 - [Resources](downloads/Solstice-ABG-rsrc.zip) 18 19 ## Post-Processes 20 21 Solstice Post-Process is a collection of command-line tools that 22 post-process the outputs of Solstice. 23 These programs illustrate how the raw-results of Solstice can be 24 processed with respect to the user needs. 25 26 They are free software written in standard C, without external 27 dependency, and released under the GPLv3+ license. 28 You can thus easily study, modify or extend them according to your 29 needs. 30 You are also welcome to redistribute them under certain conditions; 31 refer to the [license](https://www.gnu.org/licenses/gpl.html) 32 for details. 33 34 ### Installation 35 36 To use these tools, they must be built and installed from their source 37 tree: 38 39 git clone https://gitlab.com/meso-star/solstice-pp.git 40 cd solstice-pp 41 make install 42 43 A description of each tools is given in the following sections. 44 45 ### solppraw 46 47 The `solppraw` program reads the Solstice outputs from a file or 48 the standard input whether a filename is provided as an argument or not, 49 respectively. 50 For each simulated sun direction, it formats the raw results in a human 51 readable text file, simplifying the analysis of the results. 52 53 The following example invokes Solstice to simulate two sun directions 54 and write the results in the `output` file that is then post-processed 55 by the `solppraw` tool. 56 57 solstice -D45,70:50,75 -R rcvs.yaml -o output input.yaml 58 solppraw output 59 60 Note that one can directly pipe the results of `solstice` to `solppraw` 61 without any intermediary `output` file. 62 63 solstice -D45,70:50,75 -R rcvs.yaml input.yaml | solppraw 64 65 ### solmaps 66 67 The `solmaps` command line takes as input the results of a 68 regular Solstice simulation. 69 These data are read from a file or from standard input whether a 70 filename is provided as an argument or not, respectively. 71 `solmaps` extracts the maps of incoming flux computed by Solstice 72 for the receivers whose `per_primitive` flag is enabled 73 (see [solstice-receiver(5)](man/man5/solstice-receiver.5.html) for more 74 informations). 75 Each map is then saved in a specific 76 [VTK](http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf) 77 file. 78 79 The following example pipes `solstice` with `solmaps` to save the maps 80 of the receivers `target_a` and `target_b` computed by solstice for each 81 provided sun direction. 82 83 solstice -n10000 -D45,70:50,75 -R rcvs.yaml input.yaml | solmaps 84 85 ### solpaths 86 87 The `solpaths` tool reads the radiative paths dumped by Solstice when it 88 is invoked with the `-p` option. 89 The radiative paths are read from a file or from the standard input, 90 whether a filename is provided as an argument or not, respectively. 91 For each simulated sun direction, it generates a 92 [VTK](http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf) 93 file of the radiative paths. 94 95 The following example illustrates how `solpaths` is piped with 96 `solstice` to generate two VTK files, one per simulated sun direction. 97 98 solstice -n100 -D45,70:50,75 -R rcvs.yaml -p default input.yaml | solpaths 99 100 ### solpp 101 102 The `solpp` program takes two input files: the geometry of a 103 solar plant output by Solstice when it is invoked with the `-g` 104 option, and the results of a legacy Solstice simulation. 105 For each simulated sun direction, it writes three files. 106 The first one, is a 107 [VTK](http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf) 108 file that maps to the meshes of the primary geometries (i.e. the 109 reflectors) their associated simulation results; for instance their 110 respective cosine factor or the amount of flux that reaches a receiver 111 and comes from them. 112 The second output file, is another VTK file that stores the geometry of 113 the receivers and their simulation results as their incoming flux or 114 their efficiency. 115 Finally, the third file is an 116 [OBJ](http://www.martinreddy.net/gfx/3d/OBJ.spec) file that stores the 117 meshes of the miscellaneous geometries, i.e. the geometries that are 118 neither receivers nor primary geometries. 119 These files can then be visualised and analysed in a data visualization 120 tool such as [Paraview](https://www.paraview.org). 121 122 In the following example, `solstice` is invoked to simulate two 123 sun directions on the solar plant described in the `input.yaml` 124 file. 125 Then `solstice` run with the `-g` option to export the geometry of 126 this solar plant with respect to the aforementioned sun directions. 127 Finally `solpp` is invoked to post-process the previous outputs saved in 128 the `simul` and `geom` files. 129 130 solstice -D45,70:50,75 -R rcvs.yaml -o simul input.yaml 131 solstice -D45,70:50,75 -g format=obj -o geom input.yaml 132 solpp geom simul