Data

Tools

Indexes

Applications

Experiments

Open Source Science

helipad

An agent-based modeling framework for Python with a shallow learning curve and powerful visualization capabilities.

https://github.com/charwick/helipad

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.3%) to scientific vocabulary

Keywords

agent-based-framework agent-based-modeling agent-based-simulation python simulation-environment simulation-framework simulation-modeling
Last synced: 4 months ago · JSON representation ·

Repository

An agent-based modeling framework for Python with a shallow learning curve and powerful visualization capabilities.

Basic Info
  • Host: GitHub
  • Owner: charwick
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage: https://helipad.dev
  • Size: 1.73 MB
Statistics
  • Stars: 31
  • Watchers: 4
  • Forks: 3
  • Open Issues: 0
  • Releases: 20
Topics
agent-based-framework agent-based-modeling agent-based-simulation python simulation-environment simulation-framework simulation-modeling
Created almost 8 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

Helipad

Helipad is an agent-based modeling framework for Python with powerful visualization capabilities and a shallow learning curve. Documentation and API reference can be found at helipad.dev.

Features

  • ⚓️ A simple hook-based API makes it easy to build a model without worrying about the features you don’t need
  • 📈 Interactive and live-updating visualizations, including time series, bar charts, networks, spatial, and an API for writing custom visualizations
  • 👋🏻 Flexible parameter API allows parameter values to be set programmatically, adjusted manually from the control panel while the model is running, or shocked stochastically
  • 🪐 Cross-platform and multimodal. Models can be written and run with a Tkinter GUI, in Jupyter notebooks, or without a GUI at all
  • 🤹🏻‍♂️ Agents can barter, buy and sell with money, reproduce both haploid and polyploid, and more
  • 🕺🏻 A variety of model types: sequential or random-activation models, matching models, multi-level models, network models, spatial models, and more

How to Use

You can install Helipad using either Pip or Conda, depending on your preferred package manager.

pip install helipad

conda install -c charwick helipad

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

from helipad import *
heli = Helipad()

#Use the heli object to set up here

heli.launchCpanel()

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.

Requirements

As of version 1.7, Helipad requires Python 3.9 or higher. The following libraries are also required:

How to Cite

If you use Helipad in your own research, please cite as follows:

Harwick, Cameron (2021). “Helipad: A Framework for Agent-Based Modeling in Python.” Working paper available at ssrn.com/abstract=3870501.

Version History

  • 1.6: Geospatial models, agent scatterplot visualizer, new Agents and Edges containers
  • 1.5: Polar grid spatial models, various spatial improvements
  • 1.4: More consistent container API, localization, miscellaneous interface improvements
  • 1.3: Allow mixing time series and other plots, display networks on spatial maps, goods API improvements
  • 1.2: Extensible visualization API, events, performance profiling, Jupyterlab support
  • 1.1: Virtual parameters, improved Jupyter flexibility, spatial pre-alpha, misc improvements
  • 1.0: Jupyter integration, hook decorators, and separated control panel from plotting
  • 0.7: Ability to output stackplots, parameter sweeps, and an updated parameter identification pattern
  • 0.6: Support for multi-level models
  • 0.5: Support for matching models, and the checkGrid class
  • 0.4: Initial PyPI release

Owner

  • Login: charwick
  • Kind: user

Monetary economist, agent-based modeler, folk musician.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use Helipad in your research, please cite it as below."
authors:
- family-names: "Harwick"
  given-names: "Cameron"
  orcid: "https://orcid.org/0000-0003-2703-1627"
title: "Helipad: A Framework for Agent-Based Modeling in Python"
version: 1.6
identifiers:
  - type: doi
    value: 10.2139/ssrn.3870501
repository-code: 'https://github.com/charwick/helipad'
date-released: 2023-01-14
url: "https://helipad.dev"
abstract: >-
  Helipad is an agent-based modeling framework for Python with a
  shallow learning curve and powerful visualization capabilities.
keywords:
  - Agent based modeling
  - Python
  - White paper
  - Complex systems
license: MIT
preferred-citation:
  type: article
  authors:
  - family-names: "Harwick"
    given-names: "Cameron"
    orcid: "https://orcid.org/0000-0003-2703-1627"
  identifiers:
  - type: doi
    value: 10.2139/ssrn.3870501
  journal: "Working paper"
  title: "Helipad: A Framework for Agent-Based Modeling in Python"
  year: 2023

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 416
  • Total Committers: 1
  • Avg Commits per committer: 416.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 57
  • Committers: 1
  • Avg Commits per committer: 57.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
charwick 1****k 416

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 4
  • Total pull requests: 0
  • Average time to close issues: 3 days
  • Average time to close pull requests: N/A
  • Total issue authors: 3
  • Total pull request authors: 0
  • Average comments per issue: 2.75
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 6 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • XerMat (2)
  • hyusetiawan (1)
  • tkristinwilson (1)
Pull Request Authors
Top Labels
Issue Labels
cross-platform (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 61 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 23
  • Total maintainers: 1
pypi.org: helipad

An agent-based modeling framework for Python with a shallow learning curve and powerful visualization capabilities.

  • Homepage: https://helipad.dev
  • Documentation: https://helipad.dev/functions/
  • License: MIT License Copyright (c) 2024 C Harwick Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.6.2
    published over 1 year ago
  • Versions: 23
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 61 Last month
Rankings
Dependent packages count: 7.3%
Stargazers count: 12.5%
Forks count: 14.3%
Average: 18.2%
Dependent repos count: 22.1%
Downloads: 34.9%
Maintainers (1)
charwick
Last synced: 4 months ago

Dependencies

pyproject.toml pypi
  • matplotlib *
  • networkx *
  • pandas *