summaryrefslogtreecommitdiffstats
path: root/Readme.md
diff options
context:
space:
mode:
authorTomas Kulhanek <tomas.kulhanek@stfc.ac.uk>2019-02-21 04:09:41 -0500
committerTomas Kulhanek <tomas.kulhanek@stfc.ac.uk>2019-02-21 04:09:41 -0500
commitb9dc6d0b947a2287d6761e0b0a35525dd0fe7e7f (patch)
tree6904aeddca77ce2ada93a6b1a947489e83ad96e4 /Readme.md
parent61bfe1f57fbda958e24e227e567676fafd7f6d3e (diff)
downloadregularization-b9dc6d0b947a2287d6761e0b0a35525dd0fe7e7f.tar.gz
regularization-b9dc6d0b947a2287d6761e0b0a35525dd0fe7e7f.tar.bz2
regularization-b9dc6d0b947a2287d6761e0b0a35525dd0fe7e7f.tar.xz
regularization-b9dc6d0b947a2287d6761e0b0a35525dd0fe7e7f.zip
FIX: directory links, install instructions
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/Readme.md b/Readme.md
index ebd4d20..a9433d2 100644
--- a/Readme.md
+++ b/Readme.md
@@ -50,13 +50,28 @@
## Installation:
-The package comes as a [CMake](https://cmake.org) project so you will need CMake (v.>=3) to configure it. Additionally you will need a C compiler, `make` (on linux) and CUDA SDK where available. The toolkit may be used directly from C/C++ as it is compiled as a shared library (check-out the include files in `Core` for this). We provide wrappers for Python and Matlab.
+The package comes as a [CMake](https://cmake.org) project
+and additional wrappers for Python and Matlab.
+To install precompiled binaries, you need `conda` and install from `ccpi` channel using :
+```
+conda install ccpi-regulariser -c ccpi -c conda-forge
+```
+
+In order to compile C/C++ sources and additional wrappers from source code, the recommended way is:
+```
+git clone https://github.com/vais-ral/CCPi-Regularisation-Toolkit
+cd CCPi-Regularisation-Toolkit
+build/jenkins-build.sh
+```
+this will install `conda build` environment and compiles C/C++ and Python wrappers and performs basic tests.
+
+### CMake
+If you want to build directly using cmake, install CMake (v.>=3) to configure it. Additionally you will need a C compiler, `make` (on linux) and CUDA SDK where available. The toolkit may be used directly from C/C++ as it is compiled as a shared library (check-out the include files in `Core` for this)
1. Clone this repository to a directory, i.e. `CCPi-Regularisation-Toolkit`,
2. create a build directory.
3. Issue `cmake` to configure (or `cmake-gui`, or `ccmake`, or `cmake3`). Use additional flags to fine tune the configuration.
-### CMake flags
Flags used during configuration
| CMake flag | type | meaning |