Metadata-Version: 2.1
Name: helipad
Version: 0.5
Summary: An agent-based modeling framework for Python focused on time-series output.
Home-page: https://helipad.dev
Author: C Harwick
Author-email: cameron@cameronharwick.com
License: MIT
Description: # Helipad
        
        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 https://helipad.dev
        
        ## 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
        	
        	heli.launchGUI()
        
        The included [bootstrap model](https://github.com/charwick/helipad/blob/master/sample-models/bootstrap.py) contains a more detailed template, and the [sample models](https://github.com/charwick/helipad/tree/master/sample-models) exemplify various use cases. The documentation also includes a complete [hook and function reference](https://helipad.dev/functions/).
        
        ## Requirements
        
        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
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.6
Description-Content-Type: text/markdown
