Skip to main content

Mesa: Agent-based modeling in Python 3+

https://github.com/projectmesa/mesa/workflows/build/badge.svg https://codecov.io/gh/projectmesa/mesa/branch/main/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/matrix/project-mesa:matrix.org?label=chat&logo=Matrix

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. Its goal is to be the Python 3-based alternative to NetLogo, Repast, or MASON.

A screenshot of the Schelling Model in Mesa

Above: A Mesa implementation of the Schelling segregation model, being visualized in a browser window and analyzed in a Jupyter notebook.

Features

  • Modular components

  • Browser-based visualization

  • Built-in tools for analysis

  • Example model library

Using Mesa

Getting started quickly:

$ pip install mesa

You can also use pip to install the github version:

$ pip install -U -e git+https://github.com/projectmesa/mesa@main#egg=mesa

Or any other (development) branch on this repo or your own fork:

$ pip install -U -e git+https://github.com/YOUR_FORK/mesa@YOUR_BRANCH#egg=mesa

Take a look at the examples folder for sample models demonstrating Mesa features.

For more help on using Mesa, check out the following resources:

Running Mesa in Docker

You can run Mesa in a Docker container in a few ways.

If you are a Mesa developer, first install Docker Compose and then, in the folder containing the Mesa Git repository, you run:

$ docker compose up
# If you want to make it run in the background, you instead run
$ docker compose up -d

This runs the wolf-sheep predation model, as an example.

With the docker-compose.yml file in this Git repository, the docker compose up command does two important things:

  • It mounts the mesa root directory (relative to the docker-compose.yml file) into /opt/mesa and runs pip install -e on that directory so your changes to mesa should be reflected in the running container.

  • It binds the docker container’s port 8521 to your host system’s port 8521 so you can interact with the running model as usual by visiting localhost:8521 on your browser

If you are a model developer that wants to run Mesa on a model, you need to:

  • make sure that your model folder is inside the folder containing the docker-compose.yml file

  • change the MODEL_DIR variable in docker-compose.yml to point to the path of your model

  • make sure that the model folder contains a run.py file

Then, you just need to run docker compose up -d to make it accessible from localhost:8521.

Contributing to Mesa

Want to join the Mesa team or just curious about what is happening with Mesa? You can…

  • Join our Matrix chat room in which questions, issues, and ideas can be (informally) discussed.

  • Come to a monthly dev session (you can find dev session times, agendas and notes on Mesa discussions).

  • Just check out the code on GitHub.

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

If you would like to add a feature, please reach out via ticket or join a dev session (see Mesa discussions). A feature is most likely to be added if you build it!

Don’t forget to checkout the Contributors guide.

Citing Mesa

To cite Mesa in your publication, you can use the CITATION.bib.

Metadata

Release files for Mesa 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Mesa 1.1.1
File Size Uploaded Provenance Actions
Mesa-1.1.1.tar.gz 1.8 MB Without provenance Details for Mesa-1.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for Mesa 1.1.1
File Interpreter ABI Platform Actions
Mesa-1.1.1-py3-none-any.whl Python 3 none any Details for Mesa-1.1.1-py3-none-any.whl

Total release size: 3.6 MB

Release files / Mesa-1.1.1.tar.gz

Download URL Mesa-1.1.1.tar.gz
Size 1.8 MB
Tags Source
SHA-256 checksum
How to use checksums
14f40b3c2948f02295b1a719b380cb1676a29154b0adebd4e537d431ebd78126
BLAKE2b-256 checksum
How to use checksums
ecaf390279bc23f56172e5bd20adc828b8f93b5c4d39bced8b4a311db8a5ce7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.9

Release files / Mesa-1.1.1-py3-none-any.whl

Download URL Mesa-1.1.1-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
65757c5fe189a1abd87829f1a4aed496bd08874ab77f4d326e0a83e76707d14d
BLAKE2b-256 checksum
How to use checksums
bd102214be257cbdaa2c9c4f9968b47d36b23494047df6faeaa519dc37d1591f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.9

Security for Mesa 1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files No provenance

0.7.8

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page