nibabel


Namenibabel JSON
Version 5.2.1 PyPI version JSON
download
home_page
SummaryAccess a multitude of neuroimaging data formats
upload_time2024-02-27 04:13:19
maintainerChristopher Markiewicz
docs_urlNone
author
requires_python>=3.8
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage
            .. -*- rest -*-
.. vim:syntax=rst

.. Use raw location to ensure image shows up on PyPI
.. image:: https://raw.githubusercontent.com/nipy/nibabel/master/doc/pics/logo.png
   :target: https://nipy.org/nibabel
   :alt: NiBabel logo

.. list-table::
   :widths: 20 80
   :header-rows: 0

   * - Code
     -
      .. image:: https://img.shields.io/pypi/pyversions/nibabel.svg
         :target: https://pypi.python.org/pypi/nibabel/
         :alt: PyPI - Python Version
      .. image:: https://img.shields.io/badge/code%20style-blue-blue.svg
         :target: https://blue.readthedocs.io/en/latest/
         :alt: code style: blue
      .. image:: https://img.shields.io/badge/imports-isort-1674b1
         :target: https://pycqa.github.io/isort/
         :alt: imports: isort
      .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
         :target: https://github.com/pre-commit/pre-commit
         :alt: pre-commit

   * - Tests
     -
      .. image:: https://github.com/nipy/NiBabel/actions/workflows/stable.yml/badge.svg
         :target: https://github.com/nipy/NiBabel/actions/workflows/stable.yml
         :alt: stable tests
      .. image:: https://codecov.io/gh/nipy/NiBabel/branch/master/graph/badge.svg
         :target: https://codecov.io/gh/nipy/NiBabel
         :alt: codecov badge

   * - PyPI
     -
      .. image:: https://img.shields.io/pypi/v/nibabel.svg
         :target: https://pypi.python.org/pypi/nibabel/
         :alt: PyPI version
      .. image:: https://img.shields.io/pypi/dm/nibabel.svg
         :target: https://pypistats.org/packages/nibabel
         :alt: PyPI - Downloads

   * - Packages
     -
      .. image:: https://img.shields.io/conda/vn/conda-forge/nibabel
         :target: https://anaconda.org/conda-forge/nibabel
         :alt: Conda package
      .. image:: https://repology.org/badge/version-for-repo/debian_unstable/nibabel.svg?header=Debian%20Unstable
         :target: https://repology.org/project/nibabel/versions
         :alt: Debian Unstable package
      .. image:: https://repology.org/badge/version-for-repo/aur/python:nibabel.svg?header=Arch%20%28%41%55%52%29
         :target: https://repology.org/project/python:nibabel/versions
         :alt: Arch (AUR)
      .. image:: https://repology.org/badge/version-for-repo/gentoo_ovl_science/nibabel.svg?header=Gentoo%20%28%3A%3Ascience%29
         :target: https://repology.org/project/nibabel/versions
         :alt: Gentoo (::science)
      .. image:: https://repology.org/badge/version-for-repo/nix_unstable/python:nibabel.svg?header=nixpkgs%20unstable
         :target: https://repology.org/project/python:nibabel/versions
         :alt: nixpkgs unstable

   * - License & DOI
     -
      .. image:: https://img.shields.io/pypi/l/nibabel.svg
         :target: https://github.com/nipy/nibabel/blob/master/COPYING
         :alt: License
      .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.591597.svg
         :target: https://doi.org/10.5281/zenodo.591597
         :alt: Zenodo DOI

.. Following contents should be copied from LONG_DESCRIPTION in nibabel/info.py


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`_.

.. _API reference: https://nipy.org/nibabel/api.html
.. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
.. _CIFTI-2: https://www.nitrc.org/projects/cifti/
.. _DICOM: http://medical.nema.org/
.. _documentation site: http://nipy.org/nibabel
.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
.. _GIFTI: https://www.nitrc.org/projects/gifti
.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat
.. _MINC1:
    https://en.wikibooks.org/wiki/MINC/Reference/MINC1_File_Format_Reference
.. _MINC2:
    https://en.wikibooks.org/wiki/MINC/Reference/MINC2.0_File_Format_Reference
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/

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`_.

.. _current release: https://pypi.python.org/pypi/NiBabel
.. _release archive: https://github.com/nipy/NiBabel/releases
.. _development changelog: https://nipy.org/nibabel/changelog.html

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`_.

.. _tox: https://tox.wiki
.. _pytest: https://docs.pytest.org
.. _developer guidelines: https://nipy.org/nibabel/devel/devguide.html

Mailing List
============

Please send any questions or suggestions to the `neuroimaging mailing list
<https://mail.python.org/mailman/listinfo/neuroimaging>`_.

License
=======

NiBabel is licensed under the terms of the `MIT license
<https://github.com/nipy/nibabel/blob/master/COPYING#nibabel>`__.
Some code included with NiBabel is licensed under the `BSD license`_.
For more information, please see the COPYING_ file.

.. _BSD license: https://opensource.org/licenses/BSD-3-Clause
.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING

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.

.. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier
.. _zenodo: https://zenodo.org

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "nibabel",
    "maintainer": "Christopher Markiewicz",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "NiBabel developers <neuroimaging@python.org>",
    "download_url": "https://files.pythonhosted.org/packages/9d/d2/da723207ba389c9d6b6d55f21dbbba8d24c08f846c42832a69d8fdbb97da/nibabel-5.2.1.tar.gz",
    "platform": null,
    "description": ".. -*- rest -*-\n.. vim:syntax=rst\n\n.. Use raw location to ensure image shows up on PyPI\n.. image:: https://raw.githubusercontent.com/nipy/nibabel/master/doc/pics/logo.png\n   :target: https://nipy.org/nibabel\n   :alt: NiBabel logo\n\n.. list-table::\n   :widths: 20 80\n   :header-rows: 0\n\n   * - Code\n     -\n      .. image:: https://img.shields.io/pypi/pyversions/nibabel.svg\n         :target: https://pypi.python.org/pypi/nibabel/\n         :alt: PyPI - Python Version\n      .. image:: https://img.shields.io/badge/code%20style-blue-blue.svg\n         :target: https://blue.readthedocs.io/en/latest/\n         :alt: code style: blue\n      .. image:: https://img.shields.io/badge/imports-isort-1674b1\n         :target: https://pycqa.github.io/isort/\n         :alt: imports: isort\n      .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n         :target: https://github.com/pre-commit/pre-commit\n         :alt: pre-commit\n\n   * - Tests\n     -\n      .. image:: https://github.com/nipy/NiBabel/actions/workflows/stable.yml/badge.svg\n         :target: https://github.com/nipy/NiBabel/actions/workflows/stable.yml\n         :alt: stable tests\n      .. image:: https://codecov.io/gh/nipy/NiBabel/branch/master/graph/badge.svg\n         :target: https://codecov.io/gh/nipy/NiBabel\n         :alt: codecov badge\n\n   * - PyPI\n     -\n      .. image:: https://img.shields.io/pypi/v/nibabel.svg\n         :target: https://pypi.python.org/pypi/nibabel/\n         :alt: PyPI version\n      .. image:: https://img.shields.io/pypi/dm/nibabel.svg\n         :target: https://pypistats.org/packages/nibabel\n         :alt: PyPI - Downloads\n\n   * - Packages\n     -\n      .. image:: https://img.shields.io/conda/vn/conda-forge/nibabel\n         :target: https://anaconda.org/conda-forge/nibabel\n         :alt: Conda package\n      .. image:: https://repology.org/badge/version-for-repo/debian_unstable/nibabel.svg?header=Debian%20Unstable\n         :target: https://repology.org/project/nibabel/versions\n         :alt: Debian Unstable package\n      .. image:: https://repology.org/badge/version-for-repo/aur/python:nibabel.svg?header=Arch%20%28%41%55%52%29\n         :target: https://repology.org/project/python:nibabel/versions\n         :alt: Arch (AUR)\n      .. image:: https://repology.org/badge/version-for-repo/gentoo_ovl_science/nibabel.svg?header=Gentoo%20%28%3A%3Ascience%29\n         :target: https://repology.org/project/nibabel/versions\n         :alt: Gentoo (::science)\n      .. image:: https://repology.org/badge/version-for-repo/nix_unstable/python:nibabel.svg?header=nixpkgs%20unstable\n         :target: https://repology.org/project/python:nibabel/versions\n         :alt: nixpkgs unstable\n\n   * - License & DOI\n     -\n      .. image:: https://img.shields.io/pypi/l/nibabel.svg\n         :target: https://github.com/nipy/nibabel/blob/master/COPYING\n         :alt: License\n      .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.591597.svg\n         :target: https://doi.org/10.5281/zenodo.591597\n         :alt: Zenodo DOI\n\n.. Following contents should be copied from LONG_DESCRIPTION in nibabel/info.py\n\n\nRead and write access to common neuroimaging file formats, including:\nANALYZE_ (plain, SPM99, SPM2 and later), GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_,\nMINC1_, MINC2_, `AFNI BRIK/HEAD`_, ECAT_ and Philips PAR/REC.\nIn addition, NiBabel also supports FreeSurfer_'s MGH_, geometry, annotation and\nmorphometry files, and provides some limited support for DICOM_.\n\nNiBabel's API gives full or selective access to header information (metadata),\nand image data is made available via NumPy arrays. For more information, see\nNiBabel's `documentation site`_ and `API reference`_.\n\n.. _API reference: https://nipy.org/nibabel/api.html\n.. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes\n.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm\n.. _CIFTI-2: https://www.nitrc.org/projects/cifti/\n.. _DICOM: http://medical.nema.org/\n.. _documentation site: http://nipy.org/nibabel\n.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat\n.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu\n.. _GIFTI: https://www.nitrc.org/projects/gifti\n.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat\n.. _MINC1:\n    https://en.wikibooks.org/wiki/MINC/Reference/MINC1_File_Format_Reference\n.. _MINC2:\n    https://en.wikibooks.org/wiki/MINC/Reference/MINC2.0_File_Format_Reference\n.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/\n.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/\n\nInstallation\n============\n\nTo install NiBabel's `current release`_ with ``pip``, run::\n\n   pip install nibabel\n\nTo install the latest development version, run::\n\n   pip install git+https://github.com/nipy/nibabel\n\nWhen working on NiBabel itself, it may be useful to install in \"editable\" mode::\n\n   git clone https://github.com/nipy/nibabel.git\n   pip install -e ./nibabel\n\nFor more information on previous releases, see the `release archive`_ or\n`development changelog`_.\n\n.. _current release: https://pypi.python.org/pypi/NiBabel\n.. _release archive: https://github.com/nipy/NiBabel/releases\n.. _development changelog: https://nipy.org/nibabel/changelog.html\n\nTesting\n=======\n\nDuring development, we recommend using tox_ to run nibabel tests::\n\n    git clone https://github.com/nipy/nibabel.git\n    cd nibabel\n    tox\n\nTo test an installed version of nibabel, install the test dependencies\nand run pytest_::\n\n    pip install nibabel[test]\n    pytest --pyargs nibabel\n\nFor more information, consult the `developer guidelines`_.\n\n.. _tox: https://tox.wiki\n.. _pytest: https://docs.pytest.org\n.. _developer guidelines: https://nipy.org/nibabel/devel/devguide.html\n\nMailing List\n============\n\nPlease send any questions or suggestions to the `neuroimaging mailing list\n<https://mail.python.org/mailman/listinfo/neuroimaging>`_.\n\nLicense\n=======\n\nNiBabel is licensed under the terms of the `MIT license\n<https://github.com/nipy/nibabel/blob/master/COPYING#nibabel>`__.\nSome code included with NiBabel is licensed under the `BSD license`_.\nFor more information, please see the COPYING_ file.\n\n.. _BSD license: https://opensource.org/licenses/BSD-3-Clause\n.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING\n\nCitation\n========\n\nNiBabel releases have a Zenodo_ `Digital Object Identifier`_ (DOI) badge at\nthe top of the release notes. Click on the badge for more information.\n\n.. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier\n.. _zenodo: https://zenodo.org\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Access a multitude of neuroimaging data formats",
    "version": "5.2.1",
    "project_urls": {
        "Development": "https://github.com/nipy/nibabel",
        "Homepage": "https://nipy.org/nibabel"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "773fce43b8c2ccc4a7913a87c4d425aaf0080ea3abf947587e47dc2025981a17",
                "md5": "0d0cdf169b69069ce383359ee2813ad7",
                "sha256": "2cbbc22985f7f9d39d050df47249771dfb8d48447f5e7a993177e4cabfe047f0"
            },
            "downloads": -1,
            "filename": "nibabel-5.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d0cdf169b69069ce383359ee2813ad7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3296610,
            "upload_time": "2024-02-27T04:13:17",
            "upload_time_iso_8601": "2024-02-27T04:13:17.097200Z",
            "url": "https://files.pythonhosted.org/packages/77/3f/ce43b8c2ccc4a7913a87c4d425aaf0080ea3abf947587e47dc2025981a17/nibabel-5.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9dd2da723207ba389c9d6b6d55f21dbbba8d24c08f846c42832a69d8fdbb97da",
                "md5": "e2c23b89e4bbe497c95687a29999d55f",
                "sha256": "b6c80b2e728e4bc2b65f1142d9b8d2287a9102a8bf8477e115ef0d8334559975"
            },
            "downloads": -1,
            "filename": "nibabel-5.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e2c23b89e4bbe497c95687a29999d55f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4503320,
            "upload_time": "2024-02-27T04:13:19",
            "upload_time_iso_8601": "2024-02-27T04:13:19.595471Z",
            "url": "https://files.pythonhosted.org/packages/9d/d2/da723207ba389c9d6b6d55f21dbbba8d24c08f846c42832a69d8fdbb97da/nibabel-5.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-27 04:13:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nipy",
    "github_project": "nibabel",
    "travis_ci": true,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "nibabel"
}
        
Elapsed time: 0.20789s