Simulate
Simulate populations from packaged presets or graph config files.
Classes¶
Functions:¶
simulate_command(config: Annotated[str, Option('--config', help='Preset name or YAML/TOML config-file path.')], output: Annotated[Path, Option('--output', help='Destination .csv, .h5, or .hdf5 file.')], n: Annotated[int | None, Option('--n', min=0, help='Number of events to sample. Defaults to a configured run.n_samples.')] = None, seed: Annotated[int | None, Option('--seed', help='Random seed. Defaults to a configured run.seed, otherwise one is drawn.')] = None) -> None
Simulate a population and persist it as a named-column catalogue.
The catalogue is written with a provenance record: the package version and
checkout state, the complete resolved configuration, the seed as actually
used, and the column list in output order. HDF5 files carry the record in a
metadata group; CSV files get a JSON sidecar. Set
run.output.save_metadata to false to write the samples alone.