Installing DRIVE using Pip

Installing DRIVE using Pip#

DRIVE has been officially released on PyPI! This installation method is recommended for those who wish to use the software and do not want to update or modify the software. pip will install all of the necessary dependencies of DRIVE so that the user doesn’t have to worry about dependency management.

Important

DRIVE supports Python version >=3.10 (but not Python version 3.11.0 specifically) for compatibility between packages. It is expected that your Python version falls within this range when attempting to install the software. You can read more about this version requirement and how to check if you have the right Python version here under the dropdown section ‘What versions of Python is DRIVE compatible with?’

DRIVE can be installed using the following command:

pip install drive-ibd

If the install is successful, then you can run the following command and you should see a help message:

drive --help

If you wish to run the provided testing data you can run the following command provided through the DRIVE utilities subcommand:

drive utilities test

A successful installation will result in all tests being labeled as Pass.

Note

The recommended way to install DRIVE using pip would be to either create a virtual environment using Anaconda or venv. Once you activate the virtual environment then you can use the above pip command to install DRIVE into an isolated environment.