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