API reference.

Numra's Rust API documentation is generated by rustdoc. Once the first version ships to crates.io, the canonical home is docs.rs/numra, with every published version available at docs.rs/numra/<version>/numra/.

Build the docs locally

From a clone of the repository:

git clone https://github.com/moussaoutlook/numra-rs
cd numra-rs
cargo doc --workspace --no-deps --open

That builds documentation for every workspace crate (numra, numra-core, numra-ode, numra-sde, numra-pde, …) and opens it in your browser. Use cargo doc -p numra --open to browse only the umbrella crate.

The umbrella facade

For most use cases the numra crate is the only dependency you need. It re-exports every domain module — numra::ode, numra::sde, numra::pde, numra::optim, numra::linalg, and so on — under one shared set of traits (Scalar, Vector, Signal) so you can chain solvers without writing glue.

Per-crate sources

Every numra-* workspace member is browsable on GitHub. The public API method inventory lists every exported function across the workspace.