# NiBabel

### Access a cacophony of neuro-imaging file formats

# NiBabel

Read and write access to common neuroimaging file formats, including: ANALYZE (plain, SPM99, SPM2 and later), GIFTI, NIfTI1, NIfTI2, CIFTI-2, MINC1, MINC2, AFNI BRIK/HEAD, ECAT and Philips PAR/REC. In addition, NiBabel also supports FreeSurfer’s MGH, geometry, annotation and morphometry files, and provides some limited support for DICOM.

NiBabel’s API gives full or selective access to header information (metadata), and image data is made available via NumPy arrays. For more information, see NiBabel’s documentation site and API reference.

## Installation

To install NiBabel’s current release with `pip`, run:

    pip install nibabel

To install the latest development version, run:

    pip install git+https://github.com/nipy/nibabel

When working on NiBabel itself, it may be useful to install in “editable” mode:

    git clone https://github.com/nipy/nibabel.git
    pip install -e ./nibabel

For more information on previous releases, see the release archive or development changelog.

## Testing

During development, we recommend using tox to run nibabel tests:

    git clone https://github.com/nipy/nibabel.git
    cd nibabel
    tox

To test an installed version of nibabel, install the test dependencies and run pytest_:

    pip install nibabel[test]
    pytest --pyargs nibabel

For more information, consult the developer guidelines.

## Mailing List

Please send any questions or suggestions to the neuroimaging mailing list.

## License

NiBabel is licensed under the terms of the MIT license. Some code included with NiBabel is licensed under the BSD license. For more information, please see the COPYING file.

## Citation

NiBabel releases have a Zenodo Digital Object Identifier (DOI) badge at the top of the release notes. Click on the badge for more information.

## Documentation

- User Documentation (manual)

- Tutorials (relevant tutorials on imaging)

- API Documentation (comprehensive reference)

- Developer Guidelines (for those who want to contribute)

- Development Changelog (see what has changed)

- DICOM concepts (details about implementing DICOM reading)

- Index (access by keywords)

- Search Page (online and offline full-text search)

See also the Developer documentation page for development discussions, release procedure and more.

## Authors and Contributors

Most work on NiBabel so far has been by Matthew Brett, Chris Markiewicz, Michael Hanke, Marc-Alexandre Côté, Ben Cipollini, Paul McCarthy and Chris Cheng. The authors are grateful to the following people who have contributed code and discussion (in rough order of appearance):

- Yaroslav O. Halchenko

- Chris Burns

- Gaël Varoquaux

- Ian Nimmo-Smith

- Jarrod Millman

- Bertrand Thirion

- Thomas Ballinger

- Cindee Madison

- Valentin Haenel

- Alexandre Gramfort

- Christian Haselgrove

- Krish Subramaniam

- Yannick Schwartz

- Bago Amirbekian

- Brendan Moloney

- Félix C. Morency

- JB Poline

- Basile Pinsard

- Satrajit Ghosh

- Eric Larson

- Nolan Nichols

- Ly Nguyen

- Philippe Gervais

- Demian Wassermann

- Justin Lecher

- Oliver P. Hinds

- Nikolaas N. Oosterhof

- Kevin S. Hahn

- Michiel Cottaar

- Erik Kastman

- Github user `freec84`

- Peter Fischer

- Clemens C. C. Bauer

- Samuel St-Jean

- Gregory R. Lee

- Eric M. Baker

- Ariel Rokem

- Eleftherios Garyfallidis

- Jaakko Leppäkangas

- Syam Gadde

- Robert D. Vincent

- Ivan Gonzalez

- Demian Wassermann

- Paul McCarthy

- Fernando Pérez García

- Venky Reddy

- Mark Hymers

- Jasper J.F. van den Bosch

- Bennet Fauber

- Kesshi Jordan

- Jon Stutters

- Serge Koudoro

- Christopher P. Cheng

- Mathias Goncalves

- Jakub Kaczmarzyk

- Dimitri Papadopoulos Orfanos

- Ross Markello

- Miguel Estevan Moreno

- Thomas Roos

- Igor Solovey

- Jon Haitz Legarreta Gorroño

- Katrin Leinweber

- Soichi Hayashi

- Samir Reddigari

- Konstantinos Raktivan

- Matt Cieslak

- Egor Panfilov

- Jath Palasubramaniam

- Henry Braun

- Oscar Esteban

- Cameron Riddell

- Hao-Ting Wang

- Dorota Jarecka

- Chris Gorgolewski

- Benjamin C Darwin

- Zvi Baratz

- Roberto Guidotti

- Or Duek

- Anibal Sólon

- Jonathan Daniel

- Markéta Calábková

- Carl Gauthier

- Julian Klug

- Lea Waller

- Tomáš Hrnčiar

- Andrew Van

- Jérôme Dockès

- Jacob Roberts

- Horea Christian

- Fabian Perez

- Mathieu Scheltienne

- Reinder Vos de Wael

- Peter Suter

- Blake Dewey

- Guillaume Becq

- Joshua Newton

- Sandro from the Fedora Project

## License reprise

NiBabel is free-software (beer and speech) and covered by the MIT License. This applies to all source code, documentation, examples and snippets inside the source distribution (including this website). Please see the appendix of the manual for the copyright statement and the full text of the license.

## Download and Installation

Please find detailed download and installation instructions in the manual.

## Support

If you have problems installing the software or questions about usage, documentation or anything else related to NiBabel, you can post to the NiPy mailing list.

Mailing list:

  neuroimaging@python.org [subscription, archive]

We recommend that anyone using NiBabel subscribes to the mailing list. The mailing list is the preferred way to announce changes and additions to the project. You can also search the mailing list archive using the mailing list archive search located in the sidebar of the NiBabel home page.