murk 0.1.9

World simulation engine for reinforcement learning and real-time applications
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
44
45
46
47
48

# murk

Top-level facade crate for the [Murk](https://github.com/tachyon-beep/murk) simulation engine.

## Installation

```bash
cargo add murk
```

## Usage

Add this single dependency to access the full Murk API:

```rust
use murk::prelude::*;
use murk::space::Square4;

let space = Square4::new(16, 16, EdgeBehavior::Absorb).unwrap();
let config = WorldConfig {
    space: Box::new(space),
    fields: vec![FieldDef {
        name: "heat".into(),
        field_type: FieldType::Scalar,
        mutability: FieldMutability::PerTick,
        units: None,
        bounds: None,
        boundary_behavior: BoundaryBehavior::Clamp,
    }],
    propagators: vec![],
    dt: 0.1,
    seed: 42,
    ring_buffer_size: 8,
    max_ingress_queue: 64,
    tick_rate_hz: None,
    backoff: Default::default(),
};
let mut world = LockstepWorld::new(config).unwrap();
```

Sub-crates are re-exported as modules (`murk::space`, `murk::engine`, etc.).
See the [documentation](https://tachyon-beep.github.io/murk/) for the full guide.

## Documentation

- [Murk Book](https://tachyon-beep.github.io/murk/) — concepts and guides
- [API Reference](https://docs.rs/murk) — rustdoc
- [Examples](https://github.com/tachyon-beep/murk/tree/main/examples) — complete working projects