summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorWillem Jan Palenstijn <wjp@usecode.org>2017-11-01 18:09:13 +0100
committerGitHub <noreply@github.com>2017-11-01 18:09:13 +0100
commit40295b83ebaf49f9547a4366e1ebfbff39ea907c (patch)
tree0264de6639f179cad045d30079a023711dc8d2eb /README.md
parentf70f68fcd465f421b566b199e23e66c1f186b01d (diff)
parent84e163009c10f6ac5631cf5f29a4923852542eaf (diff)
downloadastra-40295b83ebaf49f9547a4366e1ebfbff39ea907c.tar.gz
astra-40295b83ebaf49f9547a4366e1ebfbff39ea907c.tar.bz2
astra-40295b83ebaf49f9547a4366e1ebfbff39ea907c.tar.xz
astra-40295b83ebaf49f9547a4366e1ebfbff39ea907c.zip
Merge pull request #126 from wjp/tests
Add basic tests to check an astra installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5211e69..f36bdea 100644
--- a/README.md
+++ b/README.md
@@ -123,7 +123,24 @@ Run build_setup.bat to automatically copy the boost headers and libraries.
For matlab: Run build_matlab.bat. The .dll and .mexw64 files will be in bin\x64\Release_Cuda.
For python 2.7/3.5: Run build_python27.bat or build_python35.bat. Astra will be directly installed into site-packages.
+## Testing your installation
+To perform a (very) basic test of your ASTRA installation in Python, you can
+run the following Python commands. You can choose to skip the test of the GPU
+functionality for systems without a NVIDIA GPU.
+
+```
+import astra
+astra.test_noCUDA() # To skip GPU tests
+astra.test_CUDA() # To also perform GPU tests
+```
+
+To test your ASTRA installation in Matlab, the equivalent commands are:
+
+```
+astra_test_noCUDA % To skip GPU tests
+astra_test_CUDA % To also perform GPU tests
+```
## References