Metadata-Version: 2.1
Name: d2b-yaml
Version: 1.0.0
Summary: Plugin for the d2b package to YAML configuration files
Home-page: https://github.com/d2b-dev/d2b-yaml
Keywords: neuroimaging,bids,d2b,plugin,configuration
Author: Andrew Ross
Author-email: andrew.ross.mail@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: d2b (>=1.1.4,<2.0.0)
Project-URL: Documentation, https://github.com/d2b-dev/d2b-yaml
Project-URL: Repository, https://github.com/d2b-dev/d2b-yaml
Description-Content-Type: text/markdown

# d2b-asl

Plugin for the d2b package to handle configuration files written in YAML.

[![PyPI Version](https://img.shields.io/pypi/v/d2b-yaml.svg)](https://pypi.org/project/d2b-yaml/)

## Installation

```bash
pip install d2b-yaml
```

## User Guide

This package adds support for configuration files written in YAML. Once this package is installed one can then run something like:

```bash
d2b run \
  --config="d2b-config.yaml" \
  --participant="01" \
  --session="001"
  --out-dir="my/bids/dataset/dir/" \
  "my/input/dir/"
```

See [`examples/d2b-config.yaml`](https://github.com/d2b-dev/d2b-yaml/blob/master/examples/d2b-config.yaml). The Schema for YAML configuration files is exactly the same as for JSON configuration files ([JSON Schema](https://github.com/d2b-dev/d2b/blob/master/json-schemas/schema.json))

