🧠 Modern Python wrappers for neuroimaging tools
- Extensive collection of neuroimaging command line tool metadata
- Generates idiomatic Python wrappers for popular neuroimaging tools
- Based on Boutiques Descriptor Schema
- Powered by Styx compiler
| Package | Status | Version | API Coverage |
|---|---|---|---|
| AFNI | In progress | 24.2.06 |
561/621 (90.3%) |
| ANTs | In progress | 2.5.3 |
9/120 (7.5%) |
| Connectome Workbench | Testing | 1.5.0 |
202/202 (100% 🎉) |
| Convert3D | In progress | 1.1.0 |
2/4 (50.0%) |
| FSL | In progress | 6.0.5 |
221/376 (58.8%) |
| FreeSurfer | In progress | 7.4.1 |
2/104 (1.9%) |
| Greedy | In progress | 1.0.1 |
1/1 (100% 🎉) |
| MRTrix3 | Testing | 3.0.4 |
116/125 (92.8%) |
| MRTrix3Tissue | Testing | 5.2.8 |
1/1 (100% 🎉) |
| NiftyReg | In progress | 1.4.0 |
7/7 (100% 🎉) |
📊 API Coverage Explained
- Represents the percentage of tool binaries with available NiWrap descriptors
- Does not indicate descriptor completeness
- 100% coverage isn't always necessary (e.g., some FSL/AFNI utilities have Python stdlib equivalents)
- To improve coverage:
- Add missing descriptor in
descriptors/- Mark irrelevant binaries as
"status": "ignore"inpackages/
niwrap/
├── descriptors/ # Boutiques descriptors
├── schemas/ # JSON schema for Boutiques descriptors
├── python/ # Generated niwrap Python package
├── extraction/ # Source metadata extraction
└── packages/ # Package-specific metadata
Install the niwrap Python package to use the generated wrappers:
pip install niwrapSee the NiWrap Python package readme for more details.
Contributions are welcome! See CONTRIBUTING.md for ways to get started.
The NiWrap project itself, including all metadata and generated Python wrappers, is licensed under the MIT License. See the LICENSE file for details.
⚠️ Important: The neuroimaging tools wrapped by NiWrap each have their own licenses. Using NiWrap does not grant any rights to use these tools beyond what their respective licenses allow. Users are responsible for complying with the licenses of the underlying tools they use through NiWrap.
For support, please open an issue in the GitHub issue tracker.