commit c7749d8f198d4f300aac688f8fc21ea002d4cffe
parent e0d33b54612fe1f723c8660a6ccc507d3cad82ba
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 4 Sep 2026 11:20:07 +0200
Improve general introduction in the project README
Diffstat:
| M | README.md | | | 38 | ++++++++++++++++---------------------- |
1 file changed, 16 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
@@ -1,34 +1,28 @@
# Solstice Post-Process
-Solstice resuts post-processing tools.
-In addition, the code base contains programs that generate input files
-for systems to be simulated by Solstice.
-
-The sources of the post-processing tools are located at the root of the
-repository.
-Each sub-directory contains the sources of the programs used to generate
-the Solstice input files for a specific solar power plant.
-
-All these programs are written in standard C, with no external
-dependencies.
-They can therefore be compiled by any C compiler that supports the C99
-standard.
-However, to simplify the compilation process on POSIX-compatible
-systems, POSIX Makefiles are supplied.
-These are used not only to build the programs, but also to run solstice
-simulations on the generated input files and to post-process their
-results.
+Post-processing tools for Solstice outputs and associated tests.
+
+The sources of the post-processing tools are located in the src directory.
+The `themis' test is dynamically generated by building and running a dedicated
+code, whose source code is locates in the `themis' subdirectory.
+The `cyl' test, that is simple, is run from provided input files.
+
+All this code is written in C99, with no external dependencies.
+It can therefore be compiled by any C compiler that supports the C99 standard.
+To simplify compiling on POSIX-compatible systems, POSIX Makefiles are provided.
+They can be used not only to build the tools, but also to run solstice tests
+and to post-process their results.
## Requirements
- C compiler (C99)
- POSIX make
-- Solstice (optional for test cases)
+- Solstice (to run the tests)
## How to build
-These programs, as part of the Solstice app suite, can be built on any x86-64 POSIX
-system.
+These programs, as part of the Solstice app suite, can be built on any x86-64
+POSIX system.
Note that you will most likely want to build the entire Solstice suite rather
than these programs alone. If so, a good starting point is the dedicated
@@ -43,7 +37,7 @@ by running:
## Quick start
Two examples are provided in the `cyl` and `themis` directories.
-Each contain a Makefile that automate a complete workflow, from scene
+Each contain a Makefile that automates a complete workflow, from scene
generation, to post-processings with the provided tools, passing to
Solstice computation.
