AgentSim
Multi-agent simulation framework for studying agent behaviors in grid-based environments. Supports reactive, deliberative (BDI), and reinforcement-learning agents with built-in scenarios, metrics, and ASCII visualization.
Features
- Three agent architectures — Reactive (condition-action rules), Deliberative (BDI goals/beliefs/plans), and Q-learning agents in a single unified interface.
- Grid environment — 2D grid with configurable walls, food resources, and multi-agent support; extend via
BaseEnvironment. - Turnkey scenarios —
ForagingScenario(multi-agent food collection) andPursuitScenario(predator-prey) runnable in one call. - Episode orchestration —
Simulationdrives agent-environment loops across multiple episodes, tracking per-agent rewards and step counts. - Metrics and analysis —
compute_metricsandcompute_trajectory_statsaggregate episode results into structured summaries. - ASCII visualization —
render_grid_asciiandsimulation_reportproduce plain-text grid snapshots and run reports with no GUI dependency.
Quick Start
pip install agentsim
from agentsim import (
GridEnvironment,
LearningAgent,
Simulation,
SimulationConfig,
compute_metrics,
simulation_report,
)
# Build environment and agent
env = GridEnvironment(width=10, height=10, n_food=15, n_walls=8)
agent = LearningAgent("learner", position=(0, 0))
env.add_agent(agent)
# Run 20 episodes
cfg = SimulationConfig(max_steps=200, n_episodes=20)
sim = Simulation(env, [agent], config=cfg)
results = sim.run()
# Analyse and display
metrics = compute_metrics(results, [agent])
print(simulation_report(results, [agent]))
print(sim.summary())
Use a built-in scenario instead:
from agentsim import ForagingScenario, make_forager
scenario = ForagingScenario(grid_size=12, n_food=20)
agents = [make_forager(f"agent_{i}", position=(i, 0)) for i in range(3)]
result = scenario.run(agents)
print(f"Collected {result.total_collected} food in {result.steps} steps "
f"(efficiency {result.efficiency:.2f})")
Architecture
agentsim/
├── agents/
│ ├── base.py # BaseAgent, AgentState — abstract interface
│ ├── reactive.py # ReactiveAgent — condition-action rules
│ ├── deliberative.py # DeliberativeAgent — BDI (goals, beliefs, plans)
│ └── learning.py # LearningAgent — Q-learning, epsilon-greedy
├── environment/
│ ├── base.py # BaseEnvironment — reset/step/render contract
│ └── grid.py # GridEnvironment — 2D grid, walls, food
├── scenarios/
│ ├── foraging.py # ForagingScenario, make_forager()
│ └── pursuit.py # PursuitScenario, make_predator(), make_prey()
├── simulation.py # Simulation, SimulationConfig, EpisodeResult
├── analysis.py # compute_metrics, compute_trajectory_stats
└── viz.py # render_grid_ascii, simulation_report
Data flow per episode:
Simulation.run_episode()callsenv.reset()→ returns initial observations per agent.- Each step:
agent.step(obs)→ action →env.step(agent_id, action)→(new_obs, reward, done). agent.receive_reward(reward)updates internal state; loop continues untildoneormax_steps.EpisodeResultcollected;compute_metrics()aggregates across episodes.
Extension points:
- New agent type: subclass
BaseAgent, implementperceive()anddecide(). - New environment: subclass
BaseEnvironment, implementreset(),step(),render(). - New scenario: compose agents + environment setup and delegate to
Simulation.
Development
git clone https://github.com/techknowmad/agent-sim.git
cd agent-sim
pip install -e ".[dev]"
pytest -v
ruff check .
Contributing
See CONTRIBUTING.md for branch, test, and PR conventions.
License
MIT — see LICENSE.
Built by TechKnowMad Labs
Metadata
Release files for tkm-agentsim 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tkm_agentsim-0.1.0.tar.gz | 102.3 kB | Without provenance | Details for tkm_agentsim-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tkm_agentsim-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for tkm_agentsim-0.1.0-py3-none-any.whl |
Total release size: 123.6 kB
Release files / tkm_agentsim-0.1.0.tar.gz
| Download URL | tkm_agentsim-0.1.0.tar.gz |
|---|---|
| Size | 102.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a5c7df3bc73e697a46e1bdc943608593b72d7a3e8833a95d68ee9d5d222f9f95
|
|
BLAKE2b-256 checksum How to use checksums |
12a69995c4d74ba587099c68447d9c295618bf5d21fa3fbfd97a1d6994997087
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Release files / tkm_agentsim-0.1.0-py3-none-any.whl
| Download URL | tkm_agentsim-0.1.0-py3-none-any.whl |
|---|---|
| Size | 21.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6728d43a1d480b18085326b345cbed5dcbe9ab1704a79a6db25fb109b1f50187
|
|
BLAKE2b-256 checksum How to use checksums |
0dbfe7200615ff79265d081b022d453583dede4a3614d4fb24ee139946ca4c19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Security for tkm-agentsim 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.