How alanmac07/marl-aquarium works
Aquarium is a PettingZoo-compatible multi-agent predator–prey simulation for reinforcement-learning experiments. The main workflow is to create the wrapped environment, let an agent choose actions from observations, advance the simulation, and obtain rewards, termination status, and rendered frames. The environment also exposes configurable population dynamics, field of view, toroidal-world behavior, and visual debugging options. The environment source is partial, so some internal stage boundaries are modeled from documented behavior; unsampled implementation details and unverified links are omitted.
Main entry points: aquarium.py Aquarium runtime · view.py Aquarium view · vector.py Vector math · prey.py Prey entities
Components 14
Environment API
- Environment factory
marl_aquarium/aquarium_v0.py
Simulation
- Aquarium runtime
marl_aquarium/env/aquarium.py - Observations
marl_aquarium/env/aquarium.py - Action dynamics
marl_aquarium/env/aquarium.py - Rewards and outcomes
marl_aquarium/env/aquarium.py
Entities and Geometry
- Prey entities
marl_aquarium/env/prey.py - Predator entities
marl_aquarium/env/predator.py - Entity base
marl_aquarium/env/entity.py - Torus utilities
marl_aquarium/env/utils.py - Vector math
marl_aquarium/env/vector.py
Rendering
- Aquarium view
marl_aquarium/env/view.py
Other components
- Environment user
- Agent policy
- Pygame
Connections 25
- Environment user → Environment factory: creates environment
README.md - Environment factory → Aquarium runtime: configures runtime
marl_aquarium/aquarium_v0.py - Environment user → Aquarium runtime: steps and resets
README.md - Agent policy → Aquarium runtime: supplies actions
README.md - Aquarium runtime → Observations: provides observations
README.md - Aquarium runtime → Rewards and outcomes: returns rewards
README.md - Aquarium runtime → Action dynamics: advances simulation
marl_aquarium/env/aquarium.py - Aquarium runtime → Prey entities: creates prey
marl_aquarium/env/aquarium.py - Aquarium runtime → Predator entities: creates predators
marl_aquarium/env/aquarium.py - Aquarium runtime → Torus utilities: uses torus helpers
marl_aquarium/env/aquarium.py - Aquarium runtime → Vector math: uses vector math
marl_aquarium/env/aquarium.py - Aquarium runtime → Aquarium view: renders frames
marl_aquarium/env/aquarium.py - Prey entities → Entity base: inherits from
marl_aquarium/env/prey.py - Predator entities → Entity base: inherits from
marl_aquarium/env/predator.py - Entity base → Vector math: uses vectors
marl_aquarium/env/entity.py - Prey entities → Vector math: uses vectors
marl_aquarium/env/prey.py - Predator entities → Vector math: uses vectors
marl_aquarium/env/predator.py - Torus utilities → Vector math: uses vectors
marl_aquarium/env/utils.py - Aquarium view → Pygame: draws with
marl_aquarium/env/view.py - Aquarium view → Torus utilities: uses helpers
marl_aquarium/env/view.py - Aquarium view → Entity base: draws entities
marl_aquarium/env/view.py - Aquarium view → Prey entities: draws prey
marl_aquarium/env/view.py - Aquarium view → Predator entities: draws predators
marl_aquarium/env/view.py - Aquarium view → Vector math: uses vectors
marl_aquarium/env/view.py - Environment user → Aquarium view: requests rendering
README.md