Install

Yue Wu edited this page Aug 29, 2016 · 5 revisions

Installation

SOL features a very simple installation procedure.

Users can either install the C++ executables or python scripts. They provide similar interfaces (sol_train for training and sol_test for testing). To choose the best method:

  • If you are working on C/C++ or other non-python languages, you should choose the C++ executables and dynamic libraries.

  • If you are a python worker, then just try the python scripts.

NOTE:

Both the python scripts and C++ executables & Libraries are dependent on the same C++ codes.

Install from Source

The project is managed by CMake. There exists a CMakeLists.txt in the root directory of SOL. Note that all the following are tested on "CMake 2.8.12". Lower versions of cmake may work, but are not ensured.

###Getting the code

The latest version of SOL is always available via "github" by invoking one of the following:

# For the traditional ssh-based Git interaction:
$ git clone git://github.com/LIBOL/SOL.git

# For HTTP-based Git interaction
$ git clone https://github.com/LIBOL/SOL.git

Build C++ Executables and Dynamic Libraries on Linux/Unix/MacOS

The following steps have been tested for Ubuntu 14.04, Centos 6.6 (with "devtoolset-2" installed for the latter one), and OS X 10.10, but should work with other Unix like distributions as well, as long as it provides a "C++11" compiler.

Required Packages

  • g++(>=4.8.2) or clang++(>=3.3);
  • CMake 2.8.12 or higher;

Build from source

  1. Navigate to the root directory of SOL and create a temporary directory to put the generated project files, as well the object files and output binaries.
$ cd SOL && mkdir build && cd build
  1. Generate and build the project files.
$ cmake ..
$ make -j
$ make install
  1. For Xcode users, the command is:
$ cmake -G"Xcode" ..

By default, SOL will be installed in the directory "SOL/dist". If you want to change the installation directory, set the "PREFIX" variable when using "cmake".

$ cmake -DPREFIX=/usr/local ..

Build C++ Executables and Dynamic Libraries on Windows

The following steps have been tested on Visual Studio 2013 and Visual Studio 2015. Lower versions of Visual Studio do not provide full support of C++11 features.

Required Packages

  • Visual Studio 2013, 2015, or higher
  • CMake 2.8.12 or higher

Build from source

  1. Navigate to the root directory of SOL and create a temporary directory to put the generated project files, as well the object files and output binaries. Then follow either Step 2 or Step 3.

  2. Install with CMake GUI.

  3. Open cmake-gui.exe, set "where is the source code" and "where to build the binaries".

  4. Click Configure and select compiler.

  5. After finish configuration, click Generate.

  6. Open SOL.sln, Rebuild the ALL_BUILD project and then build the INSTALL project.

  7. Install from command line.

Before this step, you should make sure that cmake is in the environment path or set environment path manually as step (3) shows.

  1. Search cmd in "Start Menu" and open it.

  2. Navigate to the root directory of SOL and create a temporary directory to put the generated project files, as well the object files and output binaries.

$ cd SOL && mkdir build && cd build
  1. If cmake is not in environment path, add by executing the following command:
$ set path=<path_to_cmake>;%path%
  1. Generate Visual Studio Projects. Example code for Visual Studio 2013, 2015 and their 64-bit versions are as the following shows:
#Generate Visual Studio 2013 Projects
$ cmake  -G "Visual Studio 12 2013" ..
#Generate 64-bit Visual Studio 2013 Projects
$ cmake  -G "Visual Studio 12 2013 Win64" ..
#Generate Visual Studio 2015 Projects
$ cmake  -G "Visual Studio 14 2015" ..
#Generate 64-bit Visual Studio 2015 Projects
$ cmake  -G "Visual Studio 14 2015 Win64" ..
  1. Open SOL.sln, Rebuild ALL_BUILD project and then build INSTALL project.

Build Python Scripts

We highly recommend users to install python packages in a virtual enviroment.

  1. Prerequisites

    • C++11 Compiler:
      • g++(>4.8.2) or clang++(>3.3) on Unix/Linux/MinGW/Cygwin
      • Visual Studio 2013 or higher on Windows
    • Python2.7 (Anaconda is highly recommend on Windows)
  2. For on Unix/Linux/MacOS Users

    • Create and Activate a new virtual environment

        $ virtualenv --system-site-packages pyenv
        $ source pyenv/bin/activate
      
    • Build and install the python scripts

        $ python setup.py build
        $ python setup.py install
      
  3. For Windows Users

    Windows Users still need Visual Studio to compile the codes. Besides, we high recommend to install Anaconda as the python environment. If you are a Canopy user, the procedures are similar except for the creation of virtual environment.

    • Open a Command Prompt and go to the source directory

        $ cd <SOL>
      
    • Create and Activate a new virtual enviroment

        $ virtualenv --system-site-packages pyenv
        $ pyenv/Scripts/activate
      
    • Set up the build environment

      By default, Anaconda requires the Visual C++ 9.0 (Visual Studio 2008) to compile the native codes. However, this is a very old compiler. We recommend to use the following tricks to user new visual studio compilers.

        $ cd <Anaconda>\Lib\distutils
        $ backup msvc9compiler.py
        $ open msvc9compiler.py
        $ find the line 'majorVersion=int(s[:2]) - 6'
        $ change the line to 'majorVersion=12' for Visual Studio 2013 or
        $ change the line to 'majorVersion=14' for Visual Studio 2015 or
      
    • Build and install the python scripts

        $ python setup.py build
        $ python setup.py install
      
    • Revert the changes to Anaconda if you are not sure its influences in the future.

Known Issues of Python Wrappers

  • On MacOS, the default python is not a framework build. Seems matplotlib does not work properly. See here for more details. We recommend the Anaconda python distribution.

  • On MacOS, if you met the 'Value Error: unknown locale: UTF-8' error, fix by:

      $ export LC_ALL=en_US.UTF-8
      $ export LANG=en_US.UTF-8
    
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.