Skip to content

Commit c56bcfe

Browse files
committed
MAINT: update README
Update README source in info.py and refresh in README.rst
1 parent dec5012 commit c56bcfe

File tree

2 files changed

+41
-31
lines changed

2 files changed

+41
-31
lines changed

README.rst

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Read / write access to some common neuroimaging file formats
1616
This package provides read +/- write access to some common medical and
1717
neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
1818
GIFTI_, NIfTI1_, NIfTI2_, MINC1_, MINC2_, MGH_ and ECAT_ as well as Philips
19-
PAR/REC. We can read and write Freesurfer_ geometry, and read Freesurfer
20-
morphometry and annotation files. There is some very limited support for
21-
DICOM_. NiBabel is the successor of PyNIfTI_.
19+
PAR/REC. We can read and write FreeSurfer_ geometry, annotation and
20+
morphometry files. There is some very limited support for DICOM_. NiBabel is
21+
the successor of PyNIfTI_.
2222

2323
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
2424
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
@@ -34,8 +34,9 @@ DICOM_. NiBabel is the successor of PyNIfTI_.
3434
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
3535
.. _DICOM: http://medical.nema.org/
3636

37-
The various image format classes give full or selective access to header (meta)
38-
information and access to the image data is made available via NumPy arrays.
37+
The various image format classes give full or selective access to header
38+
(meta) information and access to the image data is made available via NumPy
39+
arrays.
3940

4041
Website
4142
=======
@@ -52,15 +53,19 @@ Please send any questions or suggestions to the `neuroimaging mailing list
5253
Code
5354
====
5455

55-
You can find our sources and single-click downloads:
56+
Install nibabel with::
5657

57-
* `Main repository`_ on Github;
58-
* Documentation_ for all releases and current development tree;
59-
* Download the `current release`_ from pypi;
60-
* Download `current development version`_ as a zip file;
61-
* Downloads of all `available releases`_.
58+
pip install nibabel
6259

63-
.. _main repository: https://github.com/nipy/nibabel
60+
You may also be interested in:
61+
62+
* the `nibabel code repository`_ on Github;
63+
* documentation_ for all releases and current development tree;
64+
* download the `current release`_ from pypi;
65+
* download `current development version`_ as a zip file;
66+
* downloads of all `available releases`_.
67+
68+
.. _nibabel code repository: https://github.com/nipy/nibabel
6469
.. _Documentation: http://nipy.org/nibabel
6570
.. _current release: https://pypi.python.org/pypi/nibabel
6671
.. _current development version: https://github.com/nipy/nibabel/archive/master.zip
@@ -69,6 +74,6 @@ You can find our sources and single-click downloads:
6974
License
7075
=======
7176

72-
Nibabel is licensed under the terms of the MIT license. Some code included with
73-
nibabel is licensed under the BSD license. Please see the COPYING file in the
74-
nibabel distribution.
77+
Nibabel is licensed under the terms of the MIT license. Some code included
78+
with nibabel is licensed under the BSD license. Please see the COPYING file
79+
in the nibabel distribution.

nibabel/info.py

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@
4444
This package provides read +/- write access to some common medical and
4545
neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
4646
GIFTI_, NIfTI1_, NIfTI2_, MINC1_, MINC2_, MGH_ and ECAT_ as well as Philips
47-
PAR/REC. We can read and write Freesurfer_ geometry, and read Freesurfer
48-
morphometry and annotation files. There is some very limited support for
49-
DICOM_. NiBabel is the successor of PyNIfTI_.
47+
PAR/REC. We can read and write FreeSurfer_ geometry, annotation and
48+
morphometry files. There is some very limited support for DICOM_. NiBabel is
49+
the successor of PyNIfTI_.
5050
5151
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
5252
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
@@ -62,8 +62,9 @@
6262
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
6363
.. _DICOM: http://medical.nema.org/
6464
65-
The various image format classes give full or selective access to header (meta)
66-
information and access to the image data is made available via NumPy arrays.
65+
The various image format classes give full or selective access to header
66+
(meta) information and access to the image data is made available via NumPy
67+
arrays.
6768
6869
Website
6970
=======
@@ -80,15 +81,19 @@
8081
Code
8182
====
8283
83-
You can find our sources and single-click downloads:
84+
Install nibabel with::
8485
85-
* `Main repository`_ on Github;
86-
* Documentation_ for all releases and current development tree;
87-
* Download the `current release`_ from pypi;
88-
* Download `current development version`_ as a zip file;
89-
* Downloads of all `available releases`_.
86+
pip install nibabel
9087
91-
.. _main repository: https://github.com/nipy/nibabel
88+
You may also be interested in:
89+
90+
* the `nibabel code repository`_ on Github;
91+
* documentation_ for all releases and current development tree;
92+
* download the `current release`_ from pypi;
93+
* download `current development version`_ as a zip file;
94+
* downloads of all `available releases`_.
95+
96+
.. _nibabel code repository: https://github.com/nipy/nibabel
9297
.. _Documentation: http://nipy.org/nibabel
9398
.. _current release: https://pypi.python.org/pypi/nibabel
9499
.. _current development version: https://github.com/nipy/nibabel/archive/master.zip
@@ -97,9 +102,9 @@
97102
License
98103
=======
99104
100-
Nibabel is licensed under the terms of the MIT license. Some code included with
101-
nibabel is licensed under the BSD license. Please see the COPYING file in the
102-
nibabel distribution.
105+
Nibabel is licensed under the terms of the MIT license. Some code included
106+
with nibabel is licensed under the BSD license. Please see the COPYING file
107+
in the nibabel distribution.
103108
"""
104109

105110
# versions for dependencies. Check these against:
@@ -119,7 +124,7 @@
119124
DOWNLOAD_URL = "https://github.com/nipy/nibabel"
120125
LICENSE = "MIT license"
121126
CLASSIFIERS = CLASSIFIERS
122-
AUTHOR = "Matthew Brett, Michael Hanke, Stephan Gerhard"
127+
AUTHOR = "nibabel developers"
123128
AUTHOR_EMAIL = "neuroimaging@python.org"
124129
PLATFORMS = "OS Independent"
125130
MAJOR = _version_major

0 commit comments

Comments
 (0)