aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Garlick <pgarlick@tourbillion-technology.com>2022-02-22 13:24:57 +0000
committerPaul Garlick <pgarlick@tourbillion-technology.com>2022-02-22 13:24:57 +0000
commitfb44e2151126530de4ae2fe61a1cf5324a94ae8f (patch)
tree120b95bd45663884f58136d87bff6623646918b0 /doc
parent047732423715246d86d8e30fa866a8be746e45ee (diff)
downloadfullSWOF-utils-fb44e2151126530de4ae2fe61a1cf5324a94ae8f.tar.gz
doc: List scripts included in package.
* doc/fullswof-utils.texi: Add list.
Diffstat (limited to 'doc')
-rw-r--r--doc/fullswof-utils.texi22
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index e51292b..a4fb8d2 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -9,7 +9,7 @@
This document describes FullSWOF-utils, a set of utility scripts to be
used with the FullSWOF shallow flow solver.
-Copyright @copyright{} 2019 Paul Garlick.
+Copyright @copyright{} 2019, 2020, 2021, 2022 Paul Garlick.
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -62,6 +62,26 @@ The @emph{fullSWOF-utils} package comprises a single top-level directory
and several sub-directories. The package may be installed in the same
location as @emph{FullSWOF} itself or any other convenient location.
+The package contains the following utility scripts:
+
+@enumerate
+@item
+@strong{boundaryProfile.py:} for visualising the topography at the
+domain boundaries.
+
+@item
+@strong{makeBoundary:} for generating boundary condition files.
+
+@item
+@strong{slope.py:} for measuring bed slope.
+
+@item
+@strong{specificPoints.py:} for monitoring the solution process.
+@end enumerate
+
+Instructions for managing a software environment for the utility
+scripts are given in the following sub-sections:
+
@menu
* Requirements::
* Cloning::