codecov Python tests Documentation Status https://img.shields.io/badge/Preprint-Zenodo-orange

sovabids

Visit the documentation

Supported Formats

sovabids reads EEG files via MNE-Python’s read_raw, which supports a wide range of formats including BrainVision, EDF/BDF, EEGLAB, FIF, CNT, KIT/SQD, CTF, and more. See the full list in the MNE documentation.

Output is always written as a valid BIDS dataset. The table below lists formats that can also be exported natively (i.e., the BIDS data files stay in that format rather than being converted to BrainVision):

Format

Extension

Extra needed

Notes

BrainVision

.vhdr

(core)

Default output format; pybv included in base install

EDF

.edf

sovabids[formats]

Requires edfio; date must be in 1985–2084

EEGLAB

.set

sovabids[formats]

Requires eeglabio; montage with fiducials needed

FIF

.fif

(core)

MNE native format; use for MEG data (experimental — see warning above)

Install export support for EDF and EEGLAB:

pip install "sovabids[formats]"

For all other readable formats, sovabids converts the data to BrainVision on output (the default mne-bids behaviour).

Architecture

The main elements of sovabids are:

  • A source path with the original dataset.

  • A bids path that will be the output path of the conversion.

  • A rules file that configures how the conversion is done from the general perspective.

  • A mapping file that encodes how the conversion is performed to each individual file of the dataset.

https://mermaid.ink/svg/eyJjb2RlIjoiZ3JhcGggTFJcbiAgICBTPlwiU291cmNlIHBhdGhcIl1cbiAgICBCPlwiQmlkcyBwYXRoXCJdXG4gICAgUj5cIlJ1bGVzIGZpbGVcIl1cbiAgICBBUigoXCJBcHBseSBSdWxlc1wiKSlcbiAgICBNPlwiTWFwcGluZ3MgZmlsZVwiXVxuICAgIENUKChcIkNvbnZlcnQgVGhlbVwiKSlcbiAgICBPWyhcIkNvbnZlcnRlZCBkYXRhc2V0XCIpXVxuICAgIFMgLS0-IEFSXG4gICAgQiAtLT4gQVJcbiAgICBSIC0tPiBBUlxuICAgIEFSIC0tPiBNXG4gICAgTSAtLT4gQ1RcbiAgICBDVCAtLT4gT1xuICAiLCJtZXJtYWlkIjp7InRoZW1lIjoiZm9yZXN0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjpmYWxzZX0

Internally sovabids uses MNE-Python and MNE-BIDS to perform the conversion. In a sense is a wrapper that allows to do conversions from the command line.

Basic Usage

Terminal User Interface (sovatui)

sovabids ships an experimental terminal user interface (TUI) called sovatui. It lets you run a conversion without writing any command line code, guiding you through the full workflow in four tabs: Setup, Rules, Mappings, and Convert. It is optional (install it with the [tui] extra shown below); the CLI and Python API are the primary, fully supported interfaces.

Installation for TUI usage

This will install sovabids with the terminal user interface dependencies.

pip install "sovabids[tui]"

Running the TUI

sovatui

See the TUI tutorial video for a walkthrough and its example.

Command Line Interface (CLI) entry-points

Use sovabids through its CLI entry-points as follows:

Installation
pip install sovabids
sovapply

Use the sovapply entry-point to produce a mapping file from a source path, an output bids root path and a rules filepath.

sovapply source_path bids_path rules_path

By default the mapping file made will have the following filepath:

bids_path/code/sovabids/mappings.yml
sovaconvert

Use the sovaconvert entry-point to convert the dataset given its mapping file.

sovaconvert mapping_file

Using the experimental web GUI

Installation for WEB GUI usage

This will install sovabids for usage with an experimental web gui.

pip install "sovabids[gui]"

See the WEB GUI tutorial video for a walkthrough and its example.

Using the experimental bidscoin plugin

For the experimental bidscoin plugin, install the sovabids fork of bidscoin manually:

pip install "git+https://github.com/yjmantilla/bidscoin.git@sovabids"

Follow the example at https://sovabids.readthedocs.io/en/latest/auto_examples/bidscoin_example.html to see how to use the plugin.

Installation for developers

Fork this repo and run:

git clone https://github.com/<gh-username>/sovabids.git
cd sovabids
pip install -e ".[dev]"

Contributing

Contributions are welcome. See the Contributing guide for how to set up a development environment, run the tests, and open a pull request. The guide also lives at .github/CONTRIBUTING.md.

To report a bug, open an issue on the issue tracker. For usage questions and general help, use GitHub Discussions. The project follows a Code of Conduct.

Funding

Google Summer of Code Funding logo

Acknowledgments

sovabids is developed with the help of the following entities:

University of Queensland Swinburne University Universidad de Antioquia GRUNECO Neuroimaging Facility INCF

Academic Works

What does sova means?

sova is a contraction of ‘eso va’ which mean ‘that goes’ in spanish.

Nevertheless the real usage by the original developers is just to convey the idea of :

we will make it happen, we dont know how, but we will

Project links

Data verified by PyPI on Aug 19, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for yjmantilla from gravatar.com yjmantilla

Credits

Author: sovabids developers

Maintainer: Yorguin Mantilla

GitHub Statistics

Data verified by PyPI on Aug 19, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.9

Provides Extra

dev docs formats gui tui

Tags

EEG bids conversion eeg mne mne-bids

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sovabids-0.4.6.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sovabids-0.4.6-py3-none-any.whl (55.6 kB view details)

Uploaded Python 3

File details

Details for the file sovabids-0.4.6.tar.gz.

File metadata

  • Download URL: sovabids-0.4.6.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sovabids-0.4.6.tar.gz
Algorithm Hash digest
SHA256 0659955b4574db896469f9c3dead273c8e470512110cab7441cb7833ab703842
MD5 73a81f11e4a23f4e4edd8b395e716af7
BLAKE2b-256 027c6e53f5ddf5f97edaadef6ed9bd3830aef11c18ef6d045c86079854eddf7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sovabids-0.4.6.tar.gz:

Publisher: publish.yml on yjmantilla/sovabids

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sovabids-0.4.6-py3-none-any.whl.

File metadata

  • Download URL: sovabids-0.4.6-py3-none-any.whl
  • Upload date:
  • Size: 55.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sovabids-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3832795720134240cb440f46c2ebc32bf2cd983e6c9f3ff67e96a7c179b9875a
MD5 847001e4dd1aaeb27a7c43adc291136e
BLAKE2b-256 b89e0cbf51c167a8fb6441b6ea821e0558828a996f7bd3fa6adb82455cf806c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for sovabids-0.4.6-py3-none-any.whl:

Publisher: publish.yml on yjmantilla/sovabids

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.4.6 This release

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4

2 files

Pre-release

0.3.2.dev0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page