Loci connects points on 3D models to video evidence, timed transcripts, citations and shareable moments. Explore an object, select an annotation, and watch the interpretation linked to that place.
Explore the Loci research collection, or watch this 50-second walkthrough with audio:
clipboard.mp4
Walkthrough guide · Download the MP4
Recording and editing: Unlock Digital. The hosted collection has separate content permissions. Permission to show participants in this walkthrough grants no reuse license for its video, previews or depicted research content. See media permissions and credits.
The included demo uses a generated cube, video and transcript. This silent 41-second walkthrough shows how to place a model pin, preview its video range privately, publish the annotation and check it in the reader.
loci-demo-authoring.mp4
Authoring guide · Timed text description · Download the MP4
Demo improvements and video: 3D Humanities Lab. These generated assets are Apache 2.0; see provenance and license.
Requires Docker Engine with Compose v2 or Docker Desktop, Python 3, internet access, and free ports 8000 and 8080. Containers run Linux. Clone the source, or extract a release archive and enter its root folder:
git clone https://github.com/3dhlab/loci.git
cd loci
python3 scripts/demo/init-env.py
docker compose build
docker compose up -d postgres redis
docker compose run --rm api alembic upgrade head
docker compose run --rm api python -m app.scripts.seed_demo
docker compose up -d --wait
python3 scripts/demo/verify.pyFor an extracted archive, skip the first two commands. If Compose v2 is installed as docker-compose, use that command instead.
Open localhost:8080/public, select Demo cube, then an annotation. Transcript lines seek the video; citations and share links return to the selected evidence. The authoring guide enables the optional visual console. API forms are at localhost:8000/docs.
The demo account is demo@example.org; find its generated DEMO_PASSWORD in your private .env. Keep that file with the database volume. The website and API bind to localhost, and setup preserves existing credentials.
docker compose down stops the demo and preserves data. Adding --volumes deletes that Compose project's database and media.
- Documentation index: setup, authoring, architecture and operations.
- Use your own content or upgrade the demo.
- Development checks and contributing.
- Support, security reporting and release notes.
The quickstart covers a local demo with one authoring account. Remote publication and other integrations need separate setup. The durable-publication guide describes compatible source, worker and destination versions, configuration and validation limits. Turnkey institutional private-to-public deployment is a next-release goal.
Maintained by Craig Stevens. Report ordinary bugs through GitHub Issues and cite the software using CITATION.cff. Contributions follow the code of conduct.
First-party software, documentation and generated samples are Apache 2.0. Third-party dependencies and research media have separate terms. See license scope and media exceptions, dependency notices and NOTICE.