commit 1fec59e83a142e5a3fa57bb559a5f70640b3a054
parent 65bbeb2f56457fa031ba4e926b10779fb5246836
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Thu, 30 Jul 2026 16:53:19 +0200
Replace solstice-pp description by the man pages
As solstice-pp have now individual man pages, remove description from
'Additional resources' page and link man pages from the 'Manual pages'
page.
Diffstat:
2 files changed, 16 insertions(+), 102 deletions(-)
diff --git a/solstice/solstice-docs.md b/solstice/solstice-docs.md
@@ -1,6 +1,15 @@
# Reference documentation
+## Solstice app
+
- [solstice(1)](man/man1/solstice.1.html)
- [solstice-input(5)](man/man5/solstice-input.5.html)
- [solstice-output(5)](man/man5/solstice-output.5.html)
- [solstice-receiver(5)](man/man5/solstice-receiver.5.html)
+
+## Post-Process utilities
+
+- [solppraw(1)](man/man1/solppraw.1.html)
+- [solmaps(1)](man/man1/solmaps.1.html)
+- [solpaths(1)](man/man1/solpaths.1.html)
+- [solpp(1)](man/man1/solpp.1.html)
diff --git a/solstice/solstice-resources.md b/solstice/solstice-resources.md
@@ -25,109 +25,14 @@ These programs illustrate how the raw-results of Solstice can be
processed with respect to the user needs.
They are free software written in standard C, without external
-dependency, and released under the GPLv3+ license.
+dependency, and released under the
+[GPLv3+ license](https://www.gnu.org/licenses/gpl.html).
You can thus easily study, modify or extend them according to your
needs.
-You are also welcome to redistribute them under certain conditions;
-refer to the [license](https://www.gnu.org/licenses/gpl.html)
-for details.
-### Installation
+They are built and installed alonside Solstice, and their source
+code is hosted in a dedicated
+[git repository](https://www.meso-star.com/git/solstice-pp).
-To use these tools, they must be built and installed from their source
-tree:
-
- git clone https://gitlab.com/meso-star/solstice-pp.git
- cd solstice-pp
- make install
-
-A description of each tools is given in the following sections.
-
-### solppraw
-
-The `solppraw` program reads the Solstice outputs from a file or
-the standard input whether a filename is provided as an argument or not,
-respectively.
-For each simulated sun direction, it formats the raw results in a human
-readable text file, simplifying the analysis of the results.
-
-The following example invokes Solstice to simulate two sun directions
-and write the results in the `output` file that is then post-processed
-by the `solppraw` tool.
-
- solstice -D45,70:50,75 -R rcvs.yaml -o output input.yaml
- solppraw output
-
-Note that one can directly pipe the results of `solstice` to `solppraw`
-without any intermediary `output` file.
-
- solstice -D45,70:50,75 -R rcvs.yaml input.yaml | solppraw
-
-### solmaps
-
-The `solmaps` command line takes as input the results of a
-regular Solstice simulation.
-These data are read from a file or from standard input whether a
-filename is provided as an argument or not, respectively.
-`solmaps` extracts the maps of incoming flux computed by Solstice
-for the receivers whose `per_primitive` flag is enabled
-(see [solstice-receiver(5)](man/man5/solstice-receiver.5.html) for more
-informations).
-Each map is then saved in a specific
-[VTK](http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf)
-file.
-
-The following example pipes `solstice` with `solmaps` to save the maps
-of the receivers `target_a` and `target_b` computed by solstice for each
-provided sun direction.
-
- solstice -n10000 -D45,70:50,75 -R rcvs.yaml input.yaml | solmaps
-
-### solpaths
-
-The `solpaths` tool reads the radiative paths dumped by Solstice when it
-is invoked with the `-p` option.
-The radiative paths are read from a file or from the standard input,
-whether a filename is provided as an argument or not, respectively.
-For each simulated sun direction, it generates a
-[VTK](http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf)
-file of the radiative paths.
-
-The following example illustrates how `solpaths` is piped with
-`solstice` to generate two VTK files, one per simulated sun direction.
-
- solstice -n100 -D45,70:50,75 -R rcvs.yaml -p default input.yaml | solpaths
-
-### solpp
-
-The `solpp` program takes two input files: the geometry of a
-solar plant output by Solstice when it is invoked with the `-g`
-option, and the results of a legacy Solstice simulation.
-For each simulated sun direction, it writes three files.
-The first one, is a
-[VTK](http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf)
-file that maps to the meshes of the primary geometries (i.e. the
-reflectors) their associated simulation results; for instance their
-respective cosine factor or the amount of flux that reaches a receiver
-and comes from them.
-The second output file, is another VTK file that stores the geometry of
-the receivers and their simulation results as their incoming flux or
-their efficiency.
-Finally, the third file is an
-[OBJ](http://www.martinreddy.net/gfx/3d/OBJ.spec) file that stores the
-meshes of the miscellaneous geometries, i.e. the geometries that are
-neither receivers nor primary geometries.
-These files can then be visualised and analysed in a data visualization
-tool such as [Paraview](https://www.paraview.org).
-
-In the following example, `solstice` is invoked to simulate two
-sun directions on the solar plant described in the `input.yaml`
-file.
-Then `solstice` run with the `-g` option to export the geometry of
-this solar plant with respect to the aforementioned sun directions.
-Finally `solpp` is invoked to post-process the previous outputs saved in
-the `simul` and `geom` files.
-
- solstice -D45,70:50,75 -R rcvs.yaml -o simul input.yaml
- solstice -D45,70:50,75 -g format=obj -o geom input.yaml
- solpp geom simul
+See their [dedicated man pages](solstice-docs.html) for a detailed
+description.
