search

BlueBrain / RTNeuron

Interactive visualization framework for geometrically detailed neuron simulations
GNU General Public License v3.0
30 stars 10 forks source link
computational-neuroscience interactive neuroscience opengl rendering-engine sonata visualization

readme

RTNeuron

RTNeuron

Welcome to RTNeuron, the scalable real-time rendering tool for the visualization of neuronal simulations based on cable models.

The main utility of RTNeuron is twofold: the interactive visual inspection of structural and functional features of the cortical column model and the generation of high quality movies and images for presentation and publications. This guide will get you acquaintanced with all the features provided by RTNeuron and how to fully exploit them for both purposes.

RTNeuron provides a C++ library with an OpenGL-based rendering backend, a Python wrapping and an Python application called rtneuron. This documentation mostly covers the use of the command line application and the Python wrapping. To use RTNeuron as a C++ library, developers are referred to the C++ class reference.

RTNeuron is only supported in GNU/Linux systems. However, it should also be possible to build it in Windows systems. For OS/X it may be quite challenging and require changes in OpenGL related code to get it working.

Documentation

The full user documentation of RTNeuron can be found here. Some useful direct links are:

Known Bugs

Please file a Bug Report if you find new issues which have not already been reported in Bug Report page. If you find an already reported problem, please update the corresponding issue with your inputs and outputs.

Acknowledgment

RTNeuron has been jointly developed by the EPFL Blue Brain Project and the Universidad Politécnica de Madrid. Main financial support was provided by the Blue Brain Project (a research center of the École polytechnique fédérale de Lausanne, EPFL, from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology) and Cajal Blue Brain (funded by the Spanish Ministerio de Ciencia, Innovación y Universidades). Partial funding has been furthermore provided by the European Union’s Horizon 2020 research and innovation programme under grant agreement no.720270. (HBP SGA1).

License

RTNeuron is licensed under the GPLv3, unless noted otherwise, e.g., for external dependencies. See file GPL.txt for the full license.

Copyright (c) 2006-2022 Blue Brain Project/EPFL and Universidad Politécnica de Madrid (UPM)

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA