OpenMVIS — project site and benchmark

Source of openmvis.com: the documentation of MVIS, the multi-visual-inertial sensor calibration toolbox, the OpenMVIS datasets, the device wiki and the public calibration results.

The site is built with Astro and the Starlight docs theme. GitHub Pages serves the committed build in docs/.

Vision. OpenMVIS aims to become the public benchmark for camera and visual-inertial sensor calibration, the role KITTI plays for driving. See doc/PLAN.md for the roadmap and doc/DESIGN.md for the architecture.

---

Repository layout

mvis_pages/
├── site/                    # Astro source: edit here
│   ├── astro.config.mjs     # sidebar, redirects, build settings
│   ├── public/              # copied into the build as is: CNAME, .nojekyll, media, downloads, redirect stubs
│   ├── scripts/             # thin CLIs over python/mvis_site, post-build.mjs, check_moves.py
│   └── src/
│       ├── content/docs/    # prose pages (MDX), one per URL
│       ├── components/      # Astro components
│       └── data/            # generated JSON (sensor pages, results tables, redirects)
├── python/                  # mvis_site: the lib that generates sensor pages and results tables
├── docs/                    # the build GitHub Pages serves, written by npm run build (do not edit)
├── doc/                     # PLAN.md (roadmap) and DESIGN.md (architecture)
├── .github/workflows/       # CI: npm test, npm run build, pytest
├── LICENSE                  # GPL-3.0-only, the code
├── LICENSE-CONTENT          # CC BY 4.0, the text and figures
└── NOTICE                   # which licence covers what, and the exceptions

---

Quick start (developing the site)

Prerequisites: Node 22 (via nvm recommended).

nvm use 22                  # or `nvm install 22` first
cd site/
npm ci
npm run dev                 # http://localhost:4321

Build the static site:

npm test                    # the post-build rename and redirect steps (node --test)
npm run build               # astro build into ../docs, then post-build.mjs renames _astro/ and writes moved-page redirects
PYTHONNOUSERSITE=1 python3 scripts/check_moves.py   # after every build: old addresses redirect, no broken internal links
npm run preview             # serve the built site locally

---

Deploying

There is no separate deploy step. npm run build writes docs/, GitHub Pages serves main:/docs, so a pushed build on main is live within minutes. Commit the source and the build together.

Astro empties docs/ on every build; anything that must survive a build lives in site/public/ (the CNAME, .nojekyll, the media and download folders, and the redirect stubs that keep the old page addresses working).

CI (.github/workflows/ci.yml) runs npm test, npm run build and the Python tests on every push to main and every pull request; it does not commit a build.

---

Generated data and the Python lib

Sensor pages, the results tables and the UZH-FPV table are generated by the Python lib in python/mvis_site (see python/README.md). The scripts in site/scripts/ only call it. The run folders, the private sensor config and the results snapshots stay outside this repository and are passed by path:

PYTHONNOUSERSITE=1 python3 site/scripts/export_sensors.py --private-config <sensors.yaml> --media <clips dir>
PYTHONNOUSERSITE=1 python3 site/scripts/export_examples.py --private-config <sensors.yaml>
PYTHONNOUSERSITE=1 python3 site/scripts/export_uzh.py --leaderboard <leaderboard dir> --uzh-root <uzh study dir>
PYTHONNOUSERSITE=1 python3 site/scripts/export_board.py --leaderboard <leaderboard dir> --records <snapshot> --results-commit <its full sha>
PYTHONNOUSERSITE=1 python3 site/scripts/export_repeatability.py --records <snapshot> --stats <three_way_compare_stats.json of that batch> --batch <batch> --results-commit <its full sha> [--leaderboard <leaderboard dir>]
PYTHONNOUSERSITE=1 python3 site/scripts/export_results.py --leaderboard <leaderboard dir> --records <snapshot> --stats <its stats file> --batch <batch> --results-commit <its full sha> --uzh-root <uzh study dir>   # after the three above
cd python && PYTHONNOUSERSITE=1 python3 -m pytest -q     # unit tests; python/cov.sh for coverage

Use Python 3.12 with numpy < 2; the export scripts refuse numpy 2.

What each writes:

Script	Writes
export_sensors.py	site/src/data/sensors/*.json, sensor.css, site/src/scripts/sensor-page.js, site/src/data/sensor-nav.json, site/src/content/docs/devices/*.mdx, site/public/media/sensors/<slug>/
export_examples.py	site/src/data/examples/*.json, site/src/data/examples-nav.json, site/src/content/docs/benchmark/examples/*.mdx, site/public/media/examples/<slug>/ (reads the examples: run map of the private sensors.yaml; an example whose run has no views yet is written without player, map and result)
export_board.py	site/src/data/leaderboard/board.json, board.css
export_uzh.py	site/src/data/leaderboard/uzh_fpv.json
export_repeatability.py	site/src/data/leaderboard/repeatability.json (matched-recording repeatability per family and group; reads the private per-recording stats file, writes derived spreads only)
export_results.py	the Results pages: site/src/data/eval/index.json (Leaderboard rows), eval/<slug>.json + site/src/content/docs/benchmark/results/<slug>.mdx (one Dataset eval page per dataset), site/src/data/results-nav.json (sidebar, old-hash jumps); text from python/data/public_results.yaml, ◆ counted by the Space's code and checked against board.json, only min/max per row and tool from the private stats file

여기까지가 README 앞부분입니다. 나머지는 원문에서 읽을 수 있습니다. README 전문 보기 ↗