Installation

This page provides instructions for installing MiniHF and its dependencies.

Prerequisites

Before installing MiniHF, you should have the following software installed:

  • Python 3.7 or later

  • NumPy

Compiling from source code

The recommended way to install MiniHF is from source:

  • Clone the repository:

git clone https://github.com/ZhaoYilin/minihf.git
cd minihf

  • Install MiniHF:

python3 -m pip install -e .

This will install MiniHF in development mode, which means changes to the source code will be immediately available without needing to reinstall.

  • Using pip to install python package on GitHub

pip install git+https://github.com/ZhaoYilin/minihf

Verifying the Installation

To verify that MiniHF is installed correctly, run the test suite:

pytest test/ -v

All tests should pass if the installation was successful.