bmi-rust 0.1.1

Rust trait for the CSDMS Basic Model Interface
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

# bmi-rust

[![crates.io](https://img.shields.io/crates/v/bmi-rust.svg)](https://crates.io/crates/bmi-rust)
[![docs.rs](https://docs.rs/bmi-rust/badge.svg)](https://docs.rs/bmi-rust)
[![GitHub Actions](https://github.com/eWaterCycle/bmi-rust/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/eWaterCycle/bmi-rust/actions/workflows/publish.yml)
[![AI Declaration Format](https://img.shields.io/badge/AI_Declaration_Format-validated-blue)](./aidecl.yaml)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.24137036.svg)](https://doi.org/10.5281/zenodo.24137036)

The Rust specification for the CSDMS
[Basic Model Interface](https://bmi.csdms.io/en/stable/).

## Installation

Add [`bmi-rust`](https://crates.io/crates/bmi-rust) to your dependencies:

```toml
[dependencies]
bmi-rust = "0.1"
```

See the [API documentation](https://docs.rs/bmi-rust) for the complete interface.

See [bmi-example-rust](https://github.com/eWaterCycle/bmi-example-rust) for an example implementation of a BMI model in Rust.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for development and release instructions.

## References

- [BMI specification](https://bmi.csdms.io/en/stable/bmi.spec.html)
- [bmi-driver 0.2.0 trait](https://crates.io/crates/bmi-driver/0.2.0/code/src/types/traits.rs)
- [bmi-rs 0.0.1-alpha.0 interface](https://crates.io/crates/bmi-rs/0.0.1-alpha.0/code/src/bmi.rs)

## License

Apache-2.0. See the `LICENSE` file.