Skip to main content

PyCxsim is a framework to simulate computational agents in a confined environment.

Project description

PyCxsim Logo

docs Tests

Note: PyCxsim is still under active development.

Documentation.

Installation

You can install the latest version of PyCxsim directly from the GitHub repository (>=Python 3.8):

pip install git+https://github.com/Aatamte/PyCxsim.git

or directly from pip:

pip install pycxsim

Overview

PyCxsim is a framework to simulate computational agents in a confined environment.

Structure

from cxsim import Environment
from cxsim.artifacts import Marketplace
from cxsim.agents import Agent

# defining an environment
cxenv = Environment()

# adding an Artifact to the environment
market = Marketplace()
cxenv.add(market)

#adding an agent to the environment
agent = Agent()
cxenv.add(agent)

#the simulation loop
for episode in cxenv.iter_episodes():
    # start the next episode
    cxenv.reset()
    
    for step in cxenv.iter_steps():
        # start the next step
        cxenv.step()

GUI

One of the unique (and cool!) features of Pycxsim is the embedded GUI.

Image Description

Examples

  1. Simulate a marketplace made up of computational agents, based off experiments in the paper “An Experimental Study of Competitive Market Behavior” by Vernon Smith.
from cxsim.examples import Smith1962Environment
import openai
import os

openai.api_key = os.environ["openai_api_key"]

cxenv = Smith1962Environment(n_agents=10, model_id="gpt-4")
cxenv.test_one(market_depth=10)

Standard Artifacts

Below are the standard artifacts provided with the CAES package:

  • Marketplace
    • Agents can trade goods with each other (capital <-> good transactions only)
  • Dialogue
    • Messaging
  • Gridworld
    • Agents can move around the map

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

pycxsim-0.1.5.tar.gz (3.6 MB view hashes)

Uploaded Source

Built Distribution

pycxsim-0.1.5-py3-none-any.whl (80.5 kB view hashes)

Uploaded Python 3

Supported by

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