Metadata-Version: 2.4
Name: neurodocker
Version: 2.0.3
Summary: A generic generator of Dockerfiles and Singularity recipes.
Project-URL: Development, https://github.com/repronim/neurodocker
Project-URL: Homepage, https://www.repronim.org/neurodocker/
Author: Neurodocker Developers
Maintainer-email: Jakub Kaczmarzyk <jakub.kaczmarzyk@gmail.com>
License: Apache License, 2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Requires-Dist: click
Requires-Dist: etelemetry>=0.2.0
Requires-Dist: jinja2>=2.0
Requires-Dist: jsonschema>=3.0
Requires-Dist: mypy-extensions
Requires-Dist: pyyaml>=5.0
Requires-Dist: typing-extensions
Provides-Extra: all
Requires-Dist: codecov; extra == 'all'
Requires-Dist: coverage[toml]; extra == 'all'
Requires-Dist: docker>=4.4.1; extra == 'all'
Requires-Dist: pre-commit; extra == 'all'
Requires-Dist: pydata-sphinx-theme>=0.13; extra == 'all'
Requires-Dist: pytest-cov>=2.0.0; extra == 'all'
Requires-Dist: pytest-reportlog>=0.1.2; extra == 'all'
Requires-Dist: pytest-xdist>=2.2.0; extra == 'all'
Requires-Dist: pytest>=6.0; extra == 'all'
Requires-Dist: sphinx<7; extra == 'all'
Requires-Dist: sphinxcontrib-apidoc>=0.3; extra == 'all'
Provides-Extra: dev
Requires-Dist: codecov; extra == 'dev'
Requires-Dist: coverage[toml]; extra == 'dev'
Requires-Dist: docker>=4.4.1; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest-cov>=2.0.0; extra == 'dev'
Requires-Dist: pytest-reportlog>=0.1.2; extra == 'dev'
Requires-Dist: pytest-xdist>=2.2.0; extra == 'dev'
Requires-Dist: pytest>=6.0; extra == 'dev'
Provides-Extra: doc
Requires-Dist: pydata-sphinx-theme>=0.13; extra == 'doc'
Requires-Dist: sphinx<7; extra == 'doc'
Requires-Dist: sphinxcontrib-apidoc>=0.3; extra == 'doc'
Provides-Extra: minify
Requires-Dist: docker>=4.4.1; extra == 'minify'
Description-Content-Type: text/markdown

# Neurodocker

[![build status](https://github.com/ReproNim/neurodocker/actions/workflows/pull-request.yml/badge.svg)](https://github.com/ReproNim/neurodocker/actions/workflows/pull-request.yml)
[![docker pulls](https://img.shields.io/docker/pulls/repronim/neurodocker.svg)](https://hub.docker.com/r/repronim/neurodocker/)
[![python versions](https://img.shields.io/pypi/pyversions/neurodocker.svg)](https://pypi.org/project/neurodocker/)
[![DOI](https://zenodo.org/badge/88654995.svg)](https://zenodo.org/badge/latestdoi/88654995)

_Neurodocker_ is a command-line program that generates custom Dockerfiles and Singularity recipes for neuroimaging and minifies existing containers.

Please see our website https://www.repronim.org/neurodocker for more information.

See our [list of supported software](https://www.repronim.org/neurodocker/user_guide/examples.html#supported-software)

## Build status

You can check the status of the build of the Docker images
for several of the neuroimaging software packages that are supported by _Neurodocker_
on [this page](https://github.com/ReproNim/neurodocker/blob/test_docker_build/docs/README.md). This may help with identifying base images that work well for your
use case.

# Installation

Use the _Neurodocker_ Docker image (recommended):

```shell
docker run --rm repronim/neurodocker:latest --help
```

The Docker images were moved to [repronim/neurodocker](https://hub.docker.com/r/repronim/neurodocker) from [kaczmarj/neurodocker](https://hub.docker.com/r/kaczmarj/neurodocker).


This project can also be installed with `pip`:

```shell
pip install neurodocker
neurodocker --help
```

If the `pip install` command above gives a permissions error, install as a non-root user:

```shell
pip install --user neurodocker
```

_Note_: it is not yet possible to minimize Docker containers using the _Neurodocker_ Docker image.


# Developer installation

Clone the repository and install in editable mode.

```
git clone https://github.com/ReproNim/neurodocker
cd neurodocker
python -m pip install --no-cache-dir --editable .[all]
```

Before committing changes, initialize `pre-commit` with `pre-commit install`. This will format code with each commit to keep the style consistent. _Neurodocker_ uses `black` for formatting.
