Mesa-LLM: Generative Agent-Based Modeling with Large Language Models Empowered Agents#

CI/CD

GitHub CI Read the Docs Codecov

Package

PyPI PyPI - License PyPI - Downloads

Meta

linting - Ruff code style: black Hatch project

Chat

chat

Mesa-LLM integrates large language models (LLMs) as decision-making agents into the Mesa agent-based modeling (ABM) framework. It enables sophisticated, language-driven agent behaviors, allowing researchers to model scenarios involving communication, negotiation, and decision-making influenced by natural language.

⚠️ WARNING ⚠️ This repository is currently under active development. The API and functionality may change significantly. Please stay tuned for our first release coming soon!

Installation#

To install Mesa-LLM, run:

pip install -U mesa-llm

Mesa-LLM pre-releases can be installed with:

pip install -U --pre mesa-llm

You can also use pip to install the GitHub version:

pip install -U -e git+https://github.com/mesa/mesa-llm.git#egg=mesa-llm

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

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

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

Supported LLM Providers#

Mesa-LLM supports the following LLM providers:

  • OpenAI

  • Anthropic

  • xAI

  • Hugging Face

  • Ollama

  • OpenRouter

  • Novita AI

  • Google Gemini

Contributing to Mesa-LLM#

Want to join the team, or just curious about what is happening with Mesa and Mesa-LLM? You can:

  • Join our Matrix chat room where questions, issues, and ideas can be discussed informally.

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

  • 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 a 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 check out the Contributors Guide.

Indices and tables#