Metadata-Version: 2.1
Name: psychopy-bids
Version: 2024.1.0
Summary: A PsychoPy plugin for using the Brain Imaging Data Structure (BIDS) to organize and describe data.
Author-email: Christoph Anzengruber <christoph.anzengruber@uni-graz.at>, Florian Schöngaßner <florian.schoengassner@uni-graz.at>
License: GNU General Public License v3 (GPLv3)
Project-URL: homepage, https://pypi.org/project/psychopy-bids/
Project-URL: changelog, https://gitlab.com/psygraz/psychopy-bids/-/blob/master/CHANGELOG
Project-URL: documentation, https://psychopy-bids.readthedocs.io/en/latest/
Project-URL: repository, https://gitlab.com/psygraz/psychopy-bids/
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: pandas>=1.4.3
Requires-Dist: psychopy>=2023.1.0

# psychopy_bids

A [PsychoPy](https://www.psychopy.org/) plugin to work with the [Brain Imaging Data Structure (BIDS)](https://bids-specification.readthedocs.io/)

* **Website:** https://psygraz.gitlab.io/psychopy-bids
* **Documentation:** https://psychopy-bids.readthedocs.io
* **Source code:** https://gitlab.com/psygraz/psychopy-bids/
* **Contributing:** https://psychopy-bids.readthedocs.io/en/doc/contributing/
* **Bug reports:** https://gitlab.com/psygraz/psychopy-bids/issues
* **Code of Conduct:** https://psychopy-bids.readthedocs.io/en/doc/conduct/

## Installation

```bash
$ pip install psychopy_bids
```

## Usage

`psychopy_bids` can be used to create valid BIDS datasets by adding the possibility of using [task events](https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/05-task-events.html) in PsychoPy.

```python
from psychopy_bids import bids

handler = bids.BIDSHandler(dataset="example", subject="01", task="A")
handler.createDataset()

event_list = [bids.BIDSTaskEvent(onset=1.0, duration=0, trial_type="trigger")]
participant_info = {"participant_id": handler.subject, "age": 18}

handler.addTaskEvents(event_list, participant_info)
```

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`psychopy_bids` was created by Christoph Anzengruber & Florian Schöngaßner. It is licensed under the terms of the GNU General Public License v3.0 license.

## Credits

`psychopy_bids` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
