diff --git a/README.md b/README.md index 701b379b2..23d34d3d3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ phys2bids ========= -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3586045.svg)](https://doi.org/10.5281/zenodo.3586045) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3653153.svg)](https://doi.org/10.5281/zenodo.3653153) [![Build Status](https://travis-ci.org/physiopy/phys2bids.svg?branch=master)](https://travis-ci.org/physiopy/phys2bids) [![Join the chat at https://gitter.im/phys2bids/community](https://badges.gitter.im/phys2bids/community.svg)](https://gitter.im/phys2bids/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Documentation Status](https://readthedocs.org/projects/phys2bids/badge/?version=latest)](https://phys2bids.readthedocs.io/en/latest/?badge=latest) @@ -14,18 +14,23 @@ phys2bids [![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat)](#contributors-) -Phys2bids is a python3 library meant to format physiological files in BIDS. +``phys2bids`` is a python3 library meant to format physiological files in BIDS. It was born for AcqKnowledge files (BIOPAC), and at the moment it supports ``.acq`` files as well as ``.txt`` files obtained by labchart (ADInstruments). It doesn't support physiological files recorded with the MRI, as you can find a software for it [here](https://github.com/tarrlab/physio2bids). +If you use ``phy2bids`` in your work, please cite it with the zenodo DOI as: + +>The phys2bids contributors, Daniel Alcalá, Apoorva Ayyagari, Molly Bright, César Caballero-Gaudes, Vicente Ferrer Gallardo, Soichi Hayashi, Ross Markello, Stefano Moia, Rachael Stickland, Eneko Uruñuela, & Kristina Zvolanek (2020, February 6). physiopy/phys2bids: BIDS formatting of physiological recordings v1.3.0-beta (Version v1.3.0-beta). Zenodo. http://doi.org/10.5281/zenodo.3653153 + [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) diff --git a/docs/index.rst b/docs/index.rst index 5e7f91fcc..9e738627b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,16 +3,31 @@ phys2bids ========= .. image:: _static/phys2bids_logo1280×640.png - :alt: phys2bids logo - :align: center + :alt: phys2bids logo + :align: center -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3586045.svg - :target: https://doi.org/10.5281/zenodo.3586045 +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3653153.svg + :target: https://doi.org/10.5281/zenodo.3653153 + :alt: DOI + +.. image:: https://travis-ci.org/physiopy/phys2bids.svg?branch=master + :target: https://travis-ci.org/physiopy/phys2bids + :alt: Build status .. image:: https://badges.gitter.im/phys2bids/community.svg - :target: https://badges.gitter.im/phys2bids/community.svg)](https://gitter.im/phys2bids/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge + :target: https://badges.gitter.im/phys2bids/community.svg)](https://gitter.im/phys2bids/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge + :alt: Join the chat at https://gitter.im/phys2bids/community + +.. image:: https://readthedocs.org/projects/phys2bids/badge/?version=latest + :target: https://phys2bids.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + +.. image:: https://codecov.io/gh/physiopy/phys2bids/branch/master/graph/badge.svg + :target: https://codecov.io/gh/physiopy/phys2bids + :alt: codecov + -Phys2bids is a python3 library meant to format physiological files in BIDS. +``phys2bids`` is a python3 library meant to format physiological files in BIDS. It was born for AcqKnowledge files (BIOPAC), and at the moment it supports ``.acq`` files as well as ``.txt`` files obtained by labchart (ADInstruments). @@ -21,6 +36,14 @@ It doesn't support physiological files recorded with the MRI, as you can find a **The project is currently under development**. Any suggestion/bug report is welcome! Feel free to open an issue. +Citing ``phys2bids`` +-------------------- + +If you use ``phy2bids``, please cite it using the Zenodo DOI as:: + + The phys2bids contributors, Daniel Alcalá, Apoorva Ayyagari, Molly Bright, César Caballero-Gaudes, Vicente Ferrer Gallardo, Soichi Hayashi, Ross Markello, Stefano Moia, Rachael Stickland, Eneko Uruñuela, & Kristina Zvolanek (2020, February 6). physiopy/phys2bids: BIDS formatting of physiological recordings v1.3.0-beta (Version v1.3.0-beta). Zenodo. http://doi.org/10.5281/zenodo.3653153 + + Contents --------