Metadata-Version: 2.4
Name: nibabies-wrapper
Version: 25.2.0
Summary: A wrapper for generating Docker and Apptainer/Singularity commands for simpler NiBabies usage
Project-URL: Documentation, https://nibabies.readthedocs.io/en/latest/
Project-URL: Source Code, https://github.com/nipreps/nibabies
Project-URL: Bug Tracker, https://github.com/nipreps/nibabies/issues
Project-URL: Docker Images, https://hub.docker.com/r/nipreps/nibabies
Project-URL: NiPreps, https://www.nipreps.org/
Author-email: The NiPreps Developers <nipreps@gmail.com>
License: Copyright (c) 2015-2023, the Nipreps developers.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of nibabies nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Requires-Python: >=2.7
Description-Content-Type: text/x-rst

The NiBabies Docker/Singularity wrapper
---------------------------------------

NiBabies is a functional magnetic resonance image pre-processing pipeline
optimized for infant and neonate MRI. It is designed to provide an easily
accessible, state-of-the-art interface that is robust to differences in
scan acquisition protocols and that requires minimal user input, while
providing easily interpretable and comprehensive error and output reporting.

This is a Python wrapper to run NiBabies.
It generates the appropriate Docker or Singularity commands, providing an
intuitive interface to running the fMRIPrep workflow in whichever environment.
Docker or Singularity must be installed, and in the case of Docker, running.
Installations can be check by running ::

  docker info  # Docker
  singularity version  # Singularity

Please report any feedback to our `GitHub repository
<https://github.com/nipreps/nibabies>`_ and do not
forget to `credit <https://fmriprep.readthedocs.io/en/latest/citing.html>`_ all
the authors of software that NiBabies uses.


Usage
-----

Example Docker usage ::

  nibabies-wrapper docker <data-path> <output-path> participant <nibabies-arguments>

Example Singularity usage ::

  nibabies-wrapper singularity <data-path> <output-path> participant -i <img-path> <nibabies-arguments>
