schiff

commit 68e6e76a5e7bee22cb5f4046a95a5ffd036f309b
parent 0f08e67c22ab94fed7ce2997f6fb35d8e55a740d
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 23 Mar 2016 11:54:16 +0100

Add examples to the schiff man page

Diffstat:
M
doc/schiff-geometry.5
 | 
2
+-
M
doc/schiff.1
 | 
31
++++++++++++++++++++++++++++++-
M
src/schiff_args.c
 | 
2
+-

3 files changed, 32 insertions(+), 3 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -213,7 +213,7 @@ and spherical soft particles have a fixed radius:
   height: {lognormal: { mu: 1, sigma: 1.5 } }
   slices: 32 # Discretisation in 32 slices
   proba: 1\fR
-.SH NOTE
+.SH NOTES
 .TP
 [1]
 YAML Ain't Markup Language \- http://yaml.org
diff --git a/doc/schiff.1 b/doc/schiff.1
@@ -64,7 +64,7 @@ define the
 file that controls the geometry distribution of the soft particles.
 .TP
 .B \-l \fILENGTH\fR
-caracteristic length in micron of the soft particles.
+characteristic length in micron of the soft particles.
 .TP
 .B \-n \fINUM_THREADS\fR
 hint on the number of threads to use during the integration. By default use as
@@ -80,6 +80,34 @@ do not print the helper message when no \fIFILE\fR is submitted.
 .TP
 .B \-w \fIW0\fR[\fB:\fIW1\fR]...
 list of wavelengths in vacuum (expressed in micron) to integrate.
+.SH EXAMPLES
+Estimate the radiative properties of soft particles whose shape is described in
+the \fBgeometry.yaml\fR file and its optical properties in the
+\fBproperties\fR file. The characteristic length of the soft particle shapes is
+\fB2.3\fR microns and the estimations is performed for the wavelengths
+\fB0.45\fR and the \fB0.6\fR microns. The results are written to the standard
+output:
+.IP " " 4
+$ \fBschiff -i geometry.yaml -l 2.3 -w 0.45:0.6 properties\fR
+.PP
+The soft particles have a characteristic length of 1 and their shape is
+controlled by the \fBmy_geom.yaml\fR file. Their optical properties are read
+from the standard input. The estimated wavelelength is \fB0.66\fR microns and
+the results are written to the \fBmy_result\fR file:
+.IP " " 4
+$ \fBschiff -w 0.66 -l 1.0 -i my_geom.yaml -o my_result\fR
+.PP
+Sample \fB10\fR soft particles whose shape is defined by the \fBgeometry.yaml\fR
+file and write their triangulated geometric data to the \fBtemp_output\fR file.
+Use the
+.BR csplit (1)
+Unix command on the \fBtemp_output\fR file to create 10 files named
+particle<\fINUM\fR>.obj, with NUM in [0, 9], each storing the geometric data of
+a sampled soft particle:
+.IP " " 4
+$ \fBschiff -i geometry.yaml -G 10 -o temp_output\fR
+.br
+$ \fBcsplit temp_output -z /^g\\ / {*} -f particle -b %d.obj\fR
 .SH NOTES
 .TP
 [1]
@@ -99,5 +127,6 @@ Micro-Organisms.  Journal of Quantitative Spectroscopy and Radiative Transfer
 free to change and redistribute it. There is NO WARRANTY, to the extent
 permitted by law.
 .SH SEE ALSO
+.BR csplit (1),
 .BR schiff-geometry (5),
 .BR schiff-output (5)
diff --git a/src/schiff_args.c b/src/schiff_args.c
@@ -72,7 +72,7 @@ print_help(const char* binary)
 "  -i DISTRIB    YAML file that defines the geometry distributions of the soft\n"
 "                particles.\n");
   printf(
-"  -l LENGTH     caracteristic length of the soft particles.\n");
+"  -l LENGTH     characteristic length of the soft particles.\n");
   printf(
 "  -n NTHREADS   hint on the number of threads to use during the integration.\n"
 "                By default use as many threads as CPU cores.\n");