solstice-pp

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

solpaths.1 (2744B)

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