odem-rs-core 0.3.0

Core components of the odem-rs 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

## odem-rs Core

`odem-rs-core` is the foundational crate of the odem-rs library, providing essential structures and traits for object-based discrete-event modeling in Rust. It defines the core components that facilitate agent-based simulation modeling, event scheduling, and cooperative concurrency.

### Features

- Provides the key simulation structures `Agent`, `Job`, and `Continuation`, as well as the simulation context `Sim`.
- Implements event scheduling and deterministic execution.
- Contains supporting structures and traits like intrusively counted pointers (`Irc`), the `Config`-trait, and the `Scheduler`-trait.

### Feature Flags

| Feature         | Default | Description                                             |
| --------------- | ------- | ------------------------------------------------------- |
| `std`           | yes     | Standard library support (implies `alloc`).             |
| `alloc`         | yes     | Heap allocation for per-type agent identifiers.         |
| `tracing`       | yes     | Structured instrumentation of agents and jobs.          |
| `debug-tracing` | no      | Debug-level trace output for internal state machines.   |
| `uom`           | yes     | Type-safe SI quantities for model time.                 |

See the [API documentation](https://docs.rs/odem-rs-core) for detailed descriptions of each feature flag.

### Installation

Using the entry crate `odem-rs` is recommended, but it is possible to use this crate as a standalone simulator core.

```toml
[dependencies]
odem-rs-core = "0.3"
```

### License

Licensed under **MIT**. See [LICENSE] for details.

[LICENSE]: https://gitlab.informatik.hu-berlin.de/weber/odem-rs/blob/main/LICENSE