Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added first draft of "quickstart" instructions to documentation.
- Loading branch information
Thoralf Klein
committed
Feb 13, 2014
1 parent
a5761ea
commit a6f94b5
Showing
1 changed file
with
72 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Shogun Quickstart | ||
|
||
This quickstart assumes that you're have access to standard unix/linux | ||
tools, cmake and a C/C++ compiler. It may be neccessary to install | ||
additional libraries or header files to compile shogun or its interfaces. | ||
|
||
## Build prerequisites | ||
|
||
* Minimal requirements: standard utils like cmake, gcc/g++/clang, ldd, | ||
bash, grep, test, sed, cut, awk, ldd, uname, cat, python-2.7 | ||
* Optional libraries to improve performance: lapack3-dev, atlas3-headers, | ||
atlas3-base-dev, libeigen3-dev | ||
* Depending on the enabled interfaces you may need: swig 2, r-base-dev, | ||
liboctave-dev, openjdk-6-jdk/openjdk-7-jdk, jblas, jblas-dev, | ||
python2.7-dev, python-numpy | ||
|
||
## Download sources | ||
|
||
The following commands will clone the shogun repository and download | ||
approximately 350-400 MB of data. | ||
|
||
``` | ||
$ git clone https://github.com/shogun-toolbox/shogun | ||
$ git submodule update --init | ||
``` | ||
|
||
## Compile, run test, install into home directory | ||
|
||
``` | ||
$ mkdir shogun/build | ||
$ cd shogun/build | ||
$ cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_TESTING=ON -DCMAKE_INSTALL_PREFIX="/home/$USER/shogun-install" .. | ||
$ make -j5 all | ||
$ make ARGS='--output-on-failure' -j5 test | ||
$ make install | ||
``` | ||
|
||
## Run the examples: | ||
|
||
``` | ||
$ export LD_LIBRARY_PATH="/home/$USER/shogun-install/lib:$LD_LIBRARY_PATH" | ||
$ cd "/home/$USER/share/shogun/examples/libshogun" | ||
$ chmod +x ./so_multiclass_BMRM && ./so_multiclass_BMRM | ||
``` | ||
|
||
## Enabling additional interfaces | ||
|
||
### Modular interfaces: | ||
* `-DPythonModular=ON` | ||
* `-DOctaveModular=ON` | ||
* `-DJavaModular=ON` | ||
* `-DPerlModular=ON` | ||
* `-DRubyModular=ON` | ||
* `-DCSharpModular=ON` | ||
* `-DRModular=ON` | ||
* `-DLuaModular=ON` | ||
|
||
### Enabling additional static interfaces (deprecated) | ||
* `-DCmdLineStatic=ON` | ||
* `-DPythonStatic=ON` | ||
* `-DOctaveStatic=ON` | ||
* `-DMatlabStatic=ON` | ||
* `-DRStatic=ON` | ||
|
||
## Misc build options | ||
|
||
* `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release` | ||
* `-DENABLE_TESTING=ON`or `-DENABLE_TESTING=ON` | ||
* `-DCMAKE_INCLUDE_PATH=...` | ||
* `-DCMAKE_LIBRARY_PATH=...` | ||
|