Skip to main content

Reorganising NIfTI files from dcm2niix into the Brain Imaging Data Structure

Project description

dcm2bids

Your friendly DICOM converter.

Documentation badge DOI Last update badge

Test status badge Code coverage badge Code style: black

PyPI version badge PyPI - Downloads

Anaconda-Server Badge Docker container badge

License badge


dcm2bids reorganises NIfTI files using dcm2niix into the Brain Imaging Data Structure (BIDS).

Major upgrade with dcm2bids >=3.0.0

⚠️ Breaking changes alert ⚠️

dcm2bids>=3.0.0 is not compatible with config files made for v2.1.9 and below. In order to develop dcm2bids new features we had to rewrite some of its code.
Since v3.0.0, dcm2bids has become more powerful and more flexible while reducing the burden of creating config files. Porting your config file should be relatively easy by following the How-to upgrade page. If you have any issues with it don't hesitate to report it on Neurostars.

Scope

dcm2bids is a community-centered project. It aims to be a friendly, easy-to-use tool to convert your dicoms. Our main goal is to make the dicom to BIDS conversion as effortless as possible. Even if in the near future more advanced features will be added, we'll keep the focus on your day to day use case without complicating anything. That's the promise of the dcm2bids project.

Documentation

Please take a look at the documentation to:

Issues and Questions

We work hard to make sure dcm2bids is robust and we welcome comments and questions to make sure it meets your use case! Here's our preferred workflow:

  • If you have a usage question :raising_hand:, we encourage you to post your question on Neurostars with dcm2bids as an optional tag. The tag is really important because Neurostars will notify the dcm2bids team only if the tag is present. Neurostars is a question and answer forum for neuroscience researchers, infrastructure providers and software developers, and free to access.
    Before posting your question, you may want to first browse through questions that were tagged with the dcm2bids tag. If your question persists, feel free to comment on previous questions or ask your own question.

  • If you think you've found a bug :bug:, please open an issue on our repository. To do this, you'll need a GitHub account. See our contributing guide for more details.

Please cite dcm2bids

If you use dcm2bids in your research or as part of your developments, please always cite the reference below.

APA

Boré, A., Guay, S., Bedetti, C., Meisler, S., & GuenTher, N. (2023). Dcm2Bids (Version 3.1.0) [Computer software]. https://doi.org/10.5281/zenodo.8342572

BibTeX

@software{Bore_Dcm2Bids_2023,
author = {Boré, Arnaud and Guay, Samuel and Bedetti, Christophe and Meisler, Steven and GuenTher, Nick},
doi = {10.5281/zenodo.8342572},
month = aug,
title = {{Dcm2Bids}},
url = {https://github.com/UNFmontreal/Dcm2Bids},
version = {3.1.0},
year = {2023}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dcm2bids-3.1.1.tar.gz (39.2 kB view hashes)

Uploaded source

Built Distribution

dcm2bids-3.1.1-py3-none-any.whl (43.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page