Installation

To install the necessary tools and dependencies for this project, follow the steps outlined below. These instructions will guide you through setting up the environment for both standard use and interactive analysis with Jupyter notebooks.

Note

Make sure you have Python (>= 3.11 and <3.14) and pip installed on your machine before proceeding.

PyPI

ovrlpy can be installed from PyPI via

pip install ovrlpy

bioconda

ovrlpy can be installed from bioconda via

conda install bioconda::ovrlpy

From GitHub

To install ovrlpy from GitHub you can clone the repository and then install with pip as follows

# clone the repository
git clone https://github.com/HiDiHlabs/ovrl.py.git
cd ovrl.py

# install the package
pip install .

Interactive tutorials

If you want to follow the interactive tutorials you will need jupyter to run the tutorial notebooks.

pip install jupyter

Note

Instead of installing jupyter you can also use existing JupyterLab or JupyterHub instances.