Installation of Orion’s core¶
Oríon should work on most Linux distributions and Mac OS X. It is tested on Ubuntu 16.04 LTS and Mac OS X 10.13. We do not support Windows and there is no short term plan to do so.
The easiest way to install Oríon is using the Python package manager. The core of Oríon is
registered on PyPI under
pip install orion
This will install all the core components. Note that the only algorithm provided with it is random search. To install more algorithms, you can look at section Installation of plugins.
This way is recommended if you want to work with the bleeding edge version of Oríon.
Recommended for users¶
pip install git+https://github.com/epistimio/orion.git@develop
Note that the bleeding-edge branch is develop. The master branch is the same as the latest version on PyPI.
Recommended for developers of Oríon¶
Clone remote repository from Github, using https or ssh, and then
deploy the project in development mode, by invoking the
or by using
pip install --editable. Usage of a virtual environment is
also recommended, but not necessary. Example:
<Create and navigate to the directory where local repo will reside> git clone https://github.com/epistimio/orion.git --branch develop mkvirtualenv -a $PWD/orion orion python setup.py develop --optimize=1 <Do your job> deactivate
Begin reading instructions for developing it in Testing.