Metadata-Version: 2.5
Name: qsiplan
Version: 0.4.1
Summary: Plan and explain QSIPrep's diffusion-MRI preprocessing from BIDS metadata
Project-URL: Homepage, https://github.com/PennLINC/qsiplan
Author: The PennLINC developers
License: Copyright (c) 2015-2018, the PennLINC developers team.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of qsiplan nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: bids2table>=2.3.1
Requires-Dist: nibabel
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Provides-Extra: tests
Requires-Dist: niworkflows; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'
Description-Content-Type: text/markdown

# QSIPlan

[![tests](https://github.com/PennLINC/qsiplan/actions/workflows/tests.yml/badge.svg)](https://github.com/PennLINC/qsiplan/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/PennLINC/qsiplan/branch/main/graph/badge.svg)](https://codecov.io/gh/PennLINC/qsiplan)

Plan and explain [qsiprep](https://github.com/PennLINC/qsiprep)'s
diffusion-MRI preprocessing from BIDS metadata and configuration flags.

`qsiplan` groups a subject's DWI scans the way qsiprep will (distortion
groups, fieldmap estimations, correction units, outputs), validates the
data and curation (missing phase-encoding metadata, IntendedFor conflicts,
shim walls, b-value mismatches...), compiles the execution plan for any
combination of head-motion- and susceptibility-correction methods, and
renders it all as text or as a self-contained interactive HTML page:

```bash
qsiplan /path/to/bids --html grouping.html
```
## Development

Set up the pinned lint/format hooks once — they run automatically on every
commit and use the exact tool versions CI does, so nothing passes locally and
then fails in CI:

```bash
pip install -e '.[tests,dev]'
pre-commit install
```

To lint the whole tree the way CI does (or before a first commit):

```bash
pre-commit run --all-files
```

The pinned versions live in a single place, `.pre-commit-config.yaml`; bump a
`rev` there and both local hooks and CI follow.
