Install#

There are different ways to install BAM Engine:

Install the latest official release. This is the best approach for most users. It will provide a stable version and pre-built packages are available for all platforms.
Build the package from source. This is best for users who want the latest features or wish to contribute to the project.

Dependencies#

Dependency	Version	Purpose
Python	>= 3.11	Core language runtime
numpy	>= 1.26	Vectorized array operations
PyYAML	>= 6.0.2	Configuration file parsing
pandas (optional)	>= 2.0	DataFrame export for results

BAM Engine is available on PyPI. We recommend using a virtual environment to avoid conflicts with other packages.

pip install -U bamengine

To enable DataFrame export for simulation results, install with pandas support:

pip install -U bamengine[pandas]

To verify your installation:

python -m pip show bamengine         # show version and location
python -c "import bamengine; print(bamengine.__version__)"

Building from source is required to work on a contribution or to run the latest development version.

git clone https://github.com/kganitis/bam-engine.git
cd bam-engine
pip install -e ".[dev]"

This installs the package in editable mode with all development dependencies (testing, linting, documentation).

To verify the installation, run the test suite:

pytest