niwrap 0.1.0__tar.gz

niwrap-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.1
+Name: niwrap
+Version: 0.1.0
+Summary: Neuroimaging Python wrappers.
+License: LGPL-2.1
+Author: Child Mind Institute
+Author-email: cmi-dair@childmind.org
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved
+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: styxdefs (>=0.2.0,<0.3.0)
+Description-Content-Type: text/markdown
+
+> **⚠️ 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
+
+[![Build](https://github.com/childmindresearch/niwrap/actions/workflows/compile.yml/badge.svg?branch=main)](https://github.com/childmindresearch/niwrap/actions/workflows/compile.yml?query=branch%3Amain)
+![stability-stable](https://img.shields.io/badge/stability-experimental-red.svg)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/niwrap/blob/main/LICENSE)
+[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/niwrap)
+
+## 🚀 Quick Start
+
+```python
+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:
+
+```bash
+pip install niwrap
+```
+
+Or install the development version:
+
+```bash
+pip install -e "git+https://github.com/childmindresearch/niwrap.git/#egg=niwrap&subdirectory=python"
+```
+
+## 🧰 Supported Tools
+
+<!-- START_PACKAGES_TABLE -->
+
+| Package | Status | Version | API Coverage |
+| --- | --- | --- | --- |
+| [AFNI](https://afni.nimh.nih.gov/) | In progress | [`24.2.06`](https://hub.docker.com/r/afni/afni_make_build) | 561/621 (90.3%) |
+| [ANTs](https://github.com/ANTsX/ANTs) | In progress | [`2.5.3`](https://hub.docker.com/r/antsx/ants) | 9/120 (7.5%) |
+| [Connectome Workbench](https://github.com/Washington-University/workbench) | Testing | [`1.5.0`](https://hub.docker.com/r/brainlife/connectome_workbench) | 202/202 (100% 🎉) |
+| [Convert3D](http://www.itksnap.org/pmwiki/pmwiki.php?n=Convert3D.Convert3D) | In progress | [`1.1.0`](https://hub.docker.com/r/pyushkevich/itksnap) | 2/4 (50.0%) |
+| [FSL](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki) | In progress | [`6.0.5`](https://hub.docker.com/r/mcin/fsl) | 221/376 (58.8%) |
+| [FreeSurfer](https://github.com/freesurfer/freesurfer) | In progress | [`7.4.1`](https://hub.docker.com/r/freesurfer/freesurfer) | 2/104 (1.9%) |
+| [Greedy](https://sites.google.com/view/greedyreg/about) | In progress | [`1.0.1`](https://hub.docker.com/r/pyushkevich/itksnap) | 1/1 (100% 🎉) |
+| [MRTrix3](https://www.mrtrix.org/) | Testing | [`3.0.4`](https://hub.docker.com/r/mrtrix3/mrtrix3) | 116/125 (92.8%) |
+| [NiftyReg](http://cmictig.cs.ucl.ac.uk/wiki/index.php/NiftyReg) | In progress | [`1.4.0`](https://hub.docker.com/r/vnmd/niftyreg_1.4.0) | 7/7 (100% 🎉) |
+
+<!-- END_PACKAGES_TABLE -->
+
+## 🛠 Usage Examples
+
+Usage examples and tutorials can be found in the [Styx book](https://childmindresearch.github.io/styxbook/).
+
+## 🔧 Development
+
+All code in this package is automatically generated by [Styx](https://github.com/childmindresearch/styx).
+
+## 📚 Documentation
+
+For full documentation, visit our [docs site](https://childmindresearch.github.io/niwrap/niwrap.html).
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contribution Guide](https://github.com/childmindresearch/niwrap/blob/main/CONTRIBUTING.md) 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](https://childmindresearch.github.io/styxbook/) 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](https://github.com/childmindresearch/niwrap).
+

niwrap-0.1.0/README.md

@@ -0,0 +1,83 @@
+> **⚠️ 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
+
+[![Build](https://github.com/childmindresearch/niwrap/actions/workflows/compile.yml/badge.svg?branch=main)](https://github.com/childmindresearch/niwrap/actions/workflows/compile.yml?query=branch%3Amain)
+![stability-stable](https://img.shields.io/badge/stability-experimental-red.svg)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/niwrap/blob/main/LICENSE)
+[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/niwrap)
+
+## 🚀 Quick Start
+
+```python
+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:
+
+```bash
+pip install niwrap
+```
+
+Or install the development version:
+
+```bash
+pip install -e "git+https://github.com/childmindresearch/niwrap.git/#egg=niwrap&subdirectory=python"
+```
+
+## 🧰 Supported Tools
+
+<!-- START_PACKAGES_TABLE -->
+
+| Package | Status | Version | API Coverage |
+| --- | --- | --- | --- |
+| [AFNI](https://afni.nimh.nih.gov/) | In progress | [`24.2.06`](https://hub.docker.com/r/afni/afni_make_build) | 561/621 (90.3%) |
+| [ANTs](https://github.com/ANTsX/ANTs) | In progress | [`2.5.3`](https://hub.docker.com/r/antsx/ants) | 9/120 (7.5%) |
+| [Connectome Workbench](https://github.com/Washington-University/workbench) | Testing | [`1.5.0`](https://hub.docker.com/r/brainlife/connectome_workbench) | 202/202 (100% 🎉) |
+| [Convert3D](http://www.itksnap.org/pmwiki/pmwiki.php?n=Convert3D.Convert3D) | In progress | [`1.1.0`](https://hub.docker.com/r/pyushkevich/itksnap) | 2/4 (50.0%) |
+| [FSL](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki) | In progress | [`6.0.5`](https://hub.docker.com/r/mcin/fsl) | 221/376 (58.8%) |
+| [FreeSurfer](https://github.com/freesurfer/freesurfer) | In progress | [`7.4.1`](https://hub.docker.com/r/freesurfer/freesurfer) | 2/104 (1.9%) |
+| [Greedy](https://sites.google.com/view/greedyreg/about) | In progress | [`1.0.1`](https://hub.docker.com/r/pyushkevich/itksnap) | 1/1 (100% 🎉) |
+| [MRTrix3](https://www.mrtrix.org/) | Testing | [`3.0.4`](https://hub.docker.com/r/mrtrix3/mrtrix3) | 116/125 (92.8%) |
+| [NiftyReg](http://cmictig.cs.ucl.ac.uk/wiki/index.php/NiftyReg) | In progress | [`1.4.0`](https://hub.docker.com/r/vnmd/niftyreg_1.4.0) | 7/7 (100% 🎉) |
+
+<!-- END_PACKAGES_TABLE -->
+
+## 🛠 Usage Examples
+
+Usage examples and tutorials can be found in the [Styx book](https://childmindresearch.github.io/styxbook/).
+
+## 🔧 Development
+
+All code in this package is automatically generated by [Styx](https://github.com/childmindresearch/styx).
+
+## 📚 Documentation
+
+For full documentation, visit our [docs site](https://childmindresearch.github.io/niwrap/niwrap.html).
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contribution Guide](https://github.com/childmindresearch/niwrap/blob/main/CONTRIBUTING.md) 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](https://childmindresearch.github.io/styxbook/) 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](https://github.com/childmindresearch/niwrap).

niwrap-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "niwrap"
+version = "0.1.0"
+description = "Neuroimaging Python wrappers."
+authors = ["Child Mind Institute <cmi-dair@childmind.org>"]
+license = "LGPL-2.1"
+readme = "README.md"
+packages = [{include = "niwrap", from = "src"}]
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+styxdefs = "^0.2.0"
+
+[tool.poetry.group.docs.dependencies]
+pdoc = "^14.5.0"
+
+[build-system]
+requires = ["poetry-core>=1.2.0"]
+build-backend = "poetry.core.masonry.api"

niwrap-0.1.0/src/niwrap/__init__.py

@@ -0,0 +1 @@
+""".. include:: ../../README.md"""