From a814f869a5f8d54db38e53e9acb7fe932ac89a73 Mon Sep 17 00:00:00 2001 From: radhikatbbt Date: Sat, 4 Jul 2026 08:20:07 +0530 Subject: [PATCH 1/2] docs: add project architecture section to README Signed-off-by: Radhika Korade --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index ca96ed0..6394612 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,26 @@ Polars proved you can rewrite the data layer in Rust and win. mohu is that same - SIMD-accelerated math ops - Memory layouts NumPy can't express +## project architecture + +this repo is organized as a cargo workspace. here's a quick map of where things live: + +- **`crates/`** — the actual library code, split into individual crates (core arrays, dispatch, compute kernels, I/O, etc). this is where most contributions happen. +- **`tests/`** — integration tests that exercise the public API across crates, separate from the unit tests inside each crate. +- **`examples/`** — small standalone programs showing how to use mohu, meant to be read and run directly. +- **`docs/`** — longer-form documentation and design notes that don't fit in the README. +- **`benches/`** — performance benchmarks used to track regressions and validate the "parallel by default" and zero-copy goals. +- **`scripts/`** — developer tooling and automation scripts (setup, checks, etc) that aren't part of the library itself. + +mohu/ +├── crates/ # library code, one crate per component +├── tests/ # cross-crate integration tests +├── examples/ # runnable usage examples +├── docs/ # extended documentation +├── benches/ # performance benchmarks +└── scripts/ # dev tooling and automation + + ## status Early. The foundation is being laid. If you believe the Python numerical stack deserves a rewrite, watch this repo or contribute. @@ -36,3 +56,4 @@ Early. The foundation is being laid. If you believe the Python numerical stack d ## license MIT + From 6ad9d914a84c9337e71c27e91f0395ec1cbfb326 Mon Sep 17 00:00:00 2001 From: radhikatbbt Date: Sat, 4 Jul 2026 08:45:31 +0530 Subject: [PATCH 2/2] docs: add project architecture section to README Signed-off-by: Radhika Korade --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6394612..cd890c8 100644 --- a/README.md +++ b/README.md @@ -55,5 +55,5 @@ Early. The foundation is being laid. If you believe the Python numerical stack d ## license -MIT +MIT