Note: This package is still under active development.
Recommended for end-users. Install the latest harpy-analysis PyPI package with the extra dependencies in a local Python environment.
uv venv --python=3.12 # set python version
source .venv/bin/activate # activate the virtual environment
uv pip install 'harpy-analysis[extra]' # use uv to pip install dependencies
python -c 'import harpy; print(harpy.__version__)' # check if the package is installedOnly for developers. Clone this repository locally, install the .[dev] instead of the [extra] dependencies and read the contribution guide.
# Clone repository from GitHub
uv venv --python=3.12 # set python version
source .venv/bin/activate # activate the virtual environment
uv pip install -e '.[dev]' # use uv to pip install dependencies
python -c 'import harpy; print(harpy.__version__)' # check if the package is installed
# make changes
python -m pytest # run the testsCheckout the docs for installation instructions using conda.
Tutorials are available here.
Learn how Harpy can be integrated into your workflow in different ways.
See here for info on how to contribute to Harpy.
Check the license. Harpy is free for academic usage. For commercial usage, please contact Saeyslab.
If you encounter any problems, please file an issue along with a detailed description.