Getting Started

In order to use Orion Python packages, a compatible version of Python3 must be installed. Python3 is not the system Python on many platforms, so a Python3 environment will need to be created on your local machine using either Anaconda/miniconda or virtual environments. We recommend Anaconda/miniconda virtual environments. You can download Anaconda from Anaconda Download and follow the given directions for installation. You may also consult the Getting Started with OpenEye Python guide.

Once Anaconda/miniconda is installed, create a Python3 conda environment with the following command:

conda create -n cubes python=3.5

Next, activate the cubes environment with the following command:

on macOS and Linux

source activate cubes

and on Windows

activate cubes

Next, install Orion Python packages inside the cubes virtual environment. Orion Python packages are hosted on OpenEye’s Python package server, https://magpie.eyesopen.com. To access the server, send a request to support@eyesopen.com. Once you have your login credentials, login to the server and navigate to the settings page and set up a pip configuration file, pip.conf or pip.ini file using the given token. There are several ways to set up a pip configuration file (see Config file) and the easiest way is to set up a per-user file in your home directory.

On Linux and macOS, the name of the file is pip.conf and the location of the file is $HOME/.pip/pip.conf and on Windows, the name of the file is pip.ini and the location of the file is %HOME%\pip\pip.ini or C:\Users\your_username\pip\pip.ini.

In order to develop for Orion, or use OpenEye’s cube libraries, requires OpenEye-orionplatform, OpenEye-datarecord, OpenEye-floe, and OpenEye-orionclient. These can all installed by running the following command:

pip install -U OpenEye-orionplatform

Note

After installation, the Orion Python packages will be located in the site-packages subdirectory, whose full path will be something like ~/anaconda3/envs/cubes/lib/python3.5/site-packages.

Note

The following sections require the OpenEye-snowball and OpenEye-Classic-Floes tarballs. These are available in the OpenEye Box folder. Please contact support@eyesopen.com for further details.

The final steps involve adding the OpenEye-snowball package to your local development setup:
  1. Download the OpenEye-snowball tarball and unpack it.
  2. Navigate to the top level snowball directory
  3. Set up snowball for local development with pip install -e .
  4. Write some cubes and add them to the snowball subdirectory

To access the OpenEye floe library, download the OpenEye-Classic-Floes tarball. Once the download is complete, unpack it and navigate to the top level directory. Details about running the standard floes and, if desired, authoring floes are in the section_run_floe section.