Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ cpp/bindings/pipelines-src
.dolt/
*.db
.beads-credential-key
.kiro
51 changes: 51 additions & 0 deletions CONTINUITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Snapshot
- 2026-08-26 [USER] Recreate `logo.png` as a reproducible TikZ logo, generating PDF and SVG; exact raster aspect ratio is not required.
- 2026-08-26 [USER] Remove all visible H1 headings from the docs landing page.

# Done (recent)
- 2026-08-26 [CODE] Superseded the unavailable Material helper class with native `<h1 hidden>`, removing the visible `evalio` heading.
- 2026-08-26 [CODE] Suppressed Material's injected “About” heading with an accessible, visually hidden landing-page H1.
- 2026-08-26 [CODE] Moved the README tagline into the centered logo block while preserving its emphasized acronym.
- 2026-08-26 [CODE] Centered both docs logo image display modes and the immediately adjacent tagline paragraph.
- 2026-08-26 [CODE] Centered the README logo with GitHub-compatible alignment and the docs logo with `margin-inline: auto`.
- 2026-08-26 [CODE] Added adaptive logos to `README.md` via `<picture>` and to the docs landing page via Material palette-aware CSS.
- 2026-08-26 [CODE] Replaced the same-color IMU `\shade` with `\fill[ink]`, preventing dvisvgm from dropping the center rectangle.
- 2026-08-26 [CODE] Added a `\darklogo` compile flag; `just logo` now builds dark-ink `logo.*` and light-ink `logo-dark.*` assets.
- 2026-08-26 [CODE] Added `just logo`, generating `docs/assets/logo.pdf` and `docs/assets/logo.svg` and removing LaTeX auxiliary files.
- 2026-08-26 [CODE] Replaced white marker/body strokes with true geometric gaps: calculated ring arcs, clipped IMU pins, and an inset chip body.
- 2026-08-26 [CODE] Added a 1pt white outline to the central IMU body and regenerated both vector outputs.
- 2026-08-26 [CODE] Superseded the segmented-ring experiment: restored the ring and IMU pins, with white outlines on orange returns.
- 2026-08-26 [CODE] Replaced shaded lidar returns with flat orange discs and redrew the IMU using slimmer pins and explicit axis geometry.
- 2026-08-26 [CODE] Added `logo.tex`, a tightly cropped standalone TikZ recreation of the lidar ring, returns, IMU glyph, and wordmark.
- 2026-08-26 [TOOL] LuaLaTeX generated `logo.pdf`; dvisvgm generated portable `logo.svg` with an embedded WOFF2 wordmark font; rendered preview verified.
- 2026-08-25 [CODE] Migrated docs to Zensical: dev deps swapped for `zensical` + mike fork; `mkdocs-gen-files` replaced by `scripts/gen_docs.py`; CI builds via `zensical build`. Site verified locally (tables, KaTeX, admonitions, mkdocstrings, version selector).
- 2026-08-25 [CODE] Zensical quirk: pipe table needs a blank line before it; generator writes `intro\n\n` to satisfy it.
- 2026-08-25 [CODE] Generator lives outside `docs_dir` (`scripts/`) so Zensical doesn't publish it into `site/`.

# Working set
- `justfile`
- `README.md`
- `docs/index.md`
- `docs/css/tweaks.css`
- `docs/assets/logo.tex`
- `docs/assets/logo.pdf`
- `docs/assets/logo.svg`
- `docs/assets/logo-dark.pdf`
- `docs/assets/logo-dark.svg`

# Receipts
- 2026-08-26 [TOOL] `uv run mkdocs build --strict` passed; homepage contains `<h1 hidden>evalio</h1>` and no injected “About” H1.
- 2026-08-26 [TOOL] `uv run mkdocs build --strict` passed; built homepage has only `<h1 class="md-visually-hidden">evalio</h1>` and no “About” H1.
- 2026-08-26 [TOOL] `uv run mkdocs build --strict` passed; generated CSS includes image auto margins and centered adjacent-paragraph styling.
- 2026-08-26 [TOOL] `uv run mkdocs build --strict` passed after centering; generated `tweaks.css` contains the auto-margin rule.
- 2026-08-26 [TOOL] `uv run mkdocs build --strict` passed; built index references both SVGs, palette CSS is published, and both assets are present in `site/assets/`.
- 2026-08-26 [TOOL] Rebuilt both variants; SVGs now contain the rounded IMU body in `#181e24`/`#f5f7fa` and render correctly on light/dark backgrounds.
- 2026-08-26 [TOOL] Both PDF/SVG variants validated and rendered correctly on white and `#10151B` backgrounds; SVG ink colors are `#181e24` and `#f5f7fa`.
- 2026-08-26 [TOOL] `just logo` completed; both docs assets validate, SVG contains no white paint, and `docs/assets/` contains no auxiliary files.
- 2026-08-26 [TOOL] Rebuilt PDF/SVG, confirmed `logo.svg` contains no white paint, and previewed the transparent gaps on white and purple backgrounds.
- 2026-08-26 [TOOL] Previewed the outlined IMU body; LuaLaTeX and dvisvgm completed successfully.
- 2026-08-26 [TOOL] Rebuilt and previewed restored geometry with 2pt white outlines on orange lidar returns; PDF/SVG conversion succeeded.
- 2026-08-26 [TOOL] Rebuilt and previewed PDF/SVG with transparent marker spacing; no background-colored halo is baked into either asset.
- 2026-08-26 [TOOL] Rebuilt PDF/SVG after the glyph refinement; raster preview confirms clean flat markers and non-overlapping coordinate axes.
- 2026-08-26 [TOOL] `logo.pdf` is one 497.975x136.885 pt vector page; `logo.svg` converted successfully with dvisvgm 3.2.1.
- 2026-08-25 [TOOL] Zensical documentation confirms `mkdocs.yml`, KaTeX, mkdocstrings, and versioned docs compatibility; `mkdocs-gen-files` issue #8 is open.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
## evalio

evalio is a tool for **Eval**uating **L**idar-**I**nertial **O**dometry.
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/logo.svg">
<img alt="evalio" src="docs/assets/logo.svg">
</picture>
<br/>
<a href="https://github.com/contagon/evalio/releases"><img src="https://img.shields.io/github/v/release/contagon/evalio" /></a>
<a href="https://github.com/contagon/evalio/actions/workflows/on_main.yml"><img src="https://img.shields.io/github/actions/workflow/status/contagon/evalio/on_main.yml" /></a>
<a href="https://github.com/contagon/evalio/blob/master/LICENSE"><img src="https://img.shields.io/github/license/rpl-cmu/form" /></a>
<a href="https://arxiv.org/abs/2507.16000"><img src="https://img.shields.io/badge/arXiv-2507.16000-b31b1b.svg" /></a>
<p>evalio is a tool for <strong>Eval</strong>uating <strong>L</strong>idar-<strong>I</strong>nertial <strong>O</strong>dometry.</p>
<br/>
</div>

Specifically, it provides a common interface for connecting LIO datasets and LIO pipelines. This allows for easy addition of new datasets and pipelines, as well as a common location to evaluate them making benchmarks significantly easier to run. It features,
- No ROS dependency! (though it can still load rosbag datasets using the wonderful [rosbags](https://ternaris.gitlab.io/rosbags/) package)
- 8 compiled in LIO pipelines and 12 configured datasets.
- Easy to add new datasets and pipelines, see the [example](https://github.com/contagon/evalio-example)
- Unified representation of lidar scan, e.g. row (scan-line) major order, stamped at the start of the scan, point stamps are relative from the start of the scan.
- Download and manage datasets via the CLI interface
Expand Down
Binary file added docs/assets/logo-dark.pdf
Binary file not shown.
40 changes: 40 additions & 0 deletions docs/assets/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/logo.pdf
Binary file not shown.
Loading
Loading