commit 48d5d94b5f5afc8f47e3b8b71eca12cc3685bb36
parent 2c3690c61a1c9abaeca5677c5260fb5b8025f650
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 24 Feb 2026 12:21:10 +0100
Add an example to the star-phor command manual page
Diffstat:
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/doc/star-phor.scd b/doc/star-phor.scd
@@ -46,7 +46,7 @@ Options are as follows:
*-o* _output_
File in which the simulation results will be written. If none is
- specified, star-phor will write to the standard output.
+ specified, star-phor will write to the standard output.
*-t* _threads_count_
Advice on the number of threads to use. By default, star-phor uses all
@@ -65,6 +65,24 @@ The *star-phor* utility exits 0 on success, and >0 if an error occurs.
# EXAMPLES
+Simulate radiative transfer for the system described in the _photoractor.txt_
+file, according to the *star-phor-input*(5) grammar.
+Make the program as detailed as possible (options *-vvv*) and use as many threads
+as there are cores available on the system (default behavior).
+Use 100,000 Monte Carlo realisations to estimate the sensor measurements as
+listed in the _potoreactor.txt_ input file (option *-n*).
+Finally, write the estimated values to the _result.txt_ file, unless this file
+already exists.
+In this case, *star-phor* will stop without performing the calculation and
+return an error.
+This behavior prevents previous results from being accidentally overwritten.
+To force the file to be rewritten, the user should explicitly define the *-f*
+option.
+
+```
+star-phor -vvv -n 100000 -o result.txt potoreactor.sphin
+```
+
# SEE ALSO
_star-phor-input_(5), _sphin_(1)
