Skip to content

VirtualBrainLab/Urchin

Repository files navigation

urchin

PyPI Version Downloads

Urchin is a Python API that links your analysis scripts to a standalone renderer program, to create graphics like the ones below.

Quickstart

To install the package run pip install oursin. To get started open a Python terminal and run:

import oursin as urchin
urchin.setup()

Tutorials

We have many tutorials available that introduce the functionality in Urchin.

Documentation

For detailed instructions please see the documentation.

Urchin for Unity

The Urchin package can be embedded into a Unity application by adding the package: https://github.com/VirtualBrainLab/Urchin.git?path=/UnityClient/Packages/vbl.urchin

Citing

DOI

If Urchin is used as part of a research project you should cite this repository. We've created a DOI for this purpose on Zenodo. Your citations will help us get grant support for this project in the future!