1
""" Define distribution parameters for nibabel, including package version
2

3
The long description parameter is used to fill settings in setup.py, the
4
nibabel top-level docstring, and in building the docs.
5
We exec this file in several places, so it cannot import nibabel or use
6
relative imports.
7
"""
8

9
# nibabel version information
10
# This is a fall-back for versioneer when installing from a git archive.
11
# This should be set to the intended next version + dev to indicate a
12
# development (pre-release) version.
13 33
_version_major = 3
14 33
_version_minor = 2
15 33
_version_micro = 0
16 33
_version_extra = 'dev'
17

18
# Format expected by setup.py and doc/source/conf.py: string of form "X.Y.Z"
19 33
VERSION = f"{_version_major}.{_version_minor}.{_version_micro}{_version_extra}"
20

21

22
# Note: this long_description is the canonical place to edit this text.
23
# It also appears in README.rst, but it should get there by running
24
# ``tools/refresh_readme.py`` which pulls in this version.
25
# We also include this text in the docs by ``..include::`` in
26
# ``docs/source/index.rst``.
27 33
long_description = """
28
=======
29
NiBabel
30
=======
31

32
Read / write access to some common neuroimaging file formats
33

34
This package provides read +/- write access to some common medical and
35
neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
36
GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_, MINC1_, MINC2_, `AFNI BRIK/HEAD`_, MGH_ and
37
ECAT_ as well as Philips PAR/REC.  We can read and write FreeSurfer_ geometry,
38
annotation and morphometry files.  There is some very limited support for
39
DICOM_.  NiBabel is the successor of PyNIfTI_.
40

41
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
42
.. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes
43
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
44
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/
45
.. _CIFTI-2: https://www.nitrc.org/projects/cifti/
46
.. _MINC1:
47
    https://en.wikibooks.org/wiki/MINC/Reference/MINC1_File_Format_Reference
48
.. _MINC2:
49
    https://en.wikibooks.org/wiki/MINC/Reference/MINC2.0_File_Format_Reference
50
.. _PyNIfTI: http://niftilib.sourceforge.net/pynifti/
51
.. _GIFTI: https://www.nitrc.org/projects/gifti
52
.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat
53
.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat
54
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
55
.. _DICOM: http://medical.nema.org/
56

57
The various image format classes give full or selective access to header
58
(meta) information and access to the image data is made available via NumPy
59
arrays.
60

61
Website
62
=======
63

64
Current documentation on nibabel can always be found at the `NIPY nibabel
65
website <http://nipy.org/nibabel>`_.
66

67
Mailing Lists
68
=============
69

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

73
Code
74
====
75

76
Install nibabel with::
77

78
    pip install nibabel
79

80
You may also be interested in:
81

82
* the `nibabel code repository`_ on Github;
83
* documentation_ for all releases and current development tree;
84
* download the `current release`_ from pypi;
85
* download `current development version`_ as a zip file;
86
* downloads of all `available releases`_.
87

88
.. _nibabel code repository: https://github.com/nipy/nibabel
89
.. _Documentation: http://nipy.org/nibabel
90
.. _current release: https://pypi.python.org/pypi/nibabel
91
.. _current development version: https://github.com/nipy/nibabel/archive/master.zip
92
.. _available releases: https://github.com/nipy/nibabel/releases
93

94
License
95
=======
96

97
Nibabel is licensed under the terms of the MIT license. Some code included
98
with nibabel is licensed under the BSD license.  Please see the COPYING file
99
in the nibabel distribution.
100

101
Citing nibabel
102
==============
103

104
Please see the `available releases`_ for the release of nibabel that you are
105
using.  Recent releases have a Zenodo_ `Digital Object Identifier`_ badge at
106
the top of the release notes.  Click on the badge for more information.
107

108
.. _zenodo: https://zenodo.org
109
.. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier
110
"""

Read our documentation on viewing source code .

Loading