BlueBrain I/O Library
Project description
Brion
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] (http://bluebrain.github.io/Brion-1.9/index.html) can be found on bluebrain.github.io. Additional documentation exists for the [Python wrapping of Brain] (python/index.html).
To keep track of the changes between releases check the [changelog](@ref 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 use-case oriented 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.
- Fast and low-overhead read access to:
- Blue configs (brion::BlueConfig)
- Circuit description (brion::Circuit)
- H5 Synapses data (brion::SynapseSummary, brion::Synapse)
- Target (brion::Target)
- BBP binary meshes (brion::Mesh)
- BBP H5 morphologies and SWC morphologies (brion::Morphology)
- Compartment reports (brion::CompartmentReport)
- Spike reports (brion::SpikeReport)
- Fast and low-overhead write access to:
- Compartment reports (brion::CompartmentReport)
- BBP binary meshes (brion::Mesh)
- BBP H5 morphologies (brion::Morphology)
- Spike reports (brion::SpikeReport)
- Basic [data types](@ref brion/types.h) to work with the loaded data using Boost, GLM.
High level library
The higher level library is called Brain and it provides:
- brain::Circuit to facilitate loading information about cells, morphologies (in local and global circuit coordinates) and synapses.
- brain::neuron::Morphology with higher level functions to deal with morphologies.
- brain::Synapses and brain::Synapse for array and object access to synapses.
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 16.04, RHEL 6.8 (Makefile, Ninja)
Building from source is as simple as:
git clone --recursive https://github.com/BlueBrain/Brion.git
mkdir Brion/build
cd Brion/build
cmake -GNinja -DCLONE_SUBPROJECTS=ON ..
ninja
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for brion-3.3.1.dev0-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cddcd0576db8c2aaeca39a344cfaabef32d6e5d20b46cbd94cf61162b31f3a96 |
|
MD5 | cf1f1e2a0f5efadda603e590fd642fb2 |
|
BLAKE2b-256 | d7288bf3459399cca8bc05c9d2c1b80eb11b2144519178e499ae886b6a201392 |
Hashes for brion-3.3.1.dev0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 921864cdf1cb11223efb5cda73761d1bf7219002a9577ca376a4ad7d8a7af17d |
|
MD5 | d1c25a704489da16d169c46dca21b8d7 |
|
BLAKE2b-256 | 8604d3c0f5ddccb8b6945fe27eb55268d2b220bb963ca2f4890ae1a05a190856 |
Hashes for brion-3.3.1.dev0-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5331ff43d43b565bada7f26fa715922f96830400450deb33c8646d290760a30b |
|
MD5 | 3b87a7a8b4b42ba98e8ebb976725bd07 |
|
BLAKE2b-256 | 1a031fd28dd391f66f3106959b467ee3731090fe2ae5e84642ad3fe6262f9c0e |