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
- Host: GitHub
- URL: https://github.com/virtualbrainlab/urchin
- Owner: VirtualBrainLab
- License: gpl-3.0
- Created: 2022-02-17T19:25:52.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-01-06T10:27:13.000Z (about 1 year ago)
- Last Synced: 2025-03-22T09:02:00.274Z (10 months ago)
- Language: C#
- Homepage:
- Size: 289 MB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
urchin
========================================
[](https://pypi.org/project/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
[](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!