Installation

Requirements

Python

Orion has been tested on GNU/Linux, macOS, and windows systems running Python 3.8, 3.9, 3.10, or 3.11 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 Orion is using pip:

pip install orion-ml

This will pull and install the latest stable release from PyPI.

Install from source

The source code of Orion 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/sintel-dev/Orion
cd Orion
git checkout stable
make install

Note

The master branch of the Orion 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 Orion 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.

Getting Started Quickstart