Installation¶
neuroboom can be installed in two main ways:
A quick installation using pip
Building from source
Quick Installation¶
neuroboom requires Python 3.7
If you don’t already have it, get the Python package manager PIP.
To install the most recent version available on PyPI, run
$ pip install neuroboom
in the command line.
To get the most recent development version, from Github use:
$ pip install git::git://github.com/markuspleijzier/neuroboom@master
Instead of using PIP to install from Github, you can also install manually:
Download the source (e.g a
tar.gzfile) from hereUnpack and change directory to the source directory (the one with
setup.py).Run
python setup.py installto build and install
N.B. if you have multiple python installations, e.g. if you downloaded anaconda, then it would be worthwhile making sure
which python is called in the 3rd and final step.
To do this, run the following:
$ which python
If this points to the python you regularly use, then woop woop! you’re ready to go. If not then you should point this python to the python version you regularly use. A good package to manage different python versions is pyenv.
Important Dependency Configuration¶
Installing the graph rendering engines is a little more complicated and one cannot rely on automatic installation (yet).
To install Graphviz, one must first install homebrew:
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Simply copy and paste the above into the terminal.
Then to install Graphviz:
$ brew install Graphviz
To install PyGraphviz, we need to direct pip (this time using pip3) to where Graphviz is located. To do this, simply paste this snippet into the terminal:
pip3 install --install-option="--include-path=/usr/local/include/" --install-option="--library-path=/usr/local/lib/" pygraphviz
Graphviz is a dependency of NetworkX, so there is no need to import Graphviz/PyGraphviz in your python environment when using neuroboom.