solstice-pp

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

solmaps.1 (2900B)

      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 SOLMAPS 1
     18 .Os
     19 .Sh NAME
     20 .Nm solmaps
     21 .Nd extract and save receiver flux maps from Solstice results
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Op Ar file
     25 .Sh DESCRIPTION
     26 .Nm
     27 reads the results of a
     28 .Xr solstice 1
     29 simulation from
     30 .Ar file
     31 or from standard input whether a filename is provided as an argument or not,
     32 respectively.
     33 It extracts the maps of incoming flux computed by
     34 .Xr solstice 1
     35 for the receivers whose
     36 .Cm per_primitive
     37 flag is enabled.
     38 Refer to
     39 .Xr solstice-receiver 5
     40 for more information.
     41 Each map is then saved in a separate
     42 .Tn VTK
     43 file that can be visualised and analysed in a data
     44 visualisation tool such as
     45 .Lk https://www.paraview.org ParaView .
     46 .Pp
     47 The naming scheme for the output files depends on the way the sun direction was
     48 provided to
     49 .Xr solstice 1 :
     50 .Bl -dash
     51 .It
     52 using the
     53 .Fl D Ar azimuth,elevation
     54 flag: the output file is named after the following pattern:
     55 .Bd -literal -offset indent
     56 printf "%g-%g-%s.vtk" azimuth elevation receiver_name
     57 .Ed
     58 .It
     59 using the
     60 .Fl L Ar latitude,longitude
     61 and
     62 .Fl T Ar time
     63 flags: the output file is named after the following pattern:
     64 .Bd -literal -offset indent
     65 printf "%g-%g-%s-%s.vtk" latitude longitude time receiver_name
     66 .Ed
     67 .El
     68 .Sh EXIT STATUS
     69 .Ex -std
     70 .Sh EXAMPLES
     71 Pipe
     72 .Xr solstice 1
     73 with
     74 .Nm
     75 to extract the flux maps of the receivers for each provided sun direction:
     76 .Bd -literal -offset indent
     77 solstice -D45,70 -D50,75 -R rcvs.yaml input.yaml | solmaps
     78 .Ed
     79 .Pp
     80 First, invoke
     81 .Xr solstice 1
     82 to write the results to
     83 .Pa output ,
     84 then run
     85 .Nm
     86 on this file to extract the flux maps of the receivers for the provided sun
     87 direction:
     88 .Bd -literal -offset indent
     89 solstice -L3,40 -T"2026-08-15T17:20:00" -R rcvs.yaml -o output input.yaml
     90 solmaps output
     91 .Ed
     92 .Sh SEE ALSO
     93 .Xr solpaths 1 ,
     94 .Xr solpp 1 ,
     95 .Xr solppraw 1 ,
     96 .Xr solstice 1 ,
     97 .Xr solstice-output 5 ,
     98 .Xr solstice-receiver 5
     99 .Sh HISTORY
    100 .Nm
    101 was initially developed with funding from the
    102 .Em SOLSTICE LabEx
    103 .Pq Laboratory of Excellence ,
    104 in collaboration with the PROMES Laboratory of the
    105 French National Centre for Scientific Research
    106 .Pq CNRS .
    107 Starting in 2026, a new development effort funded by Ademe is ongoing.