VEHICLELAB

VEHICLE LAB / DOCUMENTATION

Your first project

Use Python 3.11 or later and a recent browser with WebGL. Running the website and project CLI requires only the Python standard library. Node.js and FFmpeg are optional tools for browser checks and film capture.

1. Run the included example

Extract the source archive, then run this from the extracted directory:

python3 tools/serve.py

Open localhost:8767 in your browser. Choose Explore for the vehicle notebook. The first load verifies four detailed geometry assets; give it time to finish. The film is a lighter alternative on devices with limited graphics memory.

2. Create your notebook

In a second terminal, from the same source directory:

python3 tools/project.py init projects/my-rover --name "My rover"
python3 tools/project.py validate projects/my-rover/project.json

The command creates an original illustrative rover fixture, packed geometry and project.json. It refuses to overwrite a nonempty directory. Open localhost:8767/studio.html?project=projects/my-rover/project.json.

3. Make the study yours

Edit the project name, description and stage questions in project.json. Use the geometry guide to add your own OBJ export, then attach a run with the simulation guide. Every file path is relative to the source directory. Keep each project's files under its own directory.

For a complete small example, open the linear-stage notebook. Inspect its grouped assembly, failed fit, revised clearance and prescribed travel. Choose Project record to follow the revision graph and read or download the original evidence.

4. Verify before sharing

python3 tools/project.py validate projects/my-rover/project.json
python3 tools/check_release.py

The validator checks asset existence and hashes, mesh ranges, finite coordinates, revision cycles and explicit claim boundaries. The release check audits the files explicitly listed in release-files.json. New notebooks are excluded from the bundled software archive; keep your project assets together and review their contents and rights before distributing them. Keep original source files and export settings alongside your own project when licensing permits.

Optional developer tools

python3 -m venv .venv
. .venv/bin/activate
python3 -m pip install -r requirements-analysis.txt
npm ci
npx playwright install chromium
npm test
npm run test:browser

The compact geometry study uses the standard library. Matrix geometry and the four-link study need NumPy and SciPy; install requirements-analysis.txt into an isolated virtual environment.

Troubleshooting