Installation
Install the Python library and optional rendering tools.
Use snnlab in a project
uv add git+https://github.com/eoinmurray/snnlabFor reproducible work, pin a Git tag or commit and commit your project's lockfile. The distribution declares Python 3.10 or newer; dependency availability can further constrain the interpreter and platform you use.
from snnlab import lang, sim, vizDevelop from this checkout
Run from the repository root:
uv sync --dev
uv run snnsim --helpUse an editable dependency in a sibling project:
uv add --editable ../snnlabOptional system tools
| Tool | Required for |
|---|---|
Graphviz (dot) | SVG and PNG diagram exports |
| FFmpeg | Video exports |
Install these with your operating system package manager. Core authoring and simulation do not require either executable. The quickstart writes a bundle without diagram rendering.
Documentation site
The separate Next.js app lives in docs/. Use Node.js 22 or newer:
cd docs
npm ci
npm run devOpen http://localhost:3000. See development for build and documentation commands.