Installation¶
Requirements¶
Python¶
syndi has been tested on GNU/Linux, and macOS systems running Python 3.6, and 3.7 installed.
Also, although it is not strictly required, the usage of a virtualenv is highly recommended in order to avoid having conflicts with other software installed in the system where you are trying to run Orion.
Install using pip¶
The easiest and recommended way to install syndi is using pip:
pip install syndi
This will pull and install the latest stable release from PyPI.
Install from source¶
The source code of syndi can be downloaded from the Github repository
You can clone the repository and install with the following command in your terminal:
You can clone the repository and install it from source by running make install on the
stable branch:
git clone git://github.com/DAI-Lab/syndi
cd syndi
git checkout stable
make install
Note
The master branch of the syndi repository contains the latest development version. If you want to install the latest stable version, make sure not to omit the git checkout stable indicated above.
If you are installing syndi in order to modify its code, the installation must be done from its sources, in the editable mode, and also including some additional dependencies in order to be able to run the tests and build the documentation. Instructions about this process can be found in the Contributing guide.