Installation

GraphBrain is compatible with 64-bit CPython 3.3+ and runs on Linux, macOS and Windows(untested). GraphBrain is available over pip. Installation requires a working build environment. For both installation methods, check the prerequisites for your OS. Make sure you are using Python 3.

Install from the code repository (github)

Another way to install GraphBrain is to build it from the GitHub repository source. You should use this method if you wish to make changes to the code base.

Start by cloning the source code to your current local directory.

$ git clone https://github.com/ai4socialscience/graphbrain.git
$ cd graphbrain

It is advisable to work with virtual environments, for reasons that are explained in the previous section. Please refer to it for details.

Install Cython:

$ pip install cython

Now we can build and install GraphBrain:

$ pip install .

It is still necessary to download a spaCy language model:

$ python -m spacy download en_core_web_lg

For developers

If you want to help develop GraphBrain, you should also install the development dependencies:

$ pip install '.[dev]'

Run tests

From the project’s root directory:

$ ./setup.py test

Prerequisites

Naturally, you can ignore the prerequisites that are already installed in your machine.

Linux

Linux distributions are diverse in terms of package managers. Please use the appropriate package manager for your distribution to install the prerequisites.

  • gcc
  • Python 3
  • pip (Python package manager)
  • virtualenv (Virtual Python Environment builder)

macOS

  • XCode and the “Command Line Tools”:

    $ xcode-select --install
    
  • The Homebrew package manager <http://brew.sh/>.

  • Python 3:

    $ brew install python3
    
  • pip (Python package manager):

    $ sudo easy_install pip
    
  • virtualenv (Virtual Python Environment builder):

    $ sudo -H pip install virtualenv
    
  • LevelDB (database engine):

    $ brew install leveldb
    

Windows

plyvel is required for installing graphbrain on Windows. Unfortunately, this currently requires more effort than in the other platforms. To install plyvel, boost.lib and leveldb.lib must be compiled first.

  • boost.lib (x64)

step 1 download and unzip the Boost library: https://www.boost.org/

step 2 make sure cl is the environment variable

step 3 open x64 Native Tools Command Prompt for VS2017. Get into the directory of the unzipped Boost

step 4 run command:

$ bootstrap.bat

b2.exe and bjam.exe will be added after this step.

step 5 open and modify project-config.jam in the current directory:

$ import option ;
$ using msvc : 14.1 : “E: \VS2017\VC\Tools\MSVC\14.1-.250117\bin\HostX64\x64\cl.exe” ;
$ option.set keep-going : false ;

Please note that you should: i) use your own VS version number (e.g. 14.1) ii) use your own directory of _cl.exe_.

step 6 (note: this step may take 1 - 3 hours) create a folder named build in the current directory, then run command:

$ b2.exe stage --toolset=msvc-14.1 address-model=64 --stagedir="E:\mylib\boost\bin1.64.0\VC14.
$ 1" threading=multi --build-type=complete --build-dir="E:\mylib\boost\boost_1_64_0\build"

Please note that you should: i) use your own directory names ii) be careful about the VS version number

  • leveldb.lib

step 1 download the source code of LevelDB for windows: https://github.com/vaskomitanov/leveldb

step 2 open Visual Studio (2017). Create a project:

  • file – new – project from existing code
  • choose the type of project: Visual C++
  • project file location: the directory of LevelDB
  • project name: LevelDB
  • project type: LIB
  • preprocessor definition: LEVELDB_PLATFORM_WINDOWS;OS_WIN; WIN32
  • include search path: E:LIBleveldb-windows;E:LIBleveldb-windowsinclude (the directory of LevelDB and its include)
  • click finish

step 3 set LevelDB.lib:

  • project – properties – configuration properties – configuration type: LIB
  • configuration properties – C/C++ - General – preprocessor – preprocessor definition: LEVELDB_PLATFORM_WINDOWS;OS_WIN; WIN32
  • linker – general – additional library directory: E:LIBboost64stagelib (use your own path)

step 4 open solution explorer, exclude the following files (tip: you can search and right click on the target files):

  • files ends with _test.cc and _bench.cc
  • port/port_android.cc
  • port/port_posix.cc
  • util/env_posix.cc

step 5 modify code:

in dbc.cc:

$ delete #include < unistd.h>

in portport.h - add the lines below before first #endif:

$ elif defined(LEVELDB_PLATFORM_WINDOWS)
$ include "port/port_win.h"

step 6 note: remember to compile as release x64

  • plyvel

modify setup.py:

Extension(
                ...
                libraries=['leveldb vaskomitanov-r x64',
                                   'libboost_chrono-vc141-mt-x64-1_69',
                                   'libboost_date_time-vc141-mt-x64-1_69',
                                   'libboost_filesystem-vc141-mt-x64-1_69',
                                   'libboost_system-vc141-mt-x64-1_69',
                                   'libboost_thread-vc141-mt-x64-1_69'],
                ...
    )
  • Cmake

you may also need to install Cmake, please check the official guidance here: https://cgold.readthedocs.io/en/latest/first-step/installation.html#windows