Developer Guide Overview

This guide assumes you have checked-out the repository. It is recommended that you install Hydra in a virtual environment like conda or virtualenv.

Environment setup

Install Miniconda and create an empty Conda environment with:

conda create -n hydra38 python=3.8 -qy

NOTE

The core Hydra framework supports Python 3.8 or newer. You may need to create additional environments for different Python versions if CI detect issues on a supported version of Python.

Activate the environment:

conda activate hydra38

From the source tree, install Hydra in development mode with the following commands:

# install development dependencies
pip install -r requirements/dev.txt
# install Hydra in development (editable) mode
pip install -e .