Skip to content

Simulate

simulate

Simulate populations from packaged presets or graph config files.

Functions

simulate_command

simulate_command(config: Annotated[str, Option('--config', help='Preset name or YAML/TOML config-file path.')], n: Annotated[int, Option('--n', min=0, help='Number of events to sample.')], output: Annotated[Path, Option('--output', help='Destination .csv, .h5, or .hdf5 file.')], seed: Annotated[int | None, Option('--seed', help='Optional random seed.')] = None) -> None

Simulate a population and persist it as a named-column catalogue.