# Brion
[](https://doi.org/10.5281/zenodo.4472528)
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](https://github.com/BlueBrain/Brion.git).
The [latest API documentation]
(http://bluebrain.github.io/Brion-1.9/index.html) can be found on
[bluebrain.github.io](http://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.
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](@ref brion/types.h) to work with the loaded data using
[Boost](http://www.boost.org/doc/libs),
[GLM](https://github.com/g-truc/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-2022 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
Raw data
{
"_id": null,
"home_page": "https://github.com/BlueBrain/Brion",
"name": "brion",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Blue Brain Project, EPFL",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# Brion\n\n[](https://doi.org/10.5281/zenodo.4472528)\n\n\nWelcome to Brion, a C++ project for read and write access to Blue Brain data\nstructures, including BlueConfig/CircuitConfig, Circuit, CompartmentReport,\nMesh, Morphology, Synapse and Target files.\n\nBrion can be retrieved by cloning the\n[source code](https://github.com/BlueBrain/Brion.git).\nThe [latest API documentation]\n(http://bluebrain.github.io/Brion-1.9/index.html) can be found on\n[bluebrain.github.io](http://bluebrain.github.io).\nAdditional documentation exists for the [Python wrapping of Brain]\n(python/index.html).\n\nTo keep track of the changes between releases check the [changelog](@ref Changelog).\n\n## Features\n\nBrion provides two libraries Brion and Brain. The former is a collection of file\nreaders and writers intended for low level access to the data model. The latter\nis a set of higher level classes that wrap low level data objects with a\nuse-case oriented API.\n\nA python package to access the library can also be built and installed with pip. \nThe package is available in PyPi as well, under the name \"brion\". Please, note that\nthe python package **requires the user to have the python development package installed\non their system**.\n\n### IO library\n\nThis is the core library provided by Brion. It includes classes for reading\nand writing files which store the Blue Brain data model.\n\n* Fast and low-overhead read access to:\n * Blue configs (brion::BlueConfig)\n * Circuit description (brion::Circuit)\n * H5 Synapses data (brion::SynapseSummary, brion::Synapse)\n * Target (brion::Target)\n * BBP binary meshes (brion::Mesh)\n * BBP H5 morphologies and SWC morphologies (brion::Morphology)\n * Compartment reports (brion::CompartmentReport)\n * Spike reports (brion::SpikeReport)\n* Fast and low-overhead write access to:\n * Compartment reports (brion::CompartmentReport)\n * BBP binary meshes (brion::Mesh)\n * BBP H5 morphologies (brion::Morphology)\n * Spike reports (brion::SpikeReport)\n* Basic [data types](@ref brion/types.h) to work with the loaded data using\n [Boost](http://www.boost.org/doc/libs),\n [GLM](https://github.com/g-truc/glm).\n \n#### Disclaimer\n\nAlthough Brion is capable of reading SONATA format nodes, edges and reports, the use is\nexperimental and not supported officially. To read the SONATA format, it is encouraged\nthe usage of libsonata (https://github.com/BlueBrain/libsonata)\n\n### High level library\n\nThe higher level library is called Brain and it provides:\n\n* brain::Circuit to facilitate loading information about cells, morphologies (in\n local and global circuit coordinates) and synapses.\n* brain::neuron::Morphology with higher level functions to deal with\n morphologies.\n* brain::Synapses and brain::Synapse for array and object access to synapses.\n\n## Building\n\nBrion is a cross-platform library, designed to run on any modern operating\nsystem, including all Unix variants. Brion uses CMake to create a\nplatform-specific build environment. The following platforms and build\nenvironments are tested:\n\n* Linux: Ubuntu 16.04 or above, RHEL 6.8 (Makefile, Ninja)\n\nBuilding from source is as simple as:\n\n git clone --recursive https://github.com/BlueBrain/Brion.git\n mkdir Brion/build\n cd Brion/build\n cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DEXTLIB_FROM_SUBMODULES=ON ..\n ninja\n\n## Funding & Acknowledgment\n\nThe development of this software was supported by funding to the Blue Brain Project,\na research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the\nSwiss government\u2019s ETH Board of the Swiss Federal Institutes of Technology.\n\nThis project has received funding from the European Union\u2019s FP7-ICT programme\nunder Grant Agreement No. 604102 (Human Brain Project RUP).\n\nThis project has received funding from the European Union's Horizon 2020 Framework\nProgramme for Research and Innovation under the Specific Grant Agreement No. 720270\n(Human Brain Project SGA1).\n\nThis project is based upon work supported by the King Abdullah University of Science\nand Technology (KAUST) Office of Sponsored Research (OSR) under Award No. OSR-2017-CRG6-3438.\n\n## License\n\nBrion is licensed under the LGPL, unless noted otherwise, e.g., for external dependencies.\nSee file LICENSE.txt for the full license.\n\nCopyright (c) 2008-2022 Blue Brain Project/EPFL\n\nThis library is free software; you can redistribute it and/or modify it under the terms of the\nGNU Lesser General Public License version 3 as published by the Free Software Foundation.\n\nThis library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;\nwithout even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\nSee the GNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License along with this library;\nif not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,\nMA 02110-1301 USA\n\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "BlueBrain I/O Library",
"version": "3.3.10",
"project_urls": {
"Homepage": "https://github.com/BlueBrain/Brion"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbafdbc7c384e72932dcdc96ba84615b22ca25ccdf78f753e522e2bad1b6c9dd",
"md5": "4bf07ef225d3654f22c0dca8c3e2ec64",
"sha256": "88c93999318d87e4e3fbb28f7155820430404317bd0b65ccf782e1836b56df9e"
},
"downloads": -1,
"filename": "brion-3.3.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "4bf07ef225d3654f22c0dca8c3e2ec64",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 20220803,
"upload_time": "2023-05-08T13:24:24",
"upload_time_iso_8601": "2023-05-08T13:24:24.355166Z",
"url": "https://files.pythonhosted.org/packages/cb/af/dbc7c384e72932dcdc96ba84615b22ca25ccdf78f753e522e2bad1b6c9dd/brion-3.3.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-08 13:24:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBrain",
"github_project": "Brion",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "brion"
}
JSON
