 |
tMerge branch 'master' of https://github.com/anders-dc/sphere Merging documenta… |
 |
git clone git://src.adamsgaard.dk/sphere |
 |
Log |
|
Files |
|
Refs |
|
LICENSE |
|
--- |
|
commit 1ed09491efdc53a1086a8ce35f460f781c2a91ea |
|
parent f381d1df7e30f25481ef16e9d920e7707aaafc39 |
|
Author: Anders Damsgaard <[email protected]> |
|
Date: Sat, 26 Jan 2013 12:11:08 +0100 |
|
|
|
Merge branch 'master' of https://github.com/anders-dc/sphere |
|
Merging documentation updates |
|
|
|
Diffstat: |
|
M README.rst | 34 ++++++++++++++++++++---------… |
|
|
|
1 file changed, 22 insertions(+), 12 deletions(-) |
|
--- |
|
diff --git a/README.rst b/README.rst |
|
t@@ -11,13 +11,17 @@ See the ``doc/`` folder for general reference. |
|
Requirements |
|
------------ |
|
The build requirements are: |
|
- * A Nvidia CUDA-supported version of Linux or Mac OS X (see the `CUDA toolki… |
|
+ * A Nvidia CUDA-supported version of Linux or Mac OS X (see the `CUDA toolki… |
|
+ release notes <http://docs.nvidia.com/cuda/cuda-toolkit-release-notes/inde… |
|
+ for more information) |
|
* `CMake <http://cmake.org>`_, version 2.8 or higher |
|
- * A C/C++ compiler toolkit, e.g. the `GNU Compiler Collection <http://gcc.gn… |
|
+ * A C/C++ compiler toolkit, e.g. 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 `CUDA-enabled GPU <http://www.nvidia.com/object/cuda_gpus.html>`_ |
|
+ with compute capability 1.1 or greater. |
|
* A Nvidia CUDA-enabled GPU and device driver |
|
|
|
Optional tools, required for simulation setup and data processing: |
|
t@@ -34,25 +38,31 @@ Optional tools, required for building the documentation: |
|
|
|
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`` |
|
+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 |
|
------------------ |
|
Sphere is built using `cmake`, the platform-specific c/c++ compilers, |
|
and `nvcc` from the cuda toolkit. Execute the following commands from |
|
the root directory:: |
|
- cmake . |
|
- make |
|
+ cmake . && make |
|
|
|
In some cases the CMake FindCUDA module will have troubles locating the |
|
CUDA SDK directory, and will complain about `cutil_math.h` not being found. |
|
|
|
-In that case, modify the `NVSDKCOMPUTE_ROOT` environment variable in |
|
+In that case, modify the ``NVSDKCOMPUTE_ROOT`` environment variable in |
|
`INSTALL.sh`, and execute it. |
|
|
|
After a successfull installation, the `sphere` executable will be located |
|
-in the root folder. |
|
+in the root folder. To make sure that all components are working correctly, |
|
+execute:: |
|
+ make test |
|
+ |
|
+Updating sphere |
|
+--------------- |
|
+To update your local version, type the following commands in the sphere root |
|
+directory:: |
|
+ git pull && cmake . && make |
