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.

Sign up for GitHub

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

Added user guide and updated readme #133

Merged
merged 1 commit into from
Mar 14, 2017
Merged

Added user guide and updated readme #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Brayns

![Brayns](doc/images/Brayns.png)

One of the keys towards understanding how the brain works as a whole is
Expand Down Expand Up @@ -29,6 +30,10 @@ Contact: bbp-open-source@googlegroups.com

![Architecture](doc/images/Architecture.png)

## User guide

Command line arguments are documented in the [User Guide](doc/UserGuide.md).

## About

The following platforms and build environments are tested:
Expand All @@ -47,35 +52,38 @@ following tree structure:

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

#### Intel ISPC compiler

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

#### Embree

Clone embree in the same folder level as ISPC compiler
Clone embree 2.14.0 in the same folder level as ISPC compiler

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

#### OSPRay

Clone OSPRay in the same folder level as ISPC compiler
Clone OSPRay 1.2.0 in the same folder level as ISPC compiler

```
git clone https://github.com/ospray/OSPRay.git
mkdir OSPRay/Build
cd OSPRay/Build
git checkout a6798ef
export embree_DIR=<Brayns_installation_folder>
cmake .. -DOSPRAY_USE_EXTERNAL_EMBREE=ON -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
make install
Expand All @@ -87,7 +95,7 @@ Clone OSPRay in the same folder level as ISPC compiler
git clone https://github.com/BlueBrain/Brayns.git
mkdir Brayns/Build
cd Brayns/Build
cmake .. -DOSPRAY_ROOT=<Brayns_installation_folder> -DEMBREE_ROOT=<Brayns_installation_folder> -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
CMAKE_PREFIX_PATH=<Brayns_installation_folder>/lib/cmake/embree-2.14.0:<Brayns_installation_folder>/lib/cmake/ospray-1.2.0 cmake .. -DCMAKE_INSTALL_PREFIX=<Brayns_installation_folder>
make install
```

Expand Down
Loading