Skip to content

How to get started

There are different options to install jackHI. They are listed below.

Warning

Before attempting to issue the underlying commands to install jackHI, you need to clone the jackHI github repository.

Installing jackHI within your virtual environment

Activate your virtual environment (e.g. a conda/micromamba/mamba environment). Then execute one of the following commands in the directory in which you cloned the jackHI repository:

uv pip install .
pip install .
pip install ".[test]"

This installs jackHI in your virtual environment.

Installing jackHI as a system-wide tool

Execute the following command in the directory in which you cloned the jackHI repository:

uv tool install .

This should install jackHI as a system-wide tool, making the command-line tool available in any environment.

Info

Installation as a system-wide tool is (at this moment) only supported when using the UV Python package manager.