Installation

Install the Pulse Python SDK.

From GitHub

bash
pip install git+https://github.com/simudyne/pulse-api.git

From a release

Pin to a specific version by installing from a GitHub release:

bash
pip install simudyne@https://github.com/simudyne/pulse-api/releases/download/v0.1.0/simudyne-0.1.0-py3-none-any.whl

From source

Clone the repository and install in editable mode for development:

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

Requirements

  • Python 3.10+
  • polars, requests, and tqdm are installed automatically as dependencies

Verify the installation

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

If you're upgrading from a previous version, run pip install --force-reinstall to ensure a clean install.

Authentication→