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.3.tar.gz (81.8 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.3-py3-none-any.whl (63.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: econagents-0.2.3.tar.gz
  • Upload date:
  • Size: 81.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","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.3.tar.gz
Algorithm Hash digest
SHA256 68e9d8deaf6a8be5900931e8953ac9683d2141f9aeba7cce611f656cfc4b3e97
MD5 4e49e3540f1d42a6485d9b33ff943425
BLAKE2b-256 2cf152588d8095f911f6e363a21294bf3d1f2876fc50fad8a845eff24b816b40

See more details on using hashes here.

File details

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

File metadata

  • Download URL: econagents-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 63.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bf0ba6d6fc6702556d9d1f14cd62c35953297a91e46716601718ec9225724986
MD5 83ba6e38a2021c1403ea0a055d69d49d
BLAKE2b-256 6c59200484f7be520c63ab1b87d8040050b9f75d466924c80c8516bf33339347

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