solstice-pp

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

solppraw.1 (2635B)

      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 SOLPPRAW 1
     18 .Os
     19 .Sh NAME
     20 .Nm solppraw
     21 .Nd format raw Solstice results into human readable text
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Op Ar file
     25 .Sh DESCRIPTION
     26 .Nm
     27 reads the
     28 .Xr solstice 1
     29 outputs from
     30 .Ar file
     31 or from standard input whether a filename is provided as an argument or not,
     32 respectively.
     33 For each simulated sun direction, it formats the raw results into a human
     34 readable text file, simplifying the analysis of the results.
     35 .Pp
     36 The naming scheme for the output files depends on the way the sun direction was
     37 provided to
     38 .Xr solstice 1 :
     39 .Bl -dash
     40 .It
     41 using the
     42 .Fl D Ar azimuth,elevation
     43 flag: the output file is named after the following pattern:
     44 .Bd -literal -offset indent
     45 printf "%g-%g-raw-results.txt" azimuth elevation
     46 .Ed
     47 .It
     48 using the
     49 .Fl L Ar latitude,longitude
     50 and
     51 .Fl T Ar time
     52 flags: the output file is named after the following pattern:
     53 .Bd -literal -offset indent
     54 printf "%g-%g-%s-results.txt" latitude longitude time
     55 .Ed
     56 .El
     57 .Sh EXIT STATUS
     58 .Ex -std
     59 .Sh EXAMPLES
     60 Invoke
     61 .Xr solstice 1
     62 to simulate two sun directions and pipe the results directly to
     63 .Nm ,
     64 without any intermediary file:
     65 .Bd -literal -offset indent
     66 solstice -D45,70 -D50,75 -R rcvs.yaml input.yaml | solppraw
     67 .Ed
     68 .Pp
     69 Alternatively, invoke
     70 .Xr solstice 1
     71 to simulate a sun direction and write the results to the
     72 .Pa output
     73 file, then post-process it with solppraw:
     74 .Bd -literal -offset indent
     75 solstice -L3,40 -T"2026-08-15T17:20:00" -R rcvs.yaml -o output input.yaml
     76 solppraw output
     77 .Ed
     78 .Sh SEE ALSO
     79 .Xr solmaps 1 ,
     80 .Xr solpaths 1 ,
     81 .Xr solpp 1 ,
     82 .Xr solstice 1 ,
     83 .Xr solstice-output 5
     84 .Sh HISTORY
     85 .Nm
     86 was initially developed with funding from the
     87 .Em SOLSTICE LabEx
     88 .Pq Laboratory of Excellence ,
     89 in collaboration with the PROMES Laboratory of the
     90 French National Centre for Scientific Research
     91 .Pq CNRS .
     92 Starting in 2026, a new development effort funded by Ademe is ongoing.