niwrap 0.4.0

Neuroimaging Python wrappers.

⚠️ Important Notice: This is a very early release of niwrap. We do not recommend using niwrap in 'production' at this stage unless you are willing to debug, fix, and contribute descriptors.

niwrap

🧠 Python wrappers for neuroimaging command-line tools

🚀 Quick Start

from niwrap import fsl

# Brain extraction using FSL's BET
bet_output = fsl.bet(
    infile="input_image.nii.gz",
)

📦 Installation

Install the stable version from PyPI:

pip install niwrap

Or install the development version:

pip install -e "git+https://github.com/childmindresearch/niwrap.git/#egg=niwrap&subdirectory=python"

🧰 Supported Tools

Package	Status	Version	API Coverage
AFNI	Experimental	24.2.06	565/611 (92.5%)
ANTs	Experimental	2.5.3	71/113 (62.8%)
Connectome Workbench	Experimental	1.5.0	202/202 (100% 🎉)
Convert3D	Experimental	1.1.0	2/2 (100% 🎉)
FSL	Experimental	6.0.5	239/310 (77.1%)
FastSurfer	Experimental	2.3.3	1/1 (100% 🎉)
FreeSurfer	Experimental	7.4.1	707/800 (88.4%)
Greedy	Experimental	1.0.1	1/1 (100% 🎉)
MRTrix3	Well tested	3.0.4	115/121 (95.0%)
MRTrix3Tissue	Well tested	5.2.8	1/1 (100% 🎉)
NiftyReg	Experimental	1.4.0	7/7 (100% 🎉)
dcm2niix	Experimental	1.0.20240202	1/1 (100% 🎉)

🛠 Usage Examples

Usage examples and tutorials can be found in the Styx book.

🔧 Development

All code in this package is automatically generated by Styx.

📚 Documentation

For full documentation, visit our docs site.

🤝 Contributing

We welcome contributions! Please see our Contribution Guide for more details.

📄 License

The niwrap Python package, including all wrapper code, is licensed under the MIT License. See the LICENSE file for more details.

⚠️ Important Notice: While niwrap provides convenient Python wrappers, it does not include or distribute the actual neuroimaging tools. Each tool wrapped by niwrap (e.g., FSL, AFNI, ANTs) is subject to its own license. Users of niwrap must ensure they comply with the licenses of the underlying tools they use. The MIT License of niwrap applies only to the wrapper code, not to the tools themselves.

🙋‍♀️ Getting Help

The Styx book aims to be a starting point for new users.

If you encounter any problems or have any questions, please open an issue on our GitHub repository.