Quick Start

Installation

From PyPI:

pip install ideasim

From source:

git clone https://github.com/LeonardoSanBenitez/ideasim.git
cd ideasim
pip install -e ".[dev]"

Running Your First Simulation

Using the CLI:

ideasim simulate -o results.json

Using the Python API:

from ideasim.defaults import load_default_config
from ideasim.engine import simulate

config = load_default_config()
result = simulate(config, seed=42)

print(f"Final shares: {result.final_shares}")
print(f"Events triggered: {len(result.events)}")

Custom Configurations

Export the default configuration to customize it:

ideasim default-config -o my_config.json

Edit the JSON file, then run:

ideasim simulate my_config.json -o results.json