quantumclaw/clawhdf5
3
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
5eae9ee60b3df618cfc48f6e34654b7a16748631
clawhdf5/docs/README.md
T
osobhandClaude Opus 5.5 c27a478e44 docs: fact-check the refreshed documentation against its sources 
Numbers, API names, feature defaults and PR references checked against
CONFORMANCE.md, BENCHMARKS.md, CHANGELOG.md, the code and git history.

- int8 index figures (1.74x memory, 1.63x QPS) carry the dates git gives
  them (2026-09-19/20, machine not recorded, not re-run) instead of none;
  the Pi 5 1.18x carries 2026-09-21.
- BENCHMARKS headline: the libhdf5 chunked-write figure is the newest
  measurement (35x, 2026-09-23), not 45.3x (2026-08-03).
- Conformance counts follow the 2026-09-28 run (1 our-error, 2 ref-bug)
  in conformance/README.md, ROADMAP.md and CLAUDE.md, with a pointer to
  the bad_nbit_parms_walk.h5 flip.
- README: LZ4 is opt-in; the browser refuses reference/opaque/bitfield/
  time datasets too; zlib-rs byte-identity scoped to what was measured;
  macOS default links the system libz for inflate.
- Crate READMEs: system-zlib-decompress does something (macOS), SweepDetector
  lives in prefetch, checkpoint after more than 500 WAL entries, NetCDF-4
  unlimited-dimension size warning.
- agent-memory.md: string-dataset compression threshold, agents-md prints
  Markdown, float16 file sizes linked to their study.
- known-issues.md: contiguous selection reads, 1.21x vs h5py threads.
- docs/README.md, USE_CASES.md, ROADMAP.md, CLAUDE.md: range-read
  milestones M0-M5 and PRs #17-#19, missing README rows, CLI keygen/verify,
  dated figures, fast-math is not BLAS.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-09-28 11:23:51 -05:00

70 lines
4.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# clawhdf5 documentation
Every document in the repository, one line each. Start with the
[README](../README.md) and the [quick start](QUICKSTART.md).
## Using clawhdf5
| Document | What it covers |
|---|---|
| [README](../README.md) | What clawhdf5 is, the evidence, the feature matrix, install, quick starts, crate map |
| [QUICKSTART.md](QUICKSTART.md) | Working examples: HDF5 in Rust and Python, remote files, SWMR, NetCDF-4, `h5rs`, agent memory, CLI |
| [USE_CASES.md](USE_CASES.md) | Where clawhdf5 fits, and when to use something else |
| [agent-memory.md](agent-memory.md) | The agent-memory store: search, durability, signing, modules, performance, schema, CLI, SQLite migration |
| [known-issues.md](known-issues.md) | Open limits and fixed bugs, dated — read before relying on an edge case |
| [openclaw.md](openclaw.md) | Why clawhdf5 is not an OpenClaw memory plugin, and what one would need |
| [CHANGELOG.md](../CHANGELOG.md) | Every change by release, with upgrade notes; "Unreleased" is everything since v2.7.0 |
## Evidence
| Document | What it covers |
|---|---|
| [CONFORMANCE.md](../CONFORMANCE.md) | Generated report: 697 public HDF5 files read by clawhdf5 and h5py and compared; the CVE corpus against h5dump and h5py |
| [conformance/README.md](../conformance/README.md) | How the conformance sweep works and how to run it |
| [BENCHMARKS.md](../BENCHMARKS.md) | Every measurement with date, machine and command: HDF5 reads and writes, concurrency, deflate backends, search, LongMemEval, footprint |
| [benchmarks/longmemeval/README.md](../benchmarks/longmemeval/README.md) | Downloading the LongMemEval data |
| [benchmarks/2026-03-01-oracle-xeon.md](../benchmarks/2026-03-01-oracle-xeon.md) | An early (March 2026) benchmark run on a Xeon server; superseded by BENCHMARKS.md |
## Design
| Document | What it covers |
|---|---|
| [design/range-reads.md](design/range-reads.md) | Reading through a `Storage` trait: milestones M0–M5 (indexed lookups, storage, raw data, remote files, the browser, SWMR) |
| [design/swmr.md](design/swmr.md) | Reading files a libhdf5 SWMR writer is appending to (M5) |
| [design/tools/](design/tools/) | Scripts behind the range-read design's measurements (`inventory.py`, `libhdf5_reads.py`, `range-trace`) |
## Crates and packages
| Document | What it covers |
|---|---|
| [crates/clawhdf5](../crates/clawhdf5/README.md) | The facade: `File`, `FileBuilder`, `FileEditor` |
| [crates/clawhdf5-format](../crates/clawhdf5-format/README.md) | The format implementation and codecs; [fuzzing](../crates/clawhdf5-format/fuzz/README.md) |
| [crates/clawhdf5-filters](../crates/clawhdf5-filters/README.md) | Deflate backends |
| [crates/clawhdf5-io](../crates/clawhdf5-io/README.md) | I/O helpers (mmap, async, HSDS, MPI) |
| [crates/clawhdf5-remote](../crates/clawhdf5-remote/README.md) | Remote files: HTTP(S), object stores, block cache |
| [crates/clawhdf5-netcdf4](../crates/clawhdf5-netcdf4/README.md) | NetCDF-4 layer |
| [crates/clawhdf5-derive](../crates/clawhdf5-derive/README.md) | Derive macros |
| [crates/clawhdf5-tools](../crates/clawhdf5-tools/README.md) | `h5rs` |
| [crates/clawhdf5-py](../crates/clawhdf5-py/README.md) | Python bindings |
| [crates/clawhdf5-wasm](../crates/clawhdf5-wasm/README.md) | The browser reader crate |
| [examples/wasm-viewer](../examples/wasm-viewer/README.md) | Browser viewer and the `clawhdf5-wasm` JavaScript API |
| [crates/clawhdf5-napi](../crates/clawhdf5-napi/README.md), [packages/clawhdf5-node](../packages/clawhdf5-node/README.md) | Node.js bindings and package (unpublished, does not work) |
| [crates/clawhdf5-android](../crates/clawhdf5-android/README.md) | Android JNI bindings for the agent store |
| [crates/clawhdf5-agent](../crates/clawhdf5-agent/README.md) | Agent memory (full guide: [agent-memory.md](agent-memory.md)) |
| [crates/clawhdf5-ann](../crates/clawhdf5-ann/README.md) | HNSW index |
| [crates/clawhdf5-accel](../crates/clawhdf5-accel/README.md) | SIMD kernels |
| [crates/clawhdf5-gpu](../crates/clawhdf5-gpu/README.md) | GPU vector distances |
| [crates/clawhdf5-migrate](../crates/clawhdf5-migrate/README.md) | SQLite migration |
| [crates/clawhdf5-cli](../crates/clawhdf5-cli/README.md) | The agent-memory CLI |
| [crates/clawhdf5-bench](../crates/clawhdf5-bench/README.md) | Benchmarks and harnesses |
## Project history and working notes
| Document | What it covers |
|---|---|
| [ROADMAP.md](../ROADMAP.md) | What has shipped (releases and PRs since v2.7.0) and what is next |
| [CLAUDE.md](../CLAUDE.md) | Architecture and workflow notes for contributors and coding agents |
| [archive/IMPROVEMENT_LOG.md](archive/IMPROVEMENT_LOG.md), [archive/IMPROVEMENT_SCAN.md](archive/IMPROVEMENT_SCAN.md) | Logs of earlier automated improvement passes (archived, historical) |
| [archive/plans/](archive/plans/) | Implementation plans from June 2026 (filter codecs, format write extensions, MPI-IO); archived, historical |
| [research/](../research/) | Research briefs from August 2026 (performance, security, provenance) |
Reference in New Issue View Git Blame Copy Permalink