=====
pyabm
=====

.. image:: https://travis-ci.org/azvoleff/pyabm.png
    :alt: Build Status
    :target: https://travis-ci.org/azvoleff/pyabm

pyabm - an agent-based modeling toolkit for Python 2.7.x.
 
Description
_______________________________________________________________________________

'pyabm' is an agent-based modeling toolkit written to simplify coding and 
running agent-based models in the Python programming language. pyabm includes 
tools to output model results (as text files, plots or ESRI shapefiles), and 
has a parameter handling system to ease the process of model testing and 
validation, and of running multiple scenarios with varying model parameters.

The toolkit was constructed by Alex Zvoleff as part of his dissertation 
research at San Diego State University (SDSU) in the Department of Geography.  
Contact Alex Zvoleff or Prof. Li An at SDSU with any questions.

pyabm is still a work in progress - while the toolkit is functional in its 
present form, changes that will be made in the near future may not be backward 
compatible with existing code. Contact Alex Zvoleff or see the `pyabm website 
<http://www.azvoleff.com/research/pyabm>`_ for more details.  A Python 3 
compatible version of pyabm is in the works, and should be released by summer 
2013.

See the `pyabm website <http://www.azvoleff.com/research/pyabm>`_ for more 
information, past releases, publications, and recent presentations.

Getting the Code
_______________________________________________________________________________

Stable releases of pyabm are available from the `Python Package Index 
(PyPI) <http://pypi.python.org/pypi/pyabm>`_.

The latest version of the code (unstable) is available as a `zipped snapshot 
from Github <https://github.com/azvoleff/pyabm/zipball/master>`_.

You can also `browse the source at GitHub 
<https://github.com/azvoleff/pyabm>`_.

The source can also be downloaded via git from::

    git://github.com/azvoleff/pyabm.git

Author Contact Information
_______________________________________________________________________________

| Alex Zvoleff
| Postdoctoral Associate
| Tropical Ecology Assessment and Monitoring (TEAM) Network
| Conservation International
| 2011 Crystal Dr. Suite 500
| Arlington, Virginia 22202
| USA

Email: azvoleff@conservation.org