tIntroduction finished - sphere - GPU-based 3D discrete element method algorith… | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit b9800d3a2ef6aa3ec0a0bbf31643f7968d03e01f | |
parent 47d72c195f6a1da29ff8d6dc6ed5c2bb475b6e45 | |
Author: Anders Damsgaard Christensen <[email protected]> | |
Date: Thu, 6 Dec 2012 08:09:10 +0100 | |
Introduction finished | |
Diffstat: | |
M doc/sphinx/Makefile | 13 +++++++------ | |
M doc/sphinx/conf.py | 2 +- | |
M doc/sphinx/index.rst | 5 +++-- | |
M doc/sphinx/introduction.rst | 59 +++++++++++++++++++++++++++--… | |
4 files changed, 63 insertions(+), 16 deletions(-) | |
--- | |
diff --git a/doc/sphinx/Makefile b/doc/sphinx/Makefile | |
t@@ -16,7 +16,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp… | |
-default: doxygen-xml html | |
+default: html | |
help: | |
@echo "Please use \`make <target>' where <target> is one of" | |
t@@ -43,14 +43,15 @@ help: | |
clean: | |
-rm -rf $(BUILDDIR)/* | |
-doxygen-xml: ../doxygen/Makefile ../doxygen/Doxyfile | |
- $(MAKE) -C ../doxygen/ | |
-html: | |
+html: doxygen-xml | |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | |
@echo | |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | |
+doxygen-xml: ../doxygen/Makefile ../doxygen/Doxyfile | |
+ $(MAKE) -C ../doxygen/ | |
+ | |
dirhtml: | |
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | |
@echo | |
t@@ -100,14 +101,14 @@ epub: | |
@echo | |
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." | |
-latex: | |
+latex: doxygen-xml | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo | |
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | |
@echo "Run \`make' in that directory to run these through (pdf)latex" \ | |
"(use \`make latexpdf' here to do that automatically)." | |
-latexpdf: | |
+latexpdf: doxygen-xml | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo "Running LaTeX files through pdflatex..." | |
$(MAKE) -C $(BUILDDIR)/latex all-pdf | |
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py | |
t@@ -32,7 +32,7 @@ sys.path.insert(0, os.path.abspath('../../python/')) | |
# Add any Sphinx extension module names here, as strings. They can be extensio… | |
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
#extensions = [] | |
-extensions = ['sphinx.ext.autodoc','breathe'] | |
+extensions = ['sphinx.ext.autodoc','breathe','sphinx.ext.pngmath'] | |
breathe_projects = { "sphere": "../doxygen/xml/" } | |
breathe_default_project = "sphere" | |
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst | |
t@@ -9,7 +9,7 @@ This is the official documentation for the *sphere* discrete e… | |
*sphere* is developed by Anders Damsgaard Christensen under supervision of Dav… | |
-Contact: Anders Damsgaard Christensen, http://cs.au.dk/~adc, [email protected] | |
+Contact: Anders Damsgaard Christensen, `<http://cs.au.dk/~adc>`_, `<[email protected]… | |
Contents: | |
t@@ -27,7 +27,8 @@ Contents: | |
Indices and tables | |
================== | |
+.. * :ref:`modindex` | |
+ | |
* :ref:`genindex` | |
-* :ref:`modindex` | |
* :ref:`search` | |
diff --git a/doc/sphinx/introduction.rst b/doc/sphinx/introduction.rst | |
t@@ -1,14 +1,59 @@ | |
Introduction | |
============ | |
-The \texttt{SPHERE}-software is used for three-dimensional discrete element me… | |
+The *sphere*-software is used for three-dimensional discrete element method (D… | |
+The ultimate aim of the *sphere* software is to simulate soft-bedded subglacia… | |
-The ultimate aim of the \texttt{SPHERE} software is to simulate soft-bedded su… | |
+The purpose of this documentation is to provide the user with a thorough walk-… | |
-* UNIX, Linux or Mac OS X operating system. | |
-* GCC, the GNU compiler collection. | |
-* A CUDA-enabled GPU with compute capability 1.1 or greater\footnote{See \url{… | |
-* The CUDA Developer Drivers and the CUDA Toolkit\footnote{Obtainable free of … | |
+.. note:: Command examples in this document starting with the symbol ``$`` are… | |
-For simulation setup and data handling, a Python distribution of a recent vers… | |
+All numerical values in this document, the source code, and the configuration … | |
+Requirements | |
+------------ | |
+The build requirements are: | |
+ * A Nvidia CUDA-supported version of Linux or Mac OS X (see the `CUDA toolki… | |
+ * `GNU Make <https://www.gnu.org/software/make/>`_ | |
+ * The `GNU Compiler Collection <http://gcc.gnu.org/>`_ (GCC) | |
+ * The `Nvidia CUDA toolkit and SDK <https://developer.nvidia.com/cuda-downlo… | |
+ | |
+The runtime requirements are: | |
+ * A `CUDA-enabled GPU <http://www.nvidia.com/object/cuda_gpus.html>`_ with c… | |
+ * A Nvidia CUDA-enabled GPU and device driver | |
+ | |
+Optional tools, required for simulation setup and data processing: | |
+ * `Python 2.7 <http://www.python.org/getit/releases/2.7/>`_ | |
+ * `Numpy <http://numpy.scipy.org>`_ | |
+ * `Matplotlib <http://matplotlib.org>`_ | |
+ * `Imagemagick <http://www.imagemagick.org/script/index.php>`_ | |
+ * `ffmpeg <http://ffmpeg.org/>`_ | |
+ | |
+Optional tools, required for building the documentation: | |
+ * `Sphinx <http://sphinx-doc.org>`_ | |
+ * `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ | |
+ * `Breathe <http://michaeljones.github.com/breathe/>`_ | |
+ | |
+`Git <http://git-scm.com>`_ is used as the distributed version control system … | |
+ | |
+ | |
+Building *sphere* | |
+----------------- | |
+All instructions required for building *sphere* are provided in a number of ``… | |
+ | |
+ $ cd src | |
+ $ make | |
+ | |
+If successfull, the GNU Makefile will create the required data folders, object… | |
+ | |
+ $ ./sphere_* --version | |
+ | |
+The documentation can be read in the `reStructuredText <http://docutils.source… | |
+ | |
+ $ cd doc/sphinx | |
+ $ make html | |
+ $ make latexpdf | |
+ | |
+To see all available output formats, execute:: | |
+ | |
+ $ make help | |