Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.22 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.22 KB
Raw

Violet

A smol simulator framework built on top of PyGame.

  • Automatic agent wandering behaviour
  • Fully deterministic simulations with PRNG seeds
  • Install Violet with a simple pip install 😎
  • Matrix-powered multi-threaded configuration testing
  • Polars-powered simulation analytics
  • Replay-able simulations with a ✨ time machine ✨
  • Type-safe configuration system (with TOML support)

Want to get started right away? Check out the Violet Starter Kit!

Installation

Install the latest version of Violet with:

pip3 install -U violet-simulator

Or with PDM:

pdm add violet-simulator

Example

from vi import Agent, Simulation

(
    # Step 1: Create a new simulation.
    Simulation()
    # Step 2: Add 100 agents to the simulation.
    .batch_spawn_agents(100, Agent, images=["examples/images/white.png"])
    # Step 3: Profit! 🎉
    .run()
)

For more information you can check the documentation, examples and the User Guide.