Brion  1.8.0
The Blue Brain C++ I/O library
Brion Documentation

Table of Contents

Introduction

BBPLOGO350.jpg

Welcome to Brion, a C++ project for read and write access to Blue Brain data structures, including BlueConfig/CircuitConfig, Circuit, CompartmentReport, Mesh, Morphology, Synapse and Target files.

Brion can be retrieved by cloning the source code. The latest API documentation can be found on bluebrain.github.io.

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

Features

Brion provides two libraries Brion and Brain. The former is a collection of file readers and writers intended for low level access to the data model. The latter is a set of higher level classes that wrap low level data objects with a more user friendly API.

IO library

This is the core library provided by Brion. It includes classes for reading and writing files which store the Blue Brain data model.

High level library

The higher level library is called Brain and it provides:

  • brain::Circuit to facilitate loading information about cells and morphologies in local and global circuit coordinates.
  • brain::neuron::Morphology with higher level functions to deal with morphologies.

Building

Brion is a cross-platform library, designed to run on any modern operating system, including all Unix variants. Brion uses CMake to create a platform-specific build environment. The following platforms and build environments are tested:

  • Linux: Ubuntu 14.04 and RHEL 6 (Makefile, i386, x64)

Building from source is as simple as:

git clone https://github.com/BlueBrain/Brion.git
mkdir Brion/build
cd Brion/build
cmake ..
make