Skip to main content

Agent-based modeling (ABM) in Python

Project description

Mesa: Agent-based modeling in Python

CI/CD GitHub Actions build status Coverage status
Package PyPI - Version PyPI - Downloads PyPI - Python Version
Meta linting - Ruff code style: black Hatch project SPEC 0 — Minimum Supported Dependencies
Chat chat
Cite DOI

Mesa 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-based alternative to NetLogo, Repast, or MASON.

A screenshot of the WolfSheep Model in Mesa

Above: A Mesa implementation of the WolfSheep model, this can be displayed in browser windows or Jupyter.

Features

  • Modular components
  • Browser-based visualization
  • Built-in tools for analysis
  • Example model library

Using Mesa

To install our latest stable release, run:

pip install -U mesa

Starting with Mesa 3.0, we don't install all our dependencies anymore by default.

# You can customize the additional dependencies you need, if you want. Available are:
pip install -U "mesa[network,viz]"

# This is equivalent to our recommended dependencies:
pip install -U "mesa[rec]"

# To install all, including developer, dependencies:
pip install -U "mesa[all]"

You can also use pip to install the latest 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

Resources

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

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 Schelling 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 8765 to your host system's port 8765 so you can interact with the running model as usual by visiting localhost:8765 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 an app.py file

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

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 refer to our peer-reviewed article in the Journal of Open Source Software (JOSS):

  • ter Hoeven, E., Kwakkel, J., Hess, V., Pike, T., Wang, B., rht, & Kazil, J. (2025). Mesa 3: Agent-based modeling with Python in 2025. Journal of Open Source Software, 10(107), 7668. https://doi.org/10.21105/joss.07668

Our CITATION.cff can be used to generate APA, BibTeX and other citation formats.

Project details


Release history Release notifications | RSS feed

This version

3.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mesa-3.3.0.tar.gz (675.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mesa-3.3.0-py3-none-any.whl (239.6 kB view details)

Uploaded Python 3

File details

Details for the file mesa-3.3.0.tar.gz.

File metadata

  • Download URL: mesa-3.3.0.tar.gz
  • Upload date:
  • Size: 675.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mesa-3.3.0.tar.gz
Algorithm Hash digest
SHA256 49b4945a03b88a063d85e6c2674498dff5ee8ed6ef08fcf465370dce75f71722
MD5 aec220883e7252738291b7daae6d9c90
BLAKE2b-256 d695d56a50fee2b6c7c3c371a96164feb49982a5ac0c64d7990d640480946f92

See more details on using hashes here.

Provenance

The following attestation bundles were made for mesa-3.3.0.tar.gz:

Publisher: release.yml on projectmesa/mesa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mesa-3.3.0-py3-none-any.whl.

File metadata

  • Download URL: mesa-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 239.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mesa-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f50039e6e1d3eca4455753205a2440d9d56db01495154ba071903b5b4975e548
MD5 aaa155becee6b4aabaea687b9a14fed2
BLAKE2b-256 6e57147b19686c6f12ee3b5395af7887e70079163e7141b8ed462812003762be

See more details on using hashes here.

Provenance

The following attestation bundles were made for mesa-3.3.0-py3-none-any.whl:

Publisher: release.yml on projectmesa/mesa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page