Metadata-Version: 2.4
Name: pydeface
Version: 2.1.0
Summary: A script to remove facial structure from MRI images
Maintainer-email: Russ Poldrack <poldrack@stanford.edu>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-Expression: MIT
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
License-File: LICENSE.txt
Requires-Dist: numpy>=2.0
Requires-Dist: nibabel>=5.3
Requires-Dist: nipype>=1.9
Project-URL: homepage, https://www.poldracklab.org/
Project-URL: source, https://github.com/poldracklab/pydeface

[![DOI](https://zenodo.org/badge/47563497.svg)](https://zenodo.org/badge/latestdoi/47563497)

<img src="/visuals/logo.svg" width=250 align="right" />

# PyDeface
A tool to remove facial structure from MRI images.

## Dependencies:
| Package                                           | Tested version |
|---------------------------------------------------|----------------|
| [FSL](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FSL) | 6.0.7.18       |
| [Python 3](https://www.python.org/downloads/)     | 3.14.3         |
| [NumPy](https://numpy.org/)                       | 2.4.2          |
| [NiBabel](https://nipy.org/nibabel/)              | 5.3.2          |
| [Nipype](https://nipype.readthedocs.io/en/latest/)| 1.11.0         |

## Installation
```
pip install pydeface
```
or
```
git clone https://github.com/poldracklab/pydeface.git
cd pydeface
pip install .
```

## How to use
```
pydeface infile.nii.gz
```

Also see the help for additional options:
```
pydeface --help
```

## License
PyDeface is licensed under [MIT license](LICENSE.txt).

