Welcome to Brain Pipe’s documentation!¶

_images/brain_pipe_github.svg — Fig. 1 **Brain pipe** : Preprocess brain imaging datasets efficiently and extensibly in Python3.¶

Motivation¶

This repository contains code to efficiently preprocess BIDS datasets in python3. The initial main goal of this code is to use it for the public EEG dataset of the ICASSP 2023 Auditory EEG challenge, i.e. the sparrKULee dataset and possibly further extend to other EEG/brain datasets where efficient preprocessing is necessary.

Currently, only EEG datasets are supported.

Internal structure¶

Most of the code relies on a pipeline structure which is explained in more detail in Overview and Defining and running Pipelines through configuration files

Installation¶

You can install this repository as a pip package:

.. code-block:: bash

$ pip install brain_pipe

Running¶

You can create your own script to run the pipeline (see also Overview), or you can use the command line interface (see also Command Line Interface and Defining and running Pipelines through configuration files) with a configuration file.

Requirements¶

Python >= 3.8

Contributing¶

Contributions are welcome. Please open an issue or a pull request. For more information, see CONTRIBUTING.md.

API reference¶

See API Reference