# sim_tools

> Simulation Tools for Education and Practice

## Docs

### API Reference

#### Classes
> Main classes provided by the package

- [distributions.Bernoulli](https://sim-tools.github.io/sim-tools/reference/distributions.Bernoulli.html)
- [distributions.Beta](https://sim-tools.github.io/sim-tools/reference/distributions.Beta.html)
- [distributions.CombinationDistribution](https://sim-tools.github.io/sim-tools/reference/distributions.CombinationDistribution.html)
- [distributions.DiscreteEmpirical](https://sim-tools.github.io/sim-tools/reference/distributions.DiscreteEmpirical.html)
- [distributions.DistributionRegistry](https://sim-tools.github.io/sim-tools/reference/distributions.DistributionRegistry.html)
- [distributions.Erlang](https://sim-tools.github.io/sim-tools/reference/distributions.Erlang.html)
- [distributions.ErlangK](https://sim-tools.github.io/sim-tools/reference/distributions.ErlangK.html)
- [distributions.Exponential](https://sim-tools.github.io/sim-tools/reference/distributions.Exponential.html)
- [distributions.FixedDistribution](https://sim-tools.github.io/sim-tools/reference/distributions.FixedDistribution.html)
- [distributions.Gamma](https://sim-tools.github.io/sim-tools/reference/distributions.Gamma.html)
- [distributions.GroupedContinuousEmpirical](https://sim-tools.github.io/sim-tools/reference/distributions.GroupedContinuousEmpirical.html)
- [distributions.Hyperexponential](https://sim-tools.github.io/sim-tools/reference/distributions.Hyperexponential.html)
- [distributions.Lognormal](https://sim-tools.github.io/sim-tools/reference/distributions.Lognormal.html)
- [distributions.Normal](https://sim-tools.github.io/sim-tools/reference/distributions.Normal.html)
- [distributions.PearsonV](https://sim-tools.github.io/sim-tools/reference/distributions.PearsonV.html)
- [distributions.PearsonVI](https://sim-tools.github.io/sim-tools/reference/distributions.PearsonVI.html)
- [distributions.Poisson](https://sim-tools.github.io/sim-tools/reference/distributions.Poisson.html)
- [distributions.RawContinuousEmpirical](https://sim-tools.github.io/sim-tools/reference/distributions.RawContinuousEmpirical.html)
- [distributions.RawDiscreteEmpirical](https://sim-tools.github.io/sim-tools/reference/distributions.RawDiscreteEmpirical.html)
- [distributions.Triangular](https://sim-tools.github.io/sim-tools/reference/distributions.Triangular.html)
- [distributions.TruncatedDistribution](https://sim-tools.github.io/sim-tools/reference/distributions.TruncatedDistribution.html)
- [distributions.Uniform](https://sim-tools.github.io/sim-tools/reference/distributions.Uniform.html)
- [distributions.Weibull](https://sim-tools.github.io/sim-tools/reference/distributions.Weibull.html)
- [output_analysis.OnlineStatistics](https://sim-tools.github.io/sim-tools/reference/output_analysis.OnlineStatistics.html)
- [output_analysis.ReplicationTabulizer](https://sim-tools.github.io/sim-tools/reference/output_analysis.ReplicationTabulizer.html)
- [output_analysis.ReplicationsAlgorithm](https://sim-tools.github.io/sim-tools/reference/output_analysis.ReplicationsAlgorithm.html)
- [time_dependent.DistributionRegistry](https://sim-tools.github.io/sim-tools/reference/time_dependent.DistributionRegistry.html)
- [time_dependent.NSPPThinning](https://sim-tools.github.io/sim-tools/reference/time_dependent.NSPPThinning.html)

#### Abstract Classes
> Abstract base classes

- [trace.Traceable](https://sim-tools.github.io/sim-tools/reference/trace.Traceable.html)

#### Protocols
> Protocol / structural-typing interfaces

- [distributions.Distribution](https://sim-tools.github.io/sim-tools/reference/distributions.Distribution.html)
- [output_analysis.AlgorithmObserver](https://sim-tools.github.io/sim-tools/reference/output_analysis.AlgorithmObserver.html)
- [output_analysis.ReplicationObserver](https://sim-tools.github.io/sim-tools/reference/output_analysis.ReplicationObserver.html)
- [output_analysis.ReplicationsAlgorithmModelAdapter](https://sim-tools.github.io/sim-tools/reference/output_analysis.ReplicationsAlgorithmModelAdapter.html)

#### Functions
> Utility functions

- [datasets.load_banks_et_al_nspp](https://sim-tools.github.io/sim-tools/reference/datasets.load_banks_et_al_nspp.html)
- [distributions.is_integer](https://sim-tools.github.io/sim-tools/reference/distributions.is_integer.html)
- [distributions.is_non_negative](https://sim-tools.github.io/sim-tools/reference/distributions.is_non_negative.html)
- [distributions.is_numeric](https://sim-tools.github.io/sim-tools/reference/distributions.is_numeric.html)
- [distributions.is_ordered_pair](https://sim-tools.github.io/sim-tools/reference/distributions.is_ordered_pair.html)
- [distributions.is_ordered_triplet](https://sim-tools.github.io/sim-tools/reference/distributions.is_ordered_triplet.html)
- [distributions.is_positive](https://sim-tools.github.io/sim-tools/reference/distributions.is_positive.html)
- [distributions.is_positive_array](https://sim-tools.github.io/sim-tools/reference/distributions.is_positive_array.html)
- [distributions.is_probability](https://sim-tools.github.io/sim-tools/reference/distributions.is_probability.html)
- [distributions.is_probability_vector](https://sim-tools.github.io/sim-tools/reference/distributions.is_probability_vector.html)
- [distributions.spawn_seeds](https://sim-tools.github.io/sim-tools/reference/distributions.spawn_seeds.html)
- [distributions.validate](https://sim-tools.github.io/sim-tools/reference/distributions.validate.html)
- [output_analysis.confidence_interval_method](https://sim-tools.github.io/sim-tools/reference/output_analysis.confidence_interval_method.html)
- [output_analysis.plotly_confidence_interval_method](https://sim-tools.github.io/sim-tools/reference/output_analysis.plotly_confidence_interval_method.html)
- [time_dependent.nspp_plot](https://sim-tools.github.io/sim-tools/reference/time_dependent.nspp_plot.html)
- [time_dependent.nspp_simulation](https://sim-tools.github.io/sim-tools/reference/time_dependent.nspp_simulation.html)

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

- [datasets.FILE_NAME_NSPP_1](https://sim-tools.github.io/sim-tools/reference/datasets.FILE_NAME_NSPP_1.html)
- [datasets.PATH_NSPP_1](https://sim-tools.github.io/sim-tools/reference/datasets.PATH_NSPP_1.html)
- [distributions.T](https://sim-tools.github.io/sim-tools/reference/distributions.T.html)
- [output_analysis.ALG_INTERFACE_ERROR](https://sim-tools.github.io/sim-tools/reference/output_analysis.ALG_INTERFACE_ERROR.html)
- [output_analysis.OBSERVER_INTERFACE_ERROR](https://sim-tools.github.io/sim-tools/reference/output_analysis.OBSERVER_INTERFACE_ERROR.html)
- [trace.CONFIG_ERROR](https://sim-tools.github.io/sim-tools/reference/trace.CONFIG_ERROR.html)
- [trace.DEFAULT_DEBUG](https://sim-tools.github.io/sim-tools/reference/trace.DEFAULT_DEBUG.html)

#### Other
> Additional exports

- [ovs](https://sim-tools.github.io/sim-tools/reference/ovs.html)