Repository for the ucl-open ecosystem: shared rig schemas (Python), Bonsai acquisition operators (.NET), and a Copier template used to scaffold new experiment repositories.
Full documentation, including tutorials and API reference, is published at https://ucl-open.github.io/ucl-open (deployed on release).
| Tool | Purpose |
|---|---|
| Git | Version control |
| .NET 8 SDK | Building the C# packages and the DocFX site |
Python 3.11+ with uv |
Python package, schema generation, tests |
| Bonsai | Optional, only needed to render workflow SVGs locally |
dotnet tool restore
dotnet docfx docs/docfx.json --serveDocFX will print a http://localhost:8080-style URL. Open it to preview the site.
To also render workflow images (requires Bonsai on Windows), run pwsh docs/build.ps1 instead.
uv sync
uv run pytest