Virtual lab protocol simulation

Browser-based virtual lab protocol games for biology students. Authors compose scenes, objects, and workflows in YAML; the pipeline compiles them to interactive TypeScript simulations with SVG-backed objects laid out by a scene engine.

Quick start

bash run_web_server.sh

Builds the project and serves dist/ on a random port, then opens the protocol selector in your browser.

Other useful commands:

bash build_github_pages.sh   # build dist/ for deployment
bash check_codebase.sh       # typecheck, lint, and format check
source source_me.sh && pytest tests/   # run unit tests

Documentation

Core docs:

• docs/INSTALL.md: prerequisites and setup steps
• docs/USAGE.md: how to build, run, and author content
• docs/CODE_ARCHITECTURE.md: system design and data flow
• docs/FILE_STRUCTURE.md: directory map and file purposes
• docs/specs/PROTOCOL_AUTHORING_GUIDE.md: worked example for authoring a new protocol

Reference docs:

• AGENTS.md: agent instructions and repo guardrails
• docs/PRIMARY_CONTRACT.md: hard design invariants
• docs/CHANGELOG.md: record of changes
• docs/ROADMAP.md: planned work and priorities

License

• Code: LICENSE.LGPL_v3
• Non-code content: LICENSE.CC_BY_4_0

Maintained by Neil Voss, https://bsky.app/profile/neilvosslab.bsky.social