An open API service indexing awesome lists of open source software.

https://github.com/physiopy/phys2bids

Python3 library to format physiological files in BIDS. At the moment, it supports Acqknowledge and Labchart. BrainHack participants, check the issues with the BrainHack labels!
https://github.com/physiopy/phys2bids

acqknowledge bids brainweb closember ge hacktoberfest labchart physiological-recordings physiological-signals physiology python3-library spike2

Last synced: 5 days ago
JSON representation

Python3 library to format physiological files in BIDS. At the moment, it supports Acqknowledge and Labchart. BrainHack participants, check the issues with the BrainHack labels!

Awesome Lists containing this project

README

          


Phys2BIDS

phys2bids
=========

[![Latest version](https://img.shields.io/github/v/release/physiopy/phys2bids?style=flat&logo=github&sort=semver)](https://github.com/physiopy/phys2bids/releases)
[![Release date](https://img.shields.io/github/release-date/physiopy/phys2bids?style=flat&logo=github)](https://github.com/physiopy/phys2bids/releases)
[![Auto Release](https://img.shields.io/badge/release-auto.svg?style=flat&colorA=888888&colorB=9B065A&label=auto&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto)

[![See the documentation at: https://phys2bids.readthedocs.io](https://img.shields.io/badge/docs-read%20latest-informational?style=flat&logo=readthedocs)](https://phys2bids.readthedocs.io/en/latest/?badge=latest)
[![Latest DOI](https://zenodo.org/badge/208861898.svg)](https://zenodo.org/badge/latestdoi/208861898)
[![Licensed Apache 2.0](https://img.shields.io/github/license/physiopy/phys2bids?style=flat&logo=apache)](https://github.com/physiopy/phys2bids/blob/master/LICENSE)

[![Codecov](https://img.shields.io/codecov/c/gh/physiopy/phys2bids?style=flat&label=codecov&logo=codecov)](https://codecov.io/gh/physiopy/phys2bids)
[![Build Status](https://img.shields.io/circleci/build/github/physiopy/phys2bids?style=flat&label=circleci&logo=circleci)](https://circleci.com/gh/physiopy/phys2bids)
[![Documentation Status](https://img.shields.io/readthedocs/phys2bids?style=flat&label=readthedocs&logo=readthedocs)](https://phys2bids.readthedocs.io/en/latest/?badge=latest)

[![Latest version](https://img.shields.io/pypi/v/phys2bids?style=flat&logo=pypi&logoColor=white)](https://pypi.org/project/phys2bids/)
[![Supports python version](https://img.shields.io/pypi/pyversions/phys2bids?style=flat&logo=python&logoColor=white)](https://pypi.org/project/phys2bids/)

[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto)](https://github.com/intuit/auto)
[![Supports python version](https://img.shields.io/pypi/pyversions/phys2bids)](https://pypi.org/project/phys2bids/)

[![All Contributors](https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat)](#contributors)

``phys2bids`` is a python3 library meant to format physiological files in BIDS.
At the moment, it supports:
- ``.acq``, ``.txt``, and ``.mat`` AcqKnowledge format (BIOPAC)
- ``.txt`` and ``.mat`` LabChart format (ADInstruments)
- ``.smr`` Spike2 format (CED)
- GE MRI file format (GE)

We want to offer as much support as possible! If you have a file format that you want to see added, open an issue about it!

> If you use ``phys2bids`` in your work, please support it by citing the zenodo DOI of the version you used. You can find the latest version [here](https://doi.org/10.5281/zenodo.3470091)

> We also support gathering all relevant citations via [DueCredit](http://duecredit.org).

[Read the latest documentation](https://phys2bids.readthedocs.io/en/latest/) for more information on phys2bids!

Shortcuts:
- [Requirements](https://phys2bids.readthedocs.io/en/latest/installation.html#requirements)
- [Installation](https://phys2bids.readthedocs.io/en/latest/installation.html#linux-and-mac-installation)
- [Usage](https://phys2bids.readthedocs.io/en/latest/cli.html)
- [How to use phys2bids](https://phys2bids.readthedocs.io/en/latest/howto.html)
- [Contributing to phys2bids](https://phys2bids.readthedocs.io/en/latest/contributing.html)
- [Developer installation](https://phys2bids.readthedocs.io/en/latest/contributing.html#linux-and-mac-developer-installation)
- [**Contributor guide**](https://phys2bids.readthedocs.io/en/latest/contributorfile.html)
- [**Code of Conduct**](https://phys2bids.readthedocs.io/en/latest/conduct.html)
- [Developer calls calendar](https://calendar.google.com/calendar/u/0?cid=amoycDQ1MTdhMWdpaHNuNzlnOW1ucHJkMjRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ)

## Tested OSs
All versions until `2.6.2` were tested on Linux and Windows. However, starting from version `2.7` onwards we had to **drop Windows testing**. The reason for this is related to the cost of running such tests: for each Windows test, we can run up to 8 tests on Linux instead. Partial Windows testing might be reintroduced in future releases.

Hence, while **we cannot ensure that phys2bids will run on Windows or MacOS/iOS**, we don't see any reason it shouldn't. Besides, it will run on Linux Subsystems.

We apologise for any discomfort.

## Contributors ✨

**We're always looking for code contributors,** but any suggestion/bug report is welcome! Feel free to open issues!

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Daniel AlcalΓ‘
Daniel AlcalΓ‘

🎨
Apoorva Ayyagari
Apoorva Ayyagari

πŸ–‹ πŸ”£ πŸ“–
Katie Bottenhorn
Katie Bottenhorn

πŸ’» πŸ§‘β€πŸ« πŸ‘€ πŸ–‹
Molly Bright
Molly Bright

πŸ–‹ πŸ”£ πŸ€”


Cesar Caballero Gaudes
Cesar Caballero Gaudes

πŸ–‹ πŸ”£ πŸ€”
InΓ©s ChavarrΓ­a
InΓ©s ChavarrΓ­a

πŸ’»
Niall Duncan
Niall Duncan

πŸ’» πŸ“– πŸ”£ ⚠️ πŸ€”
Vicente Ferrer
Vicente Ferrer

πŸ› πŸ’» πŸ“– πŸ‘€ ⚠️


Yaroslav Halchenko
Yaroslav Halchenko

πŸš‡
Soichi Hayashi
Soichi Hayashi

πŸ›
Vittorio Iacovella
Vittorio Iacovella

πŸ’»
FranΓ§ois Lespinasse
FranΓ§ois Lespinasse

πŸ› πŸ’» πŸ–‹ ⚠️


Ross Markello
Ross Markello

πŸ› πŸ’» πŸ–‹ πŸ€” πŸš‡ πŸ‘€ ⚠️ πŸ§‘β€πŸ«
m-miedema
m-miedema

βœ… πŸ“‹
Stefano Moia
Stefano Moia

πŸ’» πŸ–‹ πŸ”£ πŸ€” πŸš‡ πŸ“† πŸ‘€ πŸ“– πŸ§‘β€πŸ« πŸ“’ πŸ“£ 🚧 βœ…
Robert Oostenveld
Robert Oostenveld

πŸ€” πŸ‘€


Basile
Basile

πŸ’» ⚠️
David Romero-Bascones
David Romero-Bascones

πŸ› πŸ’» πŸ“– πŸ–‹
Taylor Salo
Taylor Salo

πŸ€” πŸ’» πŸ‘€ πŸš‡
Rachael Stickland
Rachael Stickland

πŸ› πŸ’» πŸ”£ πŸ“– πŸ““ πŸ‘€ πŸš‡


Eneko UruΓ±uela
Eneko UruΓ±uela

πŸ› πŸ’» πŸš‡ πŸ‘€ ⚠️ πŸ§‘β€πŸ«
Merel van der Thiel
Merel van der Thiel

πŸ’»
Hao-Ting Wang
Hao-Ting Wang

πŸ’» πŸ“– πŸ”£ ⚠️ πŸ€”
Kristina Zvolanek
Kristina Zvolanek

πŸ”£ πŸ–‹ πŸ“–


Marcel Zwiers
Marcel Zwiers

πŸ”Œ
victox5
victox5

πŸ“–
Marie-Eve Picard
Marie-Eve Picard

πŸ‘€

License
-------

Copyright 2019-2020, The Phys2BIDS community.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.