README.md

phys2bids

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

We also support gathering all relevant citations via DueCredit.

Read the latest documentation for more information on phys2bids!

Shortcuts:

• Requirements
• Installation
• Usage
• How to use phys2bids
• Contributing to phys2bids
• Developer installation
• Contributor guide
• Code of Conduct
• Developer calls calendar

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.

Daniel Alcalá 🎨	Apoorva Ayyagari 🖋 🔣 📖	Katie Bottenhorn 💻 🧑‍🏫 👀 🖋	Molly Bright 🖋 🔣 🤔
Cesar Caballero Gaudes 🖋 🔣 🤔	Inés Chavarría 💻	Niall Duncan 💻 📖 🔣 ⚠️ 🤔	Vicente Ferrer 🐛 💻 📖 👀 ⚠️
Yaroslav Halchenko 🚇	Soichi Hayashi 🐛	Vittorio Iacovella 💻	François Lespinasse 🐛 💻 🖋 ⚠️
Ross Markello 🐛 💻 🖋 🤔 🚇 👀 ⚠️ 🧑‍🏫	m-miedema ✅ 📋	Stefano Moia 💻 🖋 🔣 🤔 🚇 📆 👀 📖 🧑‍🏫 📢 📣 🚧 ✅	Robert Oostenveld 🤔 👀
Basile 💻 ⚠️	David Romero-Bascones 🐛 💻 📖 🖋	Taylor Salo 🤔 💻 👀 🚇	Rachael Stickland 🐛 💻 🔣 📖 📓 👀
Eneko Uruñuela 🐛 💻 🚇 👀 ⚠️ 🧑‍🏫	Merel van der Thiel 💻	Hao-Ting Wang 💻 📖 🔣 ⚠️ 🤔	Kristina Zvolanek 🔣 🖋 📖
Marcel Zwiers 🔌	victox5 📖

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.