[!WARNING] The Blue Brain Project concluded in December 2024, so development has ceased under the BlueBrain GitHub organization. Future development will take place at: https://github.com/openbraininstitute/libsonatareport

C++ / Python reader for SONATA reports files: https://github.com/AllenInstitute/sonata/blob/master/docs/SONATADEVELOPERGUIDE.md

Installation

Building the C++ library

shell git clone git@github.com:BlueBrain/libsonatareport.git --recursive cd libsonatareport cmake -B build -DCMAKE_BUILD_TYPE=Release -DSONATA_REPORT_ENABLE_SUBMODULES=ON -GNinja cmake --build build

Usage

This section provides guidance on how to use the tools provided by libsonatareport for converting report and spike files into the SONATA format.

Prerequisites

Before using the conversion tools, ensure the library is compiled with the converter enabled by including the cmake flag -DSONATA_REPORT_ENABLE_CONVERTER=ON during the installation process described in the "Installation" section.

Tools

Report Converter

Converts .bbp format files, typically containing voltage or current reports from simulations, into the SONATA format.

```shell reportsconverter <reportfilename> [population_name]

Example: reports_converter soma.bbp --soma PopulationA `` This command will convert the soma reportsoma.bbpfor population 'PopulationA' into the SONATA format assoma.bbp.h5`

Spikes Converter

The spikes converter tool is designed to convert old .dat spike files into the SONATA format.

```shell spikesconverter <spikefilename> [population_name]

Example: spikes_converter out.dat PopulationB ```

This command will convert the spike file out.dat for population 'PopulationB' into the SONATA format as out.dat.h5

Additional Information

For more detailed information on the usage of these converters, including additional options and examples, you can run them with the --help flag to display the usage:

shell reports_converter --help spikes_converter --help

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.

Copyright (c) 2021-2022 Blue Brain Project/EPFL