Skip to content

ruflab/shimmer

Repository files navigation

Shimmer

GLoW, but very light

This repository is the barebones API to build a global workspace.

Install

See Installation instructions.

Example

You can find a code example in the examples folder.

Tutorials

For an in-depth tutorial on the logic and basics of shimmer, see here.

For a hands-on tutorial on real data (with Jupyter notebooks), see here.

You can also find some additional information in the Q&A.

API Documentation

The full API documentation is available here: https://ruflab.github.io/shimmer/.

Contributing

See CONTRIBUTING.md.