Skip to main content

An agent-based modeling framework for Python focused on time-series output.

Project description


Helipad is an agent-based modeling framework for Python. It differs from other frameworks in that it focuses on time series output rather than spatial models.

Documentation is a work in progress, and can be found at

How to use

You can install Helipad using Pip.

pip install helipad

Once installed, getting started with a model is very simple.

from helipad import *
heli = Helipad()

#Use the heli object to set up here


The included bootstrap model contains a more detailed template, and the sample models exemplify various use cases. The documentation also includes a complete hook and function reference.


Helipad requires Python 3.6. Previous versions do not preserve dict order, so you may get unexpected results. Python 2 is not supported.

The following libraries are required:

  • Colour (for the user interface)
  • Matplotlib (for plotting the time series output)
  • Pandas (for data collection)

The following libraries are optional but recommended:

  • PMW (for tooltips)
  • NetworkX (for network analysis)
  • Readline and Code (for the debug console)
  • Pyobjc (for Mac interface niceties)

Version History

  • 0.5: Support for matching models, and the checkGrid class
  • 0.4: Basic graph and network functionality
  • 0.3: Improvements to goods API
  • 0.2: Abstraction of agent-type primitives
  • 0.1: Initial Github release

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for helipad, version 0.5
Filename, size File type Python version Upload date Hashes
Filename, size helipad-0.5.tar.gz (44.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page