Skip to content

Commit

Permalink
Add a neurodesk reference and badge
Browse files Browse the repository at this point in the history
(cherry picked from commit 9b4ccf1)
  • Loading branch information
marcelzwiers committed Oct 18, 2023
1 parent 2bb3bab commit 6b9b623
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ BIDScoin: Coin your imaging data to BIDS

<img name="bidscoin-logo" src="https://github.com/Donders-Institute/bidscoin/blob/master/bidscoin/bidscoin_logo.png" height="340px" align="right" alt=" ">

|PyPI version| |BIDS| |PyPI - Python Version| |GPLv3| |RTD| |Tests| |DOI|
|PyPI version| |NeuroDesk| |BIDS| |PyPI - Python Version| |GPLv3| |RTD| |Tests| |DOI|

BIDScoin is a user-friendly Python application suite that converts ("coins") source-level (raw) neuroimaging data sets to standardized data sets that are organized according to the Brain Imaging Data Structure (`BIDS <https://bids-specification.readthedocs.io>`__) specification. Rather than depending on complex programmatic logic for source data-type identification, BIDScoin uses a mapping approach to discover the different source data types in your repository and convert them into BIDS data types. Different runs of source data are uniquely identified by their file system properties (e.g. file name or size) and by their attributes (e.g. ``ProtocolName`` from the DICOM header). Mapping information can be pre-specified (e.g. per site), allowing BIDScoin to make intelligent first suggestions on how to classify and convert the data. While this command-line procedure exploits all information available on disk, BIDScoin presents a `Graphical User Interface (GUI) <./screenshots.html>`__ for researchers to check and edit these mappings -- bringing in the missing knowledge that often exists only in their heads.

Expand Down Expand Up @@ -58,6 +58,9 @@ Are you a Python programmer with an interest in BIDS who knows about GE and/or P
:alt: BIDScoin
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/bidscoin.svg
:alt: Python 3
.. |NeuroDesk| image:: https://img.shields.io/badge/NeuroDesk-v4.2.0-green
:target: https://www.neurodesk.org/docs/overview/applications/
:alt: NeuroDesk
.. |GPLv3| image:: https://img.shields.io/badge/License-GPLv3+-blue.svg
:target: https://www.gnu.org/licenses/gpl-3.0
:alt: GPL-v3.0 license
Expand Down
2 changes: 2 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Installation
============

BIDScoin can be installed directly on your operating system, or can be installed in a so-called container. Direct installation is arguably simpler and lighter, but containerized installations are better guaranteed to always work and be reproducible. Below you find instructions for direct installation, followed by instructions for installation in a container. Alternatively, if you like to use a container but don't like the complexity of its overhead, you can install `NeuroDesk <https://www.neurodesk.org/>`__ and use the pre-installed BIDScoin container without needing to know anything about containers.

Python installation
-------------------

Expand Down

0 comments on commit 6b9b623

Please sign in to comment.