An open API service indexing awesome lists of open source software.

https://github.com/virtualbrainlab/urchin

Universal Renderer for Neuroscience
https://github.com/virtualbrainlab/urchin

Last synced: 5 months ago
JSON representation

Universal Renderer for Neuroscience

Awesome Lists containing this project

README

          

urchin
========================================

[![PyPI Version](https://img.shields.io/pypi/v/oursin.svg)](https://pypi.org/project/oursin/) [![Downloads](https://static.pepy.tech/badge/oursin)](https://pepy.tech/project/oursin)

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](https://virtualbrainlab.org/urchin/tutorial.html) available that introduce the functionality in Urchin.

### Documentation

For detailed instructions please see the [documentation](https://virtualbrainlab.org/urchin/installation_and_use.html).

## 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](https://zenodo.org/badge/460577328.svg)](https://zenodo.org/badge/latestdoi/460577328)

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!