Skip to content

docs: add project architecture section to README #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
radhikatbbt wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add project architecture section to README #289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a814f86
docs: add project architecture section to README
radhikatbbt Jul 4, 2026
6ad9d91
docs: add project architecture section to README
radhikatbbt Jul 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -35,4 +55,5 @@ Early. The foundation is being laid. If you believe the Python numerical stack d

## license

MIT
MIT

Loading