tdocumentation build folder now build, small update to sphere usage - sphere - … | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 6570fb41207713393b1bb49301116c3e2c20dfd7 | |
parent f18a981647e142f5c889212110e382f9731e4163 | |
Author: Anders Damsgaard Christensen <[email protected]> | |
Date: Thu, 6 Dec 2012 22:08:02 +0100 | |
documentation build folder now build, small update to sphere usage | |
Diffstat: | |
M doc/sphinx/Makefile | 3 ++- | |
M doc/sphinx/sphere_internals.rst | 7 +++---- | |
2 files changed, 5 insertions(+), 5 deletions(-) | |
--- | |
diff --git a/doc/sphinx/Makefile b/doc/sphinx/Makefile | |
t@@ -5,7 +5,8 @@ | |
SPHINXOPTS = | |
SPHINXBUILD = sphinx-build | |
PAPER = | |
-BUILDDIR = _build | |
+#BUILDDIR = _build | |
+BUILDDIR = ../ | |
# Internal variables. | |
PAPEROPT_a4 = -D latex_paper_size=a4 | |
diff --git a/doc/sphinx/sphere_internals.rst b/doc/sphinx/sphere_internals.rst | |
t@@ -5,11 +5,10 @@ The *sphere* executable has the following options: | |
.. command-output:: ../../sphere_linux_X86_64 --help | |
+The most common way to invoke *sphere* is however via the Python API (e.g. :py… | |
+ | |
+ | |
-After compiling the *sphere* binary (see sub-section \ref{subsec:compilation})… | |
- \item Setup of particle assemblage, physical properties and conditions… | |
- \item Execution of *sphere* software, which simulates the particle beh… | |
- \item Inspection, analysis, interpretation and visualization of *spher… | |
\subsection{The *sphere* algorithm} | |
\label{subsec:spherealgo} |