desque 0.2.0

Lightweight discrete-event simulation framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

# desque

[![Test Status](https://github.com/bill-pace/desque/actions/workflows/tests.yml/badge.svg?event=push)](https://github.com/bill-pace/desque/actions)
[![Crate](https://img.shields.io/crates/v/desque.svg)](https://crates.io/crates/desque)
[![Docs](https://docs.rs/desque/badge.svg)](https://docs.rs/desque)

desque provides a lightweight framework for developing discrete-event simulations.
Designed with a use case of "headless CLI" in mind, it comes with no unwanted
bloat. The framework also enables running multiple repetitions across multiple
threads by encouraging non-static data storage in simulation state.

For a quick example of how to get started with desque, check out the 
[M/M/1 queue](https://github.com/bill-pace/desque/blob/main/examples/mm1_queue.rs).
This simple queueing model demonstrates how to define several event types that interact
through shared system state and initialize an event that schedules further events to
create dynamic behavior.

The [CRN queues](https://github.com/bill-pace/desque/blob/main/examples/crn_queues.rs)
example showcases how a similar system can be set up for more advanced statistical
analysis using the variance reduction technique known as common random numbers. This
example also takes advantage of multithreading to run each server configuration up for
comparison simultaneously.

The [parallel event](https://github.com/bill-pace/desque/blob/main/examples/parallel_event.rs)
example also demonstrates parallelization. This example has a main event type which
is able to schedule follow-on events from each thread it spawns using the features
in desque's `threadsafe` module.

[Detailed documentation](https://docs.rs/desque) explains the interface for all exported
types and the requirements for template parameters in client code.

# Compatibility

desque requires access to the Rust standard library. Rust language versions of at least
1.63.0 provide all necessary features for this library and its dev dependencies.

By default, desque has no runtime dependencies. However, enabling the `ordered-float`
feature adds a dependency on the [`ordered-float`](https://crates.io/crates/ordered-float)
crate to allow using its `OrderedFloat` and `NotNan` structs as time values in desque.

# License

desque is distributed under the [MIT license](https://github.com/bill-pace/desque/blob/main/LICENSE).