mirror of
https://github.com/ruvnet/RuView
synced 2026-07-17 16:33:18 +00:00
ruv
2dddd458e7
Rewrites README from minimal stub to a real crate-front-page. Audience: sensor researcher / DSP engineer / ML auditor / educator picking nvsim out of a list of magnetometer simulators and asking "should I use this?" Structure (per request): - one-paragraph intro that explains what NV-diamond magnetometers are, why simulating them matters, and what nvsim is *not* (no hardware control, no fT claims, no Hamiltonian solver) - four-row "if you are a..." why-might-you-use-it table - capabilities table for what's shipping today (Passes 1-4) and a "not yet shipped" section for Passes 5-6 - comparison table vs Magpylib, QuTiP-NV-scripts, vendor closed sims - three-point value proposition (forward end-to-end pipeline, strong determinism, honest physics) - usage guide: install, scene-field-at, NvSensor::sample, attenuate, MagFrame round-trip - acceptance commitments (the four plan §5 numbers) - six primary-source citations (Jackson, Doherty, Barry, Wolf, Cullity, Ortner & Bandeira) - limitations / out-of-scope Honest framing throughout — keeps the user-corrected wording "deterministic Rust simulator with explicit physics approximations and no hidden mocks", marks digitiser/pipeline/proof as 🚧 Pass 5/6 in the comparison table, and explicitly flags the conjectural defaults in propagation that the implementation already documents in code. License unchanged (MIT OR Apache-2.0, workspace default). Co-Authored-By: claude-flow <ruv@ruv.net>