Installation

From Source

For development or to get the latest changes:

git clone https://github.com/OrMullerHahitti/Belief-Propagation-Simulator.git
cd Belief-Propagation-Simulator
pip install -e .

Development Installation

To install with development dependencies:

pip install -e ".[dev]"

This includes testing tools (pytest), linting (black, flake8), and documentation tools.

Requirements

  • Python 3.10 or higher

  • NumPy >= 2.2.1

  • NetworkX >= 3.4.2

  • Matplotlib >= 3.10.0

  • SciPy >= 1.15.2

See the full dependency list in the pyproject.toml file.

Verifying Installation

After installation, verify everything works:

from propflow import BPEngine, FGBuilder
print("PropFlow installed successfully!")

Or check the version:

bp-sim --version