Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README update #7

Merged
merged 1 commit into from
Jun 30, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 120 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,33 @@
# Brayns
![Brayns](doc/images/Brayns.png)

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 data libraries can be used for the relevant hardware.
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](doc/Changelog.md).

Contact: bbp-open-source@googlegroups.com

## Known Bugs
## Architecture

Please file a [Bug Report](https://github.com/BlueBrain/Brayns/issues) if you
find new issues which have not already been reported in
[Bug Report](https://github.com/BlueBrain/Brayns/issues) page. If you find an
already reported problem, please update the corresponding issue with your inputs
and outputs.
![Architecture](doc/images/Architecture.png)

## About

Expand All @@ -26,3 +37,105 @@ The following platforms and build environments are tested:

The [API documentation](http://bluebrain.github.io/Brayns-0.1/index.html)
can be found on [bluebrain.github.io](http://bluebrain.github.io/).

## Building from Source

### Prerequisites

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

```
- src
+- ispc-v1.9.0-linux
+- OSPRay
+- BRayns
```

#### Intel ISPC compiler

Download and extract [ISPC compiler 1.9.0 archive](https://ispc.github.io/downloads.html).

#### OSPRay

Clone OSPRay in the same folder level as ISPC compiler

```
git clone https://github.com/BlueBrain/OSPRay.git
mkdir OSPRay/Build
cd OSPRay/Build
cmake .. -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
make install
```

### Brayns

```
git clone https://github.com/BlueBrain/Brayns.git
mkdir Brayns/Build
cd Brayns/Build
cmake .. -DOSPRAY_ROOT=<Brayns_installation_folder> -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](https://github.com/assimp/assimp) supported mesh file loader (.obj, .ply, etc.)
```
cmake .. -DBRAYNS_ASSIMP_ENABLED=ON:OFF
```

#### Enable/Disable [Brion](https://github.com/BlueBrain/Brion) supported
morphology file loader (.h5, .swc, BlueConfig, CircuitConfig)
```
cmake .. -DBRAYNS_BRION_ENABLED=ON:OFF
```

#### Enable/Disable [Deflect](https://github.com/BlueBrain/Deflect) for
streaming to [Tide](https://github.com/BlueBrain/Tide), the Tiled Interactive
DisplayWall environment.
```
cmake .. -DBRAYNS_DEFLECT_ENABLED=ON:OFF
```

#### Enable/Disable [ImageMagick](http://www.imagemagick.org) image loading
```
cmake .. -DBRAYNS_IMAGEMAGICK_ENABLED=ON:OFF
```

#### Enable/Disable HTTP/REST interface.
[Servus](https://github.com/HBPVIS/Servus),
[ZeroBuf](https://github.com/HBPVIS/ZeroBuf),
[Lexis](https://github.com/HBPVIS/Lexis),
[LibJpegTurbo](http://libjpeg-turbo.virtualgl.org) and
[ZeroEQ](https://github.com/HBPVIS/ZeroEQ).
See documentation for REST API details.
```
cmake .. -DBRAYNS_REST_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](https://github.com/BlueBrain/Brayns/issues) if you
find new issues which have not already been reported in
[Bug Report](https://github.com/BlueBrain/Brayns/issues) page. If you find an
already reported problem, please update the corresponding issue with your inputs
and outputs.

Binary file added doc/images/Architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/Brayns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.