Skip to content

Commit

Permalink
Updating w/ readme format updates and pypi setup updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
jackiekazil committed Jul 10, 2015
1 parent 7164fd3 commit 33ec36f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
20 changes: 11 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Mesa: Agent-based modeling in Python 3+
=========================
=========================================

.. image:: https://api.travis-ci.org/projectmesa/mesa.svg
:target: https://travis-ci.org/projectmesa/mesa
Expand All @@ -11,7 +11,11 @@ Mesa: Agent-based modeling in Python 3+

It allows users to quickly create agent-based models using built-in core components (such as spatial grids and agent schedulers) or customized implementations; visualize them using a browser-based interface; and analyze their results using Python's data analysis tools. It's goal is to be the Python 3-based alternative to NetLogo, Repast, or MASON.

.. image:: https://cloud.githubusercontent.com/assets/166734/8508873/a34eb79c-2251-11e5-8904-2f3b3836d39c.png

.. image:: https://cloud.githubusercontent.com/assets/166734/8611697/ce61ad08-268a-11e5-880b-4776dd738e0e.png
:width: 100%
:scale: 100%
:alt: A screenshot of the Shelling Model in Mesa

*Above: A Mesa implementation of the Schelling segregation model,
being visualized in a browser window and analyzed in an IPython
Expand All @@ -21,14 +25,14 @@ notebook.*
Features
--------
------------

* Modular compoments
* Browser-based visualization
* Built-in tools for analysis

Using Mesa
--------
------------

Getting started quickly:

Expand All @@ -45,11 +49,11 @@ For more help on using Mesa, checkout the following resources:

.. _`Intro to Mesa Tutorial` : http://mesa.readthedocs.org/en/latest/intro-tutorial.html
.. _`Docs` : http://mesa.readthedocs.org/en/latest/
.. _`Email list` : https://groups.google.com/forum/#!forum/projectmesa
.. _`Email list` : https://groups.google.com/d/forum/projectmesa
.. _`PyPI` : https://pypi.python.org/pypi/Mesa/
Contributing back to Mesa
--------
----------------------------

If you run into an issues, please file a `ticket`_ for us to discuss. If possible, follow up with a pull request.

Expand All @@ -59,8 +63,6 @@ If you would like to add a feature, please reach out via `ticket`_ or the `email
* `Github`_

.. _`ticket` : https://github.com/projectmesa/mesa/issues
.. _`email list` : https://groups.google.com/forum/#!forum/projectmesa
.. _`email list` : https://groups.google.com/d/forum/projectmesa
.. _`Contributors guide` : https://github.com/projectmesa/mesa/blob/master/CONTRIBUTING.rst
.. _`Github` : https://github.com/projectmesa/mesa/
12 changes: 7 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@
# -*- coding: utf-8 -*-

from setuptools import setup
from codecs import open

requires = [
'tornado',
'numpy',
'pandas',
]

with open('README.rst', 'r', encoding='utf-8') as f:
readme = f.read()

# TODO: Rewrite Readme and pull that it instead.
description = """
Mesa is an agent-based modeling (or ABM) framework in Python. It allows
Expand All @@ -17,20 +21,18 @@
implementations; visualize them using a browser-based interface; and
analyze their results using Python's data analysis tools. It's goal is
to be the Python 3-based alternative to NetLogo, Repast, or MASON.
Mesa is being developed by a group of modeling practitioners with
experience in academia, government, and the private sector.
"""

setup(
name='Mesa',
version='0.6.2',
description=description,
description="Mesa: Agent-based modeling in Python 3+",
long_description=readme,
author='Project Mesa Team',
author_email='[email protected]',
url='https://github.com/projectmesa/mesa',
packages=['mesa'],
package_data={'': ['LICENSE.md', ], },
package_data={'': ['LICENSE', ], },
package_dir={'mesa': 'mesa'},
include_package_data=True,
install_requires=requires,
Expand Down

0 comments on commit 33ec36f

Please sign in to comment.