Metadata-Version: 2.1
Name: Ingress2QSIRecon
Version: 0.1.0
Summary: Tool to ingress data from other pipelines for use in QSIRecon
Author: Steven Meisler
Author-email: smeisler13@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: SimpleITK (>=2.4.0,<3.0.0)
Requires-Dist: beartype (>=0.18.5,<0.19.0)
Requires-Dist: icontract (>=2.6.6,<3.0.0)
Requires-Dist: loguru (>=0.7.2,<0.8.0)
Requires-Dist: nibabel (>=5.2.1,<6.0.0)
Requires-Dist: nilearn (>=0.10.4,<0.11.0)
Requires-Dist: nipype (>=1.8.6,<2.0.0)
Requires-Dist: pydantic (>=2.8,<3.0)
Project-URL: homepage, https://github.com/PennLINC/ingress2qsirecon
Project-URL: repository, https://github.com/PennLINC/ingress2qsirecon
Description-Content-Type: text/markdown

# Ingress2QSIRecon
A tool for ingressing outputs from other processing pipelines (e.g., HCP, UKB) for use in QSIRecon.

## Overview
Your description here

## Usage
This project is set up using poetry. To install the dependencies, run `poetry install` from the root of the project.

```shell
poetry install
```

To add a new dependency, run `poetry add <dependency>` from the root of the project.

```shell
poetry add <dependency>
```

### Pre-Commit Hooks
This project uses [pre-commit](https://pre-commit.com/) to run linting and formatting tools before each commit. To install the pre-commit hooks, run `pre-commit install` from the root of the project.

```shell
poetry run pre-commit install
```

To run the pre-commit hooks manually, run `pre-commit run --all-files` from the root of the project.

```shell
poetry run pre-commit run --all-files
```


### Testing
This project uses [pytest](https://docs.pytest.org/en/stable/) for testing. To run the tests, run `pytest` from the root of the project in the poetry shell.

```shell
poetry run pytest
```

There are sensible defaults for pytest setup in the `pyproject.toml` file. You can override these defaults by passing in command line arguments. For example, to run the tests with debug logging enabled, run `pytest --log-cli-level=DEBUG` from the root of the project.

```shell
poetry run pytest --log-cli-level=DEBUG
```


