Metadata-Version: 2.1
Name: pydra-dcm2bids
Version: 0.0.3
Summary: Pydra tasks for dcm2bids
Project-URL: Documentation, https://aramis-lab.github.io/pydra-dcm2bids
Project-URL: Issues, https://github.com/aramis-lab/pydra-dcm2bids/issues
Project-URL: Source, https://github.com/aramis-lab/pydra-dcm2bids
Author-email: Ghislain Vaillant <ghislain.vaillant@icm-institute.org>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: bids,dicom,pydra
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.7
Requires-Dist: attrs>=22.1
Requires-Dist: pydra>=0.21
Description-Content-Type: text/markdown

# pydra-dcm2bids

[![PyPI - Version][pypi-version]][pypi-project]
[![PyPI - Python Version][pypi-pyversions]][pypi-project]

----

Pydra tasks for dcm2bids.

[Pydra][pydra] is a dataflow engine which provides
a set of lightweight abstractions for DAG
construction, manipulation, and distributed execution.

[`dcm2bids`][dcm2bids] is a tool which facilitates
conversion from DICOM datasets to NIfTI files
organized as [BIDS][bids].

## Installation

```console
pip install pydra-dcm2bids
```

A separate installation of `dcm2bids` is required to use this package.
Please review the following [instructions][dcm2bids-install].

## Usage

```python
from pydra.tasks import dcm2bids

task = dcm2bids.Dcm2Bids(
    dicom_dir="/path/to/dicom/dir",
    output_dir="/path/to/bids/dir",
    config_file="/path/to/config/file.json",
    participant_id="sub-01",
)

result = task()
```

You may check the following example of a [configuration file][dcm2bids-config-file].

## Development

This project is managed with [Hatch][hatch]:

```console
pipx install hatch
```

To run the test suite:

```console
hatch run test:no-cov
```

To fix linting issues:

```console
hatch run lint:fix
```

To check the documentation:

```console
hatch run docs:serve --open-browser
```

## License

`pydra-dcm2bids` is distributed under the terms of the [Apache License, Version 2.0][license].

[pypi-project]: https://pypi.org/project/pydra-dcm2bids

[pypi-version]: https://img.shields.io/pypi/v/pydra-dcm2bids.svg

[pypi-pyversions]: https://img.shields.io/pypi/pyversions/pydra-dcm2bids.svg

[pydra]: https://pydra.readthedocs.io/

[dcm2bids]: https://unfmontreal.github.io/Dcm2Bids/

[bids]: https://bids-specification.readthedocs.io/

[dcm2bids-install]: https://unfmontreal.github.io/Dcm2Bids/docs/get-started/install/

[dcm2bids-config-file]: https://unfmontreal.github.io/Dcm2Bids/docs/how-to/create-config-file/

[hatch]: https://hatch.pypa.io/

[license]: https://spdx.org/licenses/Apache-2.0.html
