Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bluebrain/brion

Blue Brain C++ File IO Library

https://github.com/bluebrain/brion

Science Score: 33.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    13 of 25 committers (52.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

synapse

Keywords from Contributors

neuron morphology glia mitochondria reticulum json-rpc json-schema rest-server websocket-client websocket-library
Last synced: 5 months ago · JSON representation

Repository

Blue Brain C++ File IO Library

Basic Info
  • Host: GitHub
  • Owner: BlueBrain
  • License: lgpl-3.0
  • Language: C++
  • Default Branch: master
  • Homepage:
  • Size: 2.05 MB
Statistics
  • Stars: 23
  • Watchers: 12
  • Forks: 24
  • Open Issues: 2
  • Releases: 24
Topics
synapse
Created almost 11 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

Brion

DOI

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. Additional documentation exists for the Python wrapping of Brain.

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 use-case oriented API.

A python package to access the library can also be built and installed with pip. The package is available in PyPi as well, under the name "brion". Please, note that the python package requires the user to have the python development package installed on their system.

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 to work with the loaded data using Boost, GLM.

Disclaimer

Although Brion is capable of reading SONATA format nodes, edges and reports, the use is experimental and not supported officially. To read the SONATA format, it is encouraged the usage of libsonata (https://github.com/BlueBrain/libsonata)

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 or above, 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 -DCMAKE_BUILD_TYPE=Release -DEXTLIB_FROM_SUBMODULES=ON ..
ninja

Funding & Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

This project has received funding from the European Union’s FP7-ICT programme under Grant Agreement No. 604102 (Human Brain Project RUP).

This project has received funding from the European Union's Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 720270 (Human Brain Project SGA1).

This project is based upon work supported by the King Abdullah University of Science and Technology (KAUST) Office of Sponsored Research (OSR) under Award No. OSR-2017-CRG6-3438.

License

Brion is licensed under the LGPL, unless noted otherwise, e.g., for external dependencies. See file LICENSE.txt for the full license.

Copyright (c) 2008-2023 Blue Brain Project/EPFL

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Owner

  • Name: The Blue Brain Project
  • Login: BlueBrain
  • Kind: organization
  • Email: bbp.opensource@epfl.ch
  • Location: Geneva, Switzerland

Open Source Software produced and used by the Blue Brain Project

GitHub Events

Total
  • Fork event: 2
Last Year
  • Fork event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 410
  • Total Committers: 25
  • Avg Commits per committer: 16.4
  • Development Distribution Score (DDS): 0.732
Top Committers
Name Email Commits
Juan Hernando Vieites j****o@e****h 110
Stefan Eilemann S****n@e****h 78
Daniel Nachbaur d****r@e****h 56
Nadir Román Guerrero N****e@u****m 56
Jonas Karlsson j****n@e****h 16
Juan Hernando j****o@f****s 15
Stefan Eilemann e****n@g****m 15
Mike Gevaert m****t@e****h 10
Jonas Karlsson j****n@f****g 8
Mohamed-Ghaïth Kaabi k****g@u****m 8
Daniel Nachbaur d****r@g****m 6
Chevtchenko Grigori g****o@e****h 4
Raphael Dumusc r****c@e****h 4
Jafet Villafranca j****z@e****h 4
Judit j****c@u****m 3
ppodhajski p****i@g****m 3
Cyrille Favreau c****u@e****h 3
Matthias Wolf m****f@e****h 3
Adrien Devresse a****e@e****h 2
Pablo Toharia p****a@u****s 1
Mohamed-Ghaith Kaabi m****i@e****h 1
bbpgithubaudit 8****t@u****m 1
Pablo Toharia p****a@u****s 1
Arseny V. Povolotsky c****s@y****u 1
Nicolas Cornu n****u@e****h 1
Committer Domains (Top 20 + Academic)
epfl.ch: 13 yandex.ru: 1 urjc.es: 1 upm.es: 1 fripost.org: 1 fi.upm.es: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 18
  • Total pull requests: 87
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 4 days
  • Total issue authors: 10
  • Total pull request authors: 9
  • Average comments per issue: 3.89
  • Average comments per pull request: 0.68
  • Merged pull requests: 83
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • arsenius7 (4)
  • mgeplf (3)
  • hernando (2)
  • asanin-epfl (2)
  • nantille (2)
  • tomdele (1)
  • matz-e (1)
  • antonelepfl (1)
  • seirios (1)
  • wvangeit (1)
Pull Request Authors
  • NadirRoGue (70)
  • ppodhajski (4)
  • jplanasc (4)
  • matz-e (3)
  • mgeplf (2)
  • hernando (1)
  • alkino (1)
  • bbpgithubaudit (1)
  • karjonas (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 152 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 9
  • Total maintainers: 2
pypi.org: brion

BlueBrain I/O Library

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 152 Last month
Rankings
Forks count: 8.0%
Dependent packages count: 10.0%
Stargazers count: 12.9%
Average: 13.3%
Downloads: 13.9%
Dependent repos count: 21.7%
Maintainers (2)
bbp.opensource obi.maintainer
Last synced: 6 months ago

Dependencies

setup.py pypi
  • REQUIRED_NUMPY_VERSION ,