aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Garlick <pgarlick@tourbillion-technology.com>2020-06-24 15:19:23 +0100
committerPaul Garlick <pgarlick@tourbillion-technology.com>2020-06-24 15:19:23 +0100
commitdced17f28ddda9e5628d39cd87d7aff07632c940 (patch)
treed8f985a25575615de47235229067adb102d6b55c
parent196fc6429d713dd2548de27f04eb42db18d7dc2b (diff)
downloadfullSWOF-utils-dced17f28ddda9e5628d39cd87d7aff07632c940.tar.gz
doc: Add list of runtime dependencies.
* doc/fullswof-utils.texi (Runtime Dependencies): Add dependencies.
-rw-r--r--doc/fullswof-utils.texi19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi
index c19f706..0cac4a5 100644
--- a/doc/fullswof-utils.texi
+++ b/doc/fullswof-utils.texi
@@ -147,10 +147,29 @@ ln -s /path/to/installation/directory/python/makeBoundary
* Runtime Dependencies::
@end menu
+
@node Runtime Dependencies, , Usage, Usage
@comment node-name, next, previous, up
@section Runtime Dependencies
+The @emph{fullSWOF-utils} programs utilise functions provided by the
+@emph{Python Standard Library}. @emph{FullSWOF-utils} will be able to
+access these functions on systems that have the @emph{python} package
+installed. In addition extra packages are required by the individual
+programs as follows:
+
+@table @command
+@item makeBoundary:
+@enumerate
+@item
+@url{https://matplotlib.org/, Matplotlib}, a library for
+creating plots and visualisations in Python.
+
+@item
+@url{https://numpy.org/, NumPy}, a Python package for scientific
+computation.
+@end enumerate
+@end table
@node GNU Free Documentation License, Index, Usage, Top
@appendix GNU Free Documentation License