solstice-pp

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

solpp.1 (3965B)


      1 .\" SPDX-License-Identifier: GPL-3.0-or-later
      2 .\" Copyright (C) 2018-2026 |Méso|Star> (contact@meso-star.com)
      3 .\"
      4 .\" This is free documentation: you can redistribute it and/or modify
      5 .\" it under the terms of the GNU General Public License as published by
      6 .\" the Free Software Foundation, either version 3 of the License, or
      7 .\" (at your option) any later version.
      8 .\"
      9 .\" This manual is distributed in the hope that it will be useful,
     10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     12 .\" GNU General Public License for more details.
     13 .\"
     14 .\" You should have received a copy of the GNU General Public License
     15 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     16 .Dd $Mdocdate$
     17 .Dt SOLPP 1
     18 .Os
     19 .Sh NAME
     20 .Nm solpp
     21 .Nd post-process Solstice simulation results into VTK and OBJ files
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Ar geom
     25 .Ar simul
     26 .Sh DESCRIPTION
     27 .Nm
     28 takes two input files:
     29 .Ar geom ,
     30 the geometry of a solar plant exported by
     31 .Xr solstice 1
     32 when invoked with the
     33 .Fl g
     34 option, and
     35 .Ar simul ,
     36 the results of a
     37 .Xr solstice 1
     38 simulation.
     39 For each simulated sun direction,
     40 .Nm
     41 writes up to three output files.
     42 .Pp
     43 The first output file is a
     44 .Tn VTK
     45 file that maps the simulation results to the meshes of the primary
     46 geometries, i.e.\& the reflectors.
     47 The mapped results include, for instance, the cosine factor of each
     48 reflector or the amount of flux that reaches a receiver from them.
     49 .Pp
     50 The second output file is another
     51 .Tn VTK
     52 file that stores the geometry of the receivers together with their
     53 simulation results, such as their incoming flux or their efficiency.
     54 .Pp
     55 The optional third output file is an
     56 .Tn OBJ
     57 file that stores the meshes of the miscellaneous geometries, i.e.\& the
     58 geometries that are neither receivers nor primary geometries (if any).
     59 .Pp
     60 The resulting files can be visualised and analysed in a data
     61 visualisation tool such as
     62 .Lk https://www.paraview.org ParaView .
     63 .Pp
     64 Where
     65 .Va end
     66 stands for
     67 .Pa primaries.vtk ,
     68 .Pa receivers.vtk ,
     69 or
     70 .Pa miscellaneous.obj
     71 for the 1st, 2nd, and optional 3rd output file respectively, the naming scheme
     72 for the output files depends on the way the sun direction was provided to
     73 .Xr solstice 1 :
     74 .Bl -dash
     75 .It
     76 using the
     77 .Fl D Ar azimuth,elevation
     78 flag: the output file is named after the following pattern:
     79 .Bd -literal -offset indent
     80 printf "%g-%g-%s" azimuth elevation end
     81 .Ed
     82 .It
     83 using the
     84 .Fl L Ar latitude,longitude
     85 and
     86 .Fl T Ar time
     87 flags: the output file is named after the following pattern:
     88 .Bd -literal -offset indent
     89 printf "%g-%g-%s-%s" latitude longitude time end
     90 .Ed
     91 .El
     92 .Sh EXIT STATUS
     93 .Ex -std
     94 .Sh EXAMPLES
     95 Invoke
     96 .Xr solstice 1
     97 to simulate two sun directions on the solar plant described in
     98 .Pa input.yaml .
     99 Then invoke it again to export the geometry of the solar plant for the same sun
    100 directions.
    101 Finally, post-process both outputs with
    102 .Nm :
    103 .Bd -literal -offset indent
    104 solstice -D45,70 -D50,75 -R rcvs.yaml -o simul input.yaml
    105 solstice -D45,70 -D50,75 -g format=obj -o geom input.yaml
    106 solpp geom simul
    107 .Ed
    108 .Pp
    109 Invoke
    110 .Xr solstice 1
    111 to simulate a sun direction defined by a location and a time on the solar plant
    112 described in
    113 .Pa input.yaml .
    114 Then invoke it again to export the geometry of the solar plant for the same sun
    115 direction.
    116 Finally, post-process both outputs with
    117 .Nm :
    118 .Bd -literal -offset indent
    119 solstice -L3,40 -T"2026-08-15T17:20:00" -R rcvs.yaml -o simul input.yaml
    120 solstice -L3,40 -T"2026-08-15T17:20:00" -g format=obj -o geom input.yaml
    121 solpp geom simul
    122 .Ed
    123 .Sh SEE ALSO
    124 .Xr solmaps 1 ,
    125 .Xr solpaths 1 ,
    126 .Xr solppraw 1 ,
    127 .Xr solstice 1 ,
    128 .Xr solstice-output 5 ,
    129 .Xr solstice-receiver 5
    130 .Sh HISTORY
    131 .Nm
    132 was initially developed with funding from the
    133 .Em SOLSTICE LabEx
    134 .Pq Laboratory of Excellence ,
    135 in collaboration with the PROMES Laboratory of the
    136 French National Centre for Scientific Research
    137 .Pq CNRS .
    138 Starting in 2026, a new development effort funded by Ademe is ongoing.