tdocumentation build folder now build, small update to sphere usage - sphere - GPU-based 3D discrete element method algorithm with optional fluid coupling
(HTM) git clone git://src.adamsgaard.dk/sphere
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
(DIR) commit 6570fb41207713393b1bb49301116c3e2c20dfd7
(DIR) parent f18a981647e142f5c889212110e382f9731e4163
(HTM) Author: Anders Damsgaard Christensen <adc@geo.au.dk>
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(-)
---
(DIR) 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
(DIR) 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:func:`sphere.run`, :py:func:`sphere.render`, etc.).
+
+
-After compiling the *sphere* binary (see sub-section \ref{subsec:compilation}), the procedure of a creating and handling a simulation is typically arranged in the following order:
- \item Setup of particle assemblage, physical properties and conditions using the Python API, described in section \ref{sec:ModelSetup}, page \pageref{sec:ModelSetup}.
- \item Execution of *sphere* software, which simulates the particle behavior as a function of time, as a result of the conditions initially specified in the input file. Described in section \ref{sec:Simulation}, page \pageref{sec:Simulation}.
- \item Inspection, analysis, interpretation and visualization of *sphere* output in Python. Described in section \ref{sec:DataAnalysis}, page \pageref{sec:DataAnalysis}.
\subsection{The *sphere* algorithm}
\label{subsec:spherealgo}