# Mesa: Agent-based modeling in Python
| | |
| --- | --- |
| CI/CD | [](https://github.com/projectmesa/mesa/actions) [](https://codecov.io/gh/projectmesa/mesa) |
| Package | [](https://pypi.org/project/Mesa/) [](https://pypi.org/project/Mesa/) [](https://pypi.org/project/Mesa/) |
| Meta | [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) [](https://github.com/pypa/hatch) [](https://scientific-python.org/specs/spec-0000/) |
| Chat | [](https://matrix.to/#/#project-mesa:matrix.org) |
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.
*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 (3.0.x), run:
``` bash
pip install -U mesa
```
To install our latest pre-release, run:
``` bash
pip install -U --pre mesa
```
Starting with Mesa 3.0, we don't install all our dependencies anymore by default.
```bash
# You can customize the additional dependencies you need, if you want. Available are:
pip install -U --pre mesa[network,viz]
# This is equivalent to our recommended dependencies:
pip install -U --pre mesa[rec]
# To install all, including developer, dependencies:
pip install -U --pre mesa[all]
```
You can also use `pip` to install the latest GitHub version:
``` bash
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:
``` bash
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:
- [Intro to Mesa Tutorial](http://mesa.readthedocs.org/en/stable/tutorials/intro_tutorial.html) (An introductory model, the Boltzmann
Wealth Model, for beginners or those new to Mesa.)
- [Visualization Tutorial](https://mesa.readthedocs.io/stable/tutorials/visualization_tutorial.html) (An introduction into our Solara visualization)
- [Complexity Explorer Tutorial](https://www.complexityexplorer.org/courses/172-agent-based-models-with-python-an-introduction-to-mesa) (An advanced-beginner model,
SugarScape with Traders, with instructional videos)
- [Mesa Examples](https://github.com/projectmesa/mesa-examples) (A repository of seminal ABMs using Mesa and
examples of employing specific Mesa Features)
- [Docs](http://mesa.readthedocs.org/) (Mesa's documentation, API and useful snippets)
- [Development version docs](https://mesa.readthedocs.io/latest/) (the latest version docs if you're using a pre-release Mesa version)
- [Discussions](https://github.com/projectmesa/mesa/discussions) (GitHub threaded discussions about Mesa)
- [Matrix Chat](https://matrix.to/#/#project-mesa:matrix.org) (Chat Forum via Matrix to talk about Mesa)
## 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](https://docs.docker.com/compose/install/) and then, in the
folder containing the Mesa Git repository, you run:
``` bash
$ 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](https://matrix.to/#/#project-mesa:matrix.org) 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](https://github.com/projectmesa/mesa/discussions)).
> - Just check out the code on [GitHub](https://github.com/projectmesa/mesa/).
If you run into an issue, please file a [ticket](https://github.com/projectmesa/mesa/issues) 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](https://github.com/projectmesa/mesa/issues) or
join a dev session (see [Mesa discussions](https://github.com/projectmesa/mesa/discussions)). A feature is most likely
to be added if you build it!
Don't forget to checkout the [Contributors guide](https://github.com/projectmesa/mesa/blob/main/CONTRIBUTING.md).
## Citing Mesa
To cite Mesa in your publication, you can use the [CITATION.bib](https://github.com/projectmesa/mesa/blob/main/CITATION.bib).
Raw data
{
"_id": null,
"home_page": null,
"name": "Mesa",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "ABM, agent, based, model, modeling, multi-agent, simulation",
"author": null,
"author_email": "Project Mesa Team <projectmesa@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/8d/c6fd7423ad08afd5b4bab000946d76878bc494a84965c0f56fb4fd67aedd/mesa-3.1.1.tar.gz",
"platform": null,
"description": "# Mesa: Agent-based modeling in Python\n\n| | |\n| --- | --- |\n| CI/CD | [](https://github.com/projectmesa/mesa/actions) [](https://codecov.io/gh/projectmesa/mesa) |\n| Package | [](https://pypi.org/project/Mesa/) [](https://pypi.org/project/Mesa/) [](https://pypi.org/project/Mesa/) |\n| Meta | [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) [](https://github.com/pypa/hatch) [](https://scientific-python.org/specs/spec-0000/) |\n| Chat | [](https://matrix.to/#/#project-mesa:matrix.org) |\n\nMesa allows users to quickly create agent-based models using built-in\ncore components (such as spatial grids and agent schedulers) or\ncustomized implementations; visualize them using a browser-based\ninterface; and analyze their results using Python's data analysis\ntools. Its goal is to be the Python-based alternative to NetLogo,\nRepast, or MASON.\n\n\n\n*Above: A Mesa implementation of the WolfSheep model, this\ncan be displayed in browser windows or Jupyter.*\n\n## Features\n\n- Modular components\n- Browser-based visualization\n- Built-in tools for analysis\n- Example model library\n\n## Using Mesa\n\nTo install our latest stable release (3.0.x), run:\n\n``` bash\npip install -U mesa\n```\n\nTo install our latest pre-release, run:\n\n``` bash\npip install -U --pre mesa\n```\nStarting with Mesa 3.0, we don't install all our dependencies anymore by default.\n```bash\n# You can customize the additional dependencies you need, if you want. Available are:\npip install -U --pre mesa[network,viz]\n\n# This is equivalent to our recommended dependencies:\npip install -U --pre mesa[rec]\n\n# To install all, including developer, dependencies:\npip install -U --pre mesa[all]\n```\n\nYou can also use `pip` to install the latest GitHub version:\n\n``` bash\npip install -U -e git+https://github.com/projectmesa/mesa@main#egg=mesa\n```\n\nOr any other (development) branch on this repo or your own fork:\n\n``` bash\npip install -U -e git+https://github.com/YOUR_FORK/mesa@YOUR_BRANCH#egg=mesa\n```\n\n## Resources\nFor resources or help on using Mesa, check out the following:\n\n- [Intro to Mesa Tutorial](http://mesa.readthedocs.org/en/stable/tutorials/intro_tutorial.html) (An introductory model, the Boltzmann\n Wealth Model, for beginners or those new to Mesa.)\n- [Visualization Tutorial](https://mesa.readthedocs.io/stable/tutorials/visualization_tutorial.html) (An introduction into our Solara visualization)\n- [Complexity Explorer Tutorial](https://www.complexityexplorer.org/courses/172-agent-based-models-with-python-an-introduction-to-mesa) (An advanced-beginner model,\n SugarScape with Traders, with instructional videos)\n- [Mesa Examples](https://github.com/projectmesa/mesa-examples) (A repository of seminal ABMs using Mesa and\n examples of employing specific Mesa Features)\n- [Docs](http://mesa.readthedocs.org/) (Mesa's documentation, API and useful snippets)\n - [Development version docs](https://mesa.readthedocs.io/latest/) (the latest version docs if you're using a pre-release Mesa version)\n- [Discussions](https://github.com/projectmesa/mesa/discussions) (GitHub threaded discussions about Mesa)\n- [Matrix Chat](https://matrix.to/#/#project-mesa:matrix.org) (Chat Forum via Matrix to talk about Mesa)\n\n## Running Mesa in Docker\n\nYou can run Mesa in a Docker container in a few ways.\n\nIf you are a Mesa developer, first [install Docker\nCompose](https://docs.docker.com/compose/install/) and then, in the\nfolder containing the Mesa Git repository, you run:\n\n``` bash\n$ docker compose up\n# If you want to make it run in the background, you instead run\n$ docker compose up -d\n```\n\nThis runs the Schelling model, as an example.\n\nWith the docker-compose.yml file in this Git repository, the `docker compose up` command does two important things:\n\n- It mounts the mesa root directory (relative to the\n docker-compose.yml file) into /opt/mesa and runs pip install -e on\n that directory so your changes to mesa should be reflected in the\n running container.\n- It binds the docker container's port 8765 to your host system's\n port 8765 so you can interact with the running model as usual by\n visiting localhost:8765 on your browser\n\nIf you are a model developer that wants to run Mesa on a model, you need\nto:\n\n- make sure that your model folder is inside the folder containing the\n docker-compose.yml file\n- change the `MODEL_DIR` variable in docker-compose.yml to point to\n the path of your model\n- make sure that the model folder contains an app.py file\n\nThen, you just need to run `docker compose up -d` to have it\naccessible from `localhost:8765`.\n\n## Contributing to Mesa\n\nWant to join the Mesa team or just curious about what is happening with\nMesa? You can\\...\n\n> - Join our [Matrix chat room](https://matrix.to/#/#project-mesa:matrix.org) in which questions, issues, and\n> ideas can be (informally) discussed.\n> - Come to a monthly dev session (you can find dev session times,\n> agendas and notes on [Mesa discussions](https://github.com/projectmesa/mesa/discussions)).\n> - Just check out the code on [GitHub](https://github.com/projectmesa/mesa/).\n\nIf you run into an issue, please file a [ticket](https://github.com/projectmesa/mesa/issues) for us to discuss. If\npossible, follow up with a pull request.\n\nIf you would like to add a feature, please reach out via [ticket](https://github.com/projectmesa/mesa/issues) or\njoin a dev session (see [Mesa discussions](https://github.com/projectmesa/mesa/discussions)). A feature is most likely\nto be added if you build it!\n\nDon't forget to checkout the [Contributors guide](https://github.com/projectmesa/mesa/blob/main/CONTRIBUTING.md).\n\n## Citing Mesa\n\nTo cite Mesa in your publication, you can use the [CITATION.bib](https://github.com/projectmesa/mesa/blob/main/CITATION.bib).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Agent-based modeling (ABM) in Python",
"version": "3.1.1",
"project_urls": {
"homepage": "https://github.com/projectmesa/mesa",
"repository": "https://github.com/projectmesa/mesa"
},
"split_keywords": [
"abm",
" agent",
" based",
" model",
" modeling",
" multi-agent",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47a3bf3f3e8c7b1f9c81475bd1c54da9c663d6fb711e831cabdcbd1923f9c43b",
"md5": "5890b195d4ca1b33f51189866a301dc9",
"sha256": "1eecdb88a394084c0d605a2de59397a3f12393d45239730e1681ce64e8bfea77"
},
"downloads": -1,
"filename": "mesa-3.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5890b195d4ca1b33f51189866a301dc9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 225606,
"upload_time": "2024-12-14T16:26:35",
"upload_time_iso_8601": "2024-12-14T16:26:35.671542Z",
"url": "https://files.pythonhosted.org/packages/47/a3/bf3f3e8c7b1f9c81475bd1c54da9c663d6fb711e831cabdcbd1923f9c43b/mesa-3.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba8dc6fd7423ad08afd5b4bab000946d76878bc494a84965c0f56fb4fd67aedd",
"md5": "2fe21ea469e929d564054d8678f7cd6e",
"sha256": "e7c849958b39edac5665216a13cde58423a8dbda97b5cbcd8d5701f8ff02e0ee"
},
"downloads": -1,
"filename": "mesa-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2fe21ea469e929d564054d8678f7cd6e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 2529512,
"upload_time": "2024-12-14T16:26:38",
"upload_time_iso_8601": "2024-12-14T16:26:38.910867Z",
"url": "https://files.pythonhosted.org/packages/ba/8d/c6fd7423ad08afd5b4bab000946d76878bc494a84965c0f56fb4fd67aedd/mesa-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 16:26:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "projectmesa",
"github_project": "mesa",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mesa"
}
JSON
