Skip to content

rodentVR is a Python 3-based virtual reality system tailored specifically to neuroscience research.

License

Notifications You must be signed in to change notification settings

simonarvin/rodentVR

Repository files navigation

rodentVR License: GPL v3 contributions welcome version lab beta

rodentVR is a Python 3-based virtual reality system tailored specifically to neuroscience research. This software is actively maintained: Users are encouraged to contribute to its development.

Features

  • Flexible, modular, readable
  • Open-source, all Python 3
  • Works on Windows and Linux.
  • Actively maintained

Overview

How it works

rodentVR uses the Ursina game engine to allow researchers to design 3D experiments more easily and flexibily:

Experiments are generated using pixel-maps.

  • Users can easily design and modify 3d environments by drawing pixels on a canvas, e.g., in Microsoft Paint.
  • Pixels are color-coded (0-255, 0-255, 0-255), to produce distinct 3d objects, e.g., walls, gratings, events.

Gratings are customizable by spatial frequency and angle.

Events can run any custom user-code. Default Event types are available, e.g., Stop Events.

  • Layers of pixels can be stacked to produce multi-level 3d environments, e.g., containing tall landmarks.

Getting started

Installation

Install rodentVR by cloning the repository:

git clone https://github.com/simonarvin/rodentVR.git

Dependencies: python -m pip install -r requirements.txt

Using pip: pip install .

You may want to use a Conda or Python virtual environment when installing rodentVR, to avoid mixing up with your system dependencies.

Using pip and a virtual environment:

python -m venv venv

source venv/bin/activate

(venv) pip install .

Your first experiment

Placeholder

Known issues

None yet.

License

This project is licensed under the GNU General Public License v3.0. Note that the software is provided "as is", without warranty of any kind, express or implied.

Authors

Lead Developer:

Simon Arvin, sarv@dandrite.au.dk

Researchers:

Corresponding Author: Simon Arvin, sarv@dandrite.au.dk


         

    

About

rodentVR is a Python 3-based virtual reality system tailored specifically to neuroscience research.

Topics

Resources

License

Stars

Watchers

Forks

Languages