# ambdes

> Ambulance discrete event simulation

## Docs

### API Reference

#### Classes
> Core classes

- [WarmUpAuditor](https://ambmodels.github.io/ambdes/reference/WarmUpAuditor.html): Warm-up auditor - records cumulative mean results at intervals
- [SimConfig](https://ambmodels.github.io/ambdes/reference/SimConfig.html): Configuration for a simulation run
- [FitDist](https://ambmodels.github.io/ambdes/reference/FitDist.html): Fit distributions using sim-tools and compare samples to real data
- [Model](https://ambmodels.github.io/ambdes/reference/Model.html): Discrete-event simulation model for generating patient calls
- [Patient](https://ambmodels.github.io/ambdes/reference/Patient.html): Represents a patient who has called 999
- [Results](https://ambmodels.github.io/ambdes/reference/Results.html): Simulation output for a single model run
- [UtilisationCalculator](https://ambmodels.github.io/ambdes/reference/UtilisationCalculator.html): Compute time-weighted ambulance utilisation from an event log
- [Runner](https://ambmodels.github.io/ambdes/reference/Runner.html): Run the simulation for one or more replications

#### Functions
> Public functions

- [plot_warm_up](https://ambmodels.github.io/ambdes/reference/plot_warm_up.html): Plot warm-up trajectories for one metric and response category
- [run_warm_up_audit](https://ambmodels.github.io/ambdes/reference/run_warm_up_audit.html): Run warm-up audit for one or more replications (can run in parallel)
- [build_arrival_config](https://ambmodels.github.io/ambdes/reference/build_arrival_config.html): Determine arrival parameters and create config dict
- [fit_config](https://ambmodels.github.io/ambdes/reference/fit_config.html): Fit distributions for each metric and category from raw time data
- [plot_metric_kde](https://ambmodels.github.io/ambdes/reference/plot_metric_kde.html): Plot KDE curve by category (C1-C4)
- [plot_observed_fitted](https://ambmodels.github.io/ambdes/reference/plot_observed_fitted.html): Plot overlaid comparison of observed vs fitted data

#### Constants
> Module-level constants and data

- [DISTRIBUTIONS](https://ambmodels.github.io/ambdes/reference/DISTRIBUTIONS.html): Built-in mutable sequence