murk-core 0.1.7

Core types and traits for the Murk 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
44
45
46
47
48
49
50
51
52
53
54

# murk-core

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

Defines the foundational types shared across all Murk crates: field definitions,
commands, receipts, IDs, error types, and the core traits (`FieldReader`,
`FieldWriter`, `SnapshotAccess`).

Most users should depend on the top-level [`murk`](https://crates.io/crates/murk)
crate instead, which re-exports these types via `murk::types`.

## Installation

```bash
cargo add murk-core
```

Most users should depend on the top-level [`murk`](https://crates.io/crates/murk) crate,
which re-exports this as `murk::types`.

## When to use directly

Depend on this crate directly only if building custom crates outside the Murk
workspace or need minimal dependencies.

## Usage

```rust
use murk_core::{FieldDef, FieldType, FieldMutability, BoundaryBehavior};

let heat = FieldDef {
    name: "heat".into(),
    field_type: FieldType::Scalar,
    mutability: FieldMutability::PerTick,
    units: Some("kelvin".into()),
    bounds: Some((0.0, 1000.0)),
    boundary_behavior: BoundaryBehavior::Clamp,
};

let velocity = FieldDef {
    name: "wind".into(),
    field_type: FieldType::Vector { dims: 3 },
    mutability: FieldMutability::Static,
    units: None,
    bounds: None,
    boundary_behavior: BoundaryBehavior::Clamp,
};
```

## Documentation

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