Installation

Install the Pulse Python SDK.

From PyPI

With pip:

bash
pip install "simudyne-pulse>=0.8.0"

Or with uv:

bash
uv add "simudyne-pulse>=0.8.0"

The distribution is named simudyne-pulse but the import name is simudyne. So you pip install simudyne-pulse and then from simudyne import PulseABM.

Pin a version

Everything in these docs needs SDK 0.8.0 or later. Releases in the 0.7.x line are not compatible with the current API, so upgrade before you run any of the examples. Pin the release you tested against, the same as any other dependency:

bash
pip install simudyne-pulse==0.8.0

To check what you have installed:

python
from importlib.metadata import version

print(version("simudyne-pulse"))

From source

Clone the repository and install in editable mode for development:

bash
git clone https://github.com/simudyne/pulse-sdk.git
cd pulse-sdk
pip install -e .

Requirements

  • Python 3.10+
  • polars, requests, tqdm and websocket-client are installed automatically as dependencies
  • pandas is needed only to build a CSS execution schedule, and IPython only to render validation plots inline in a notebook — neither is a hard dependency

Verify the installation

bash
python -c "from simudyne import PulseABM; print('OK')"

Upgrading from an earlier version: pip install --upgrade simudyne-pulse. If you previously installed from a git URL, uninstall first — pip uninstall simudyne simudyne-pulse — so the old distribution name does not shadow the new one.

Authentication→