Installation Guide

This document will guide you through the process of installing the hmp package.

It is recommended to use a virtual environment for installing dependencies. See the official Python venv guide for instructions on creating and managing Python environments, or use Anaconda to create a virtual environment using conda.

Step 1: Python Installation

Install Python.

Step 2: Install PIP

If you haven’t installed pip, refer to the Pip Installation Guide for instructions.

Step 3: Install hmp

pip install hmp==1.0.0-b4

ONLY IF YOU WANT THE UNSTABLE DEVELOPMENT VERSION, you can clone the repository using git (if git is already installed):

Open a terminal and type:

git clone https://github.com/gweindel/hmp.git
git switch devel  # Optional, bleeding edge version

Then move to the cloned repository and run:

pip install -e .

But remember that the development branch is not stable and might contain bugs not present in the other versions. Note also that the documentation is not build for the develpment branch but for the latest version.

Step 4: Verifying Installation

To ensure hmp has been successfully installed, run the following command in a Python console:

import hmp