tupdated readme - sphere - GPU-based 3D discrete element method algorithm with … | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 2aea4a8653243e1d19da0efaddc9c6c74cfaf41a | |
parent 274fcaea9e5132e395275bc0a8a046ad35f79630 | |
Author: Anders Damsgaard Christensen <[email protected]> | |
Date: Tue, 4 Dec 2012 22:09:35 +0100 | |
updated readme | |
Diffstat: | |
M README.rst | 37 ++++++++++++++++++-----------… | |
1 file changed, 21 insertions(+), 16 deletions(-) | |
--- | |
diff --git a/README.rst b/README.rst | |
t@@ -3,40 +3,45 @@ SPHERE readme | |
============= | |
Sphere is a 3D discrete element method algorithm utilizing CUDA. | |
-License | |
-======= | |
Sphere is licensed under the GNU General Public License, v.3. | |
See license.txt for more information. | |
-Documentation | |
-============= | |
See the ``doc/`` folder for general reference. | |
Requirements | |
============ | |
The build requirements are: | |
- - A Nvidia CUDA-supported version of Linux or Mac OS X | |
- - The GNU Compiler Collection (GCC) | |
- - The Nvidia CUDA toolkit and SDK | |
+* A Nvidia CUDA-supported version of Linux or Mac OS X | |
+* The GNU Compiler Collection (GCC) | |
+* The Nvidia CUDA toolkit and SDK | |
+ | |
The runtime requirements are: | |
- - A Nvidia CUDA-enabled GPU and device driver | |
+* A Nvidia CUDA-enabled GPU and device driver | |
+ | |
Optional tools, required for simulation setup and data processing: | |
- - Python 2 | |
- - Numpy | |
- - Matplotlib | |
- - Imagemagick | |
- - ffmpeg | |
+* Python 2.7 | |
+* Numpy | |
+* Matplotlib | |
+* Imagemagick | |
+* ffmpeg | |
+ | |
+Optional tools, required for building the documentation: | |
+* Sphinx | |
+* Doxygen | |
+* Breathe | |
Obtaining SPHERE | |
================ | |
The best way to keep up to date with subsequent updates, bugfixes | |
and development, is to use the GIT version control system. | |
+ | |
To obtain a local copy, execute: | |
``git clone https://github.com/anders-dc/sphere.git`` | |
Build instructions | |
================== | |
- ``cd src/`` | |
- ``make`` | |
+ cd src/ | |
+ make | |
+ | |
The compiler will generate a command-line executable in the root | |
-folder, and build the raytracing module separately. | |
+folder. |