Installation Guide

Caution

Python Environment

It is highly recommended to prepare a Python environment with the Anaconda or Miniconda distribution and install Arboretum’s dependencies using the conda package manager.

  • NumPy
  • SciPy
  • scikit-learn
  • pandas
  • dask
  • distributed

This avoids complexities in ensuring that libraries like NumPy and SciPy link against an optimized implementation of linear algebra routines.

Install using pip

The arboretum package is available from PyPI (Python Package Index), a repository of software for the Python programming language.

Using pip, installing the arboretum package is straightforward:

$ pip install arboretum

Note

You can use pip to install arboretum in an Anaconda environment.

Install from source

Installing Arboretum from source is possible using following steps:

  1. clone the Github repository using the git tool:
$ git clone https://github.com/tmoerman/arboretum.git
$ cd arboretum
  1. build Arboretum using the provided script:
$ ./pypi_build.sh
  1. install the freshly built Arboretum package using pip:
$ pip install dist/*