Installation¶

This guide continues from PyDotBot's installation. Make sure you have a working PyDotBot first, then add this project on top of it.

Prerequisites: PyDotBot¶

Follow the PyDotBot getting-started guide and install the package with the calibration extra (needed for LH2 localisation at Level 2):

pip install 'pydotbot[calibrate]'

Check it runs:

dotbot --help

Python environment

Everything here is plain Python (the simulator and driving an existing swarm need nothing else). Building and cable-flashing firmware additionally needs SEGGER Embedded Studio and the nRF Command Line Tools — see PyDotBot's prerequisites. Use a virtual environment so PyDotBot and this project share the same interpreter.

Get this project¶

git clone https://github.com/DotBots/dotbot-logistics.git
cd dotbot-logistics
pip install -r requirements.txt

requirements.txt pulls pydotbot[calibrate], requests, and pygame (the last one is only used by the Level 0 viewer).

The repository bundles a small standalone PIBT engine under simulation/. The scripts add it to sys.path automatically, so you do not need to install it separately. If you want to run the engine on its own, it has its own simulation/requirements.txt.

What's in the box¶

Path	Used at	Purpose
`simulation/`	Level 0	Standalone PIBT engine (`core/`, `algo/pibt.py`) + renderers.
`sim_pibt.py`	Level 0	Interactive pygame viewer (edit-in-file scenario).
`sim_many_pibt.py`	Level 0	Headless PIBT benchmark sweep.
`sim_dotbot_pibt.py`	Level 1	Drives the DotBot simulator through the controller API.
`real_dotbot_pibt.py`	Level 2	Drives real DotBots, step-by-step with a sync barrier.
`real_dotbot_pibt_batch.py`	Level 2	Parametrised batch test harness (`--bots N`).
`simulator_init_state.toml`	Levels 1–2	Initial simulated-bot positions for the controller.
`mosquitto.conf`	Level 2	Local MQTT broker config.
`dotbot.toml`	Level 2	Controller connection / swarm-id config.

You're ready. Continue to Level 0 — Run a PIBT.