Visualizer for large-scale and interactive ray-tracing of neurons
Clone or download
tribal-tec and hernando Transfer function per model
- new RPCs for get- and set-model-transfer-function
- simulation handler per model
- create volumes from model, not from scene
Latest commit 792bb2d Oct 18, 2018
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Aug 9, 2018
CMake Update CMake/common to allow external GIT_REVISION update for Nix bui… Aug 31, 2018
apps Replaced lookat, target, position by quaternion, position in the came… Oct 19, 2018
async++ @ 2c852e5 Correct CMake target exports for plugins (#384) May 14, 2018
brayns Transfer function per model Oct 19, 2018
doc Cleanup loaders (#586) Oct 15, 2018
engines/ospray Transfer function per model Oct 19, 2018
javascript Remove obsolete js/python code (#465) Jul 13, 2018
ospray_modules Remove dead volume code from Optix Oct 19, 2018
perceptualdiff @ 7ae45fb Use perceptual diff for more robust image comparison in tests Jun 5, 2018
plugins Transfer function per model Oct 19, 2018
python Transfer function per model Oct 19, 2018
tests Transfer function per model Oct 19, 2018
uvw @ 82944cf Event-driven architecture for braynsService, resolve #286 (#314) Mar 5, 2018
.clang-format Introduce renderer-specific properties Jul 12, 2018
.github_changelog_generator Release 0.7.1 Sep 26, 2018
.gitignore Add CMake logic for topology viewer use case plugin fix Mar 6, 2018
.gitmodules Integrate RapidJSON as a submodule Aug 13, 2018
.gitsubprojects Replaced lookat, target, position by quaternion, position in the came… Oct 19, 2018
.lsan_suppressions.txt adding nvidia libs to sanitizer suppression list (#582) Sep 28, 2018
.travis.yml Use rockets python client Oct 15, 2018
ACKNOWLEDGMENTS.txt Full websocket support; automatic broadcast of modified objects Jan 9, 2018
AUTHORS.txt Updated copyright and project name for Open Sourcing Jun 17, 2016
CMakeLists.txt Moving to OSPRay 1.7.x Oct 18, 2018
Changelog.md Release 0.7.1 Sep 26, 2018
DOCKER.md Use regular command line flags for applicable options Sep 18, 2018
Dockerfile Moving to OSPRay 1.7.x Oct 18, 2018
GCLOUD.md Add doc to illustrate how to run Brayns on GCP's infrastructure (#456) Jul 10, 2018
GPL.txt Updated copyright and project name for Open Sourcing Jun 17, 2016
LGPL.txt Updated copyright and project name for Open Sourcing Jun 17, 2016
LICENSE.txt Cleanups Feb 1, 2018
README.md Cleanup OpenDeck code further Sep 11, 2018

README.md

Brayns

C++ Build Status Docker Build Status Python Build Status Read the Docs Docker Pulls GitHub release

Brayns

One of the keys towards understanding how the brain works as a whole is visualisation of how the individual cells function. In particular, the more morphologically accurate the visualisation can be, the easier it is for experts in the biological field to validate cell structures; photo-realistic rendering is therefore important.

The Blue Brain Project has made major efforts to create morphologically accurate neurons to simulate sub-cellular and electrical activities, e.g. molecular simulations of neuron biochemistry or multi-scale simulations of neuronal function. Ray-tracing can help to highlight areas of the circuits where cells touch each other and where synapses are being created. In combination with ‘global illumination’, which uses light, shadow, and depth of field effects to simulate photo-realistic images, this technique makes it easier to visualise how the neurons function.

Brayns is a minimalistic visualiser that can perform ray-traced rendering of neurons. It provides an abstraction of the underlying rendering engines, so that the best possible acceleration libraries can be used for the relevant hardware. (https://github.com/BlueBrain/Brayns.git).

To keep track of the changes between releases check the changelog.

Contact: bbp-open-source@googlegroups.com

Architecture

Architecture

User guide

Command line arguments are documented in the User Guide.

About

The following platforms and build environments are tested:

  • Linux: Ubuntu 16.04, Debian 9, RHEL 6.8 (Makefile, x64)

The API documentation can be found on bluebrain.github.io.

Using Docker images

Start Brayns as a service

docker run -ti --rm -p 8200:8200 bluebrain/brayns

More documentation is available on DockerHub: https://hub.docker.com/r/bluebrain/brayns/

Start the Brayns web UI

docker run -ti --rm -p 8080:8080 bluebrain/brayns-ui

More documentation is available on DockerHub: https://hub.docker.com/r/bluebrain/brayns-ui/

Building from Source

Prerequisites

In order to ease the application compilation process, we recommend using the following tree structure:

- src
  +- ispc-v1.9.2-linux
  +- OSPRay
  +- Brayns

Intel ISPC compiler

Download and extract ISPC compiler 1.9.2 archive.

Embree

Clone embree in the same folder level as ISPC compiler

  git clone https://github.com/embree/embree.git
  mkdir embree/Build
  cd embree/Build
  git checkout v2.17.4
  cmake .. -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
  make install

OSPRay

Clone OSPRay in the same folder level as ISPC compiler

  git clone https://github.com/ospray/OSPRay.git
  mkdir OSPRay/Build
  cd OSPRay/Build
  git checkout v1.5.0
  export CMAKE_PREFIX_PATH=<Brayns_installation_folder>
  cmake .. -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
  make install

Brayns

  git clone --recursive https://github.com/BlueBrain/Brayns.git
  mkdir Brayns/Build
  cd Brayns/Build
  cmake .. -DCLONE_SUBPROJECTS=ON -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
  make install

A number of dependencies are optional, and are related to some specific Brayns features:

Enable/Disable assimp supported mesh file loader (.obj, .ply, etc.)

cmake .. -DBRAYNS_ASSIMP_ENABLED=ON:OFF

Enable/Disable Brion supported morphology file loader (.h5, .swc, BlueConfig, CircuitConfig)

cmake .. -DBRAYNS_BRION_ENABLED=ON:OFF

Enable/Disable Deflect for streaming to Tide, the Tiled Interactive DisplayWall environment.

cmake .. -DBRAYNS_DEFLECT_ENABLED=ON:OFF

Enable/Disable HTTP/REST/Websockets interface.

LibJpegTurbo and Rockets. See documentation for REST API details.

cmake .. -DBRAYNS_NETWORKING_ENABLED=ON:OFF

Enable/Disable VRPN tracking plugin.

cmake .. -DBRAYNS_VRPN_ENABLED=ON:OFF

Enable/Disable optional OSPRay modules.

cmake .. -DBRAYNS_OPTIX_ENABLED=ON:OFF
cmake .. -DBRAYNS_OPENDECK_ENABLED=ON:OFF
cmake .. -DBRAYNS_STEREOSCOPY_ENABLED=ON:OFF

Running Brayns viewer

export PATH=<Brayns_installation_folder>/bin:$PATH
export LD_LIBRARY_PATH=<Brayns_installation_folder>/lib:$LD_LIBRARY_PATH
braynsViewer

Running Brayns off-screen service

export PATH=<Brayns_installation_folder>/bin:$PATH
export LD_LIBRARY_PATH=<Brayns_installation_folder>/lib:$LD_LIBRARY_PATH
braynsService

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.