Quick Install Guide

Prerequisites

HELIX is supported by Python (>=3.5) on both Windows and Linux and is installed with pip. Both Python and pip must be installed on your system before attempting to install HELIX.

Installation

To install HELIX from PyPI with pip, run:

pip install helix

Additional Dependencies

Some HELIX Blueprints, Components, and Transforms include additional, external dependencies which must be installed before they can be used in HELIX builds. To install all of these dependencies, use the install HELIX CLI command after installing HELIX with pip:

helix install

Note

Depending on your platform, the above command may require root/Administrator priveleges. Some dependencies may also need to be manually installed - these will be listed in the output of the above command.

Development

To set up a development environment, first clone the HELIX repo. Next, install additional, optional extensions for development and testing by running (from the root of the repo):

pip install .[development,testing]