Skip to main content

A Python library that lets you use LLM agents in economic experiments.

Project description

Python compat PyPi GHA Status Documentation Status


econagents

econagents is a Python library that lets you use LLM agents in economic experiments. The framework connects agents to game servers, projects server events into typed game state, asks role-specific LLM policies for actions, and sends those actions back through protocol adapters.

Key Features

  • Agent Runtime: Run one explicit Agent per simulated player.
  • Ports and Adapters: Swap protocol codecs, transports, prompt renderers, response parsers, and state projectors.
  • Flexible Agent Customization: Customize behavior with Jinja templates, response schemas, personas, or custom Python phase handlers.
  • Event-Driven State Management: Project server events into typed public, private, and meta state.
  • Turn-Based and Continuous Action Support: Handle one-shot phase decisions and repeated continuous-phase actions.

Installation

# Install from PyPI
pip install econagents

# Or install directly from GitHub
pip install git+https://github.com/IBEX-TUDelft/econagents.git

Framework Components

econagents consists of these main components:

  1. Domain Types: Event, Action, PhaseId, and AgentContext.
  2. Ports: Interfaces for codecs, transports, prompt rendering, response parsing, and state projection.
  3. Adapters: IBEX envelopes, WebSocket transport, Jinja prompts, JSON response parsing, and EventField state projection.
  4. Roles: Role-specific LLM policies and phase participation rules.
  5. Agents: One runtime per simulated player.
  6. Game Runner: Supervises agents, logging, timeout, and cleanup.

Example Experiments

The repository includes four example games:

  1. prisoner: An iterated Prisoner's Dilemma game with 5 rounds and 2 LLM agents, runs on a local python server (included).
  2. dictator: A modified Dictator game with 2 LLM agents that runs on a local python server (included).
  3. public_goods: A public goods game with 4 players that runs on a local python server (included).
  4. continuous_double_auction: A classical continuous double auction with LLM-backed traders using a continuous market phase.

Running the Prisoner's Dilemma game

The simplest game to run is a version of the repeated prisoner's dilemma game that runs on your local machine.

# Run the server
uv run python examples/prisoner/server/server.py

# Run the experiment (in a separate terminal)
uv run python examples/prisoner/run_game.py

Note: set OPENAI_API_KEY before running OpenAI-backed examples.

Documentation

For detailed guides and API reference, visit the documentation.

You should also check out the econagents cookbook for more examples.

Project details


Download files

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

Source Distribution

econagents-0.2.7.tar.gz (83.2 kB view details)

Uploaded Source

Built Distribution

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

econagents-0.2.7-py3-none-any.whl (65.1 kB view details)

Uploaded Python 3

File details

Details for the file econagents-0.2.7.tar.gz.

File metadata

  • Download URL: econagents-0.2.7.tar.gz
  • Upload date:
  • Size: 83.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for econagents-0.2.7.tar.gz
Algorithm Hash digest
SHA256 9bc28fe4c8e5f0bbc7d00a6fae9a58562c02bd31a799ba63d3b3edc40e1e5a1a
MD5 f6e82485f4d8c57c77fdf685ad5c00b7
BLAKE2b-256 69bc467892d2f0b3111164c2414b63d98031aa72acc0a290d32ff8562ab3e51b

See more details on using hashes here.

File details

Details for the file econagents-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: econagents-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 65.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for econagents-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 fe7b3c6ca79de00bb9e0969ac8d23927556043614d8176f7dabaf1e6f84af7c2
MD5 3bd0a01cbe74f0dfb2b90dddf5b1656f
BLAKE2b-256 41d8a55d51937c523c9ac577271dd42c42d06a25a01b4b796f5cd9661cb80e59

See more details on using hashes here.

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