nmr 0.1.3

NMR data tools for Rust
Documentation

nmr

Rust library for reading supported NMR acquisitions and processed spectra, processing them with explicit operations, and exporting plot data as NPZ. It provides a common data model for supported Bruker, JEOL Delta, Varian and JCAMP-DX layouts, including lazy raw trace and region access.

Try it

Requires Rust 1.85 or newer and a working native Rust build toolchain. From a source checkout:

cargo run --locked --example read_spectrum -- tests/fixtures/jcamp_dx/ppm.dx target/first-spectrum.npz

This reads the bundled synthetic four-point spectrum, prints samples [2.0, 4.0, 6.0, 8.0], and exports it without processing. Use a new output filename on each run: export refuses to overwrite files. The quickstart explains installation in your own Rust application, expected results and next steps.

Scope

Dense processing supports rank 1 and 2; it does not run during reading. All JEOL imports and Bruker NUS require an explicit experimental-semantics opt-in. Automatic phase, baseline and NUS methods have limited scientific validation domains. Read the format matrix and scientific contract before relying on a particular layout or inference method.

Install from crates.io with nmr = "0.1" in your Cargo dependencies. The project is in early development. APIs and development snapshots may change; preserve the matching source revision when retaining snapshots.

  • User guide: reading, processing, limits and application integration.
  • Processing examples: 1D, dense 2D and NUS workflows.
  • API for this checkout: cargo doc --no-deps --open.
  • Contributing: development setup, architecture, tests and documentation.

License

Licensed under either Apache-2.0 or MIT, at your option.