Installation

Prerequisites

  • Python 3.8 or higher

  • pip package manager

From Source

For development or latest features, install from the GitHub repository:

git clone https://github.com/YOUR-USERNAME/pyhnhtools.git
cd pyhnhtools
pip install -e .

For development with all optional dependencies:

pip install -e ".[dev]"

This installs:

  • Sphinx and documentation tools

  • pytest and testing utilities

  • Additional development dependencies

Docker Installation

A Docker image is available for containerized environments:

docker pull YOUR-USERNAME/pyhnhtools
docker run -it YOUR-USERNAME/pyhnhtools

Verification

Verify the installation:

import pyhnhtools
print(pyhnhtools.__version__)

Or run a quick test:

python -c "from pyhnhtools import load_input, run_backwater; print('Installation successful!')"

Troubleshooting

ImportError: No module named ‘pyhnhtools’

Make sure the package is installed:

pip install -e .

GUI not launching

Ensure PyQt5 is installed:

pip install PyQt5

Missing dependencies

Install all dependencies:

pip install pyhnhtools[all]