Skip to content

Commit 625c75b

Browse files
ZviBaratzZviBaratz
committed
Copied README content to long_description
1 parent 08187d5 commit 625c75b

File tree

2 files changed

+122
-63
lines changed

2 files changed

+122
-63
lines changed

‎README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. -*- rest -*-
22
.. vim:syntax=rst
33
4-
.. Following contents should be copied from LONG_DESCRIPTION in NiBabel/info.py
4+
.. Following contents should be copied from LONG_DESCRIPTION in nibabel/info.py
55
66
.. image:: doc/pics/logo.png
77
:target: https://nipy.org/nibabel

‎nibabel/info.py

Lines changed: 121 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -12,86 +12,145 @@
1212
# We also include this text in the docs by ``..include::`` in
1313
# ``docs/source/index.rst``.
1414
long_description = """
15-
=======
16-
NiBabel
17-
=======
15+
.. image:: doc/pics/logo.png
16+
:target: https://nipy.org/nibabel
17+
:alt: NiBabel logo
1818
19-
Read / write access to some common neuroimaging file formats
19+
Read and write access to common neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
20+
GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_, MINC1_, MINC2_, `AFNI BRIK/HEAD`_, ECAT_ and Philips PAR/REC.
21+
In addition, NiBabel also supports FreeSurfer_'s MGH_, geometry, annotation and morphometry files,
22+
and provides some limited support for DICOM_.
2023
21-
This package provides read +/- write access to some common medical and
22-
neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
23-
GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_, MINC1_, MINC2_, `AFNI BRIK/HEAD`_, MGH_ and
24-
ECAT_ as well as Philips PAR/REC. We can read and write FreeSurfer_ geometry,
25-
annotation and morphometry files. There is some very limited support for
26-
DICOM_. NiBabel is the successor of PyNIfTI_.
24+
NiBabel's API gives full or selective access to header information (metadata), and image
25+
data is made available via NumPy arrays. For more information, see NiBabel's `documentation site`_
26+
and `API reference`_.
2727
28-
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
28+
.. _API reference: https://nipy.org/nibabel/api.html
2929
.. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes
30-
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
31-
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/
30+
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
3231
.. _CIFTI-2: https://www.nitrc.org/projects/cifti/
32+
.. _DICOM: http://medical.nema.org/
33+
.. _documentation site: http://nipy.org/nibabel
34+
.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat
35+
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
36+
.. _GIFTI: https://www.nitrc.org/projects/gifti
37+
.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat
3338
.. _MINC1:
3439
https://en.wikibooks.org/wiki/MINC/Reference/MINC1_File_Format_Reference
3540
.. _MINC2:
3641
https://en.wikibooks.org/wiki/MINC/Reference/MINC2.0_File_Format_Reference
37-
.. _PyNIfTI: http://niftilib.sourceforge.net/pynifti/
38-
.. _GIFTI: https://www.nitrc.org/projects/gifti
39-
.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat
40-
.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat
41-
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
42-
.. _DICOM: http://medical.nema.org/
43-
44-
The various image format classes give full or selective access to header
45-
(meta) information and access to the image data is made available via NumPy
46-
arrays.
47-
48-
Website
49-
=======
50-
51-
Current documentation on nibabel can always be found at the `NIPY nibabel
52-
website <http://nipy.org/nibabel>`_.
42+
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
43+
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/
5344
54-
Mailing Lists
55-
=============
45+
.. list-table::
46+
:widths: 20 80
47+
:header-rows: 0
48+
49+
* - Code
50+
-
51+
.. image:: https://img.shields.io/pypi/pyversions/nibabel.svg
52+
:target: https://pypi.python.org/pypi/nibabel/
53+
:alt: PyPI - Python Version
54+
.. image:: https://img.shields.io/badge/code%20style-blue-blue.svg
55+
:target: https://blue.readthedocs.io/en/latest/
56+
:alt: code style: blue
57+
.. image:: https://img.shields.io/badge/imports-isort-1674b1
58+
:target: https://pycqa.github.io/isort/
59+
:alt: imports: isort
60+
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
61+
:target: https://github.com/pre-commit/pre-commit
62+
:alt: pre-commit
63+
64+
* - Tests
65+
-
66+
.. image:: https://github.com/nipy/NiBabel/actions/workflows/stable.yml/badge.svg
67+
:target: https://github.com/nipy/NiBabel/actions/workflows/stable.yml
68+
:alt: stable tests
69+
.. image:: https://codecov.io/gh/nipy/NiBabel/branch/master/graph/badge.svg
70+
:target: https://codecov.io/gh/nipy/NiBabel
71+
:alt: codecov badge
72+
73+
* - PyPI
74+
-
75+
.. image:: https://img.shields.io/pypi/v/nibabel.svg
76+
:target: https://pypi.python.org/pypi/nibabel/
77+
:alt: PyPI version
78+
.. image:: https://img.shields.io/pypi/dm/nibabel.svg
79+
:target: https://pypistats.org/packages/nibabel
80+
:alt: PyPI - Downloads
81+
82+
* - Packages
83+
-
84+
.. image:: https://img.shields.io/conda/vn/conda-forge/nibabel
85+
:target: https://anaconda.org/conda-forge/nibabel
86+
:alt: Conda package
87+
.. image:: https://repology.org/badge/version-for-repo/debian_unstable/nibabel.svg?header=Debian%20Unstable
88+
:target: https://repology.org/project/nibabel/versions
89+
:alt: Debian Unstable package
90+
.. image:: https://repology.org/badge/version-for-repo/aur/python:nibabel.svg?header=Arch%20%28%41%55%52%29
91+
:target: https://repology.org/project/python:nibabel/versions
92+
:alt: Arch (AUR)
93+
.. image:: https://repology.org/badge/version-for-repo/gentoo_ovl_science/nibabel.svg?header=Gentoo%20%28%3A%3Ascience%29
94+
:target: https://repology.org/project/nibabel/versions
95+
:alt: Gentoo (::science)
96+
.. image:: https://repology.org/badge/version-for-repo/nix_unstable/python:nibabel.svg?header=nixpkgs%20unstable
97+
:target: https://repology.org/project/python:nibabel/versions
98+
:alt: nixpkgs unstable
99+
100+
* - License & DOI
101+
-
102+
.. image:: https://img.shields.io/pypi/l/nibabel.svg
103+
:target: https://github.com/nipy/nibabel/blob/master/COPYING
104+
:alt: License
105+
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.591597.svg
106+
:target: https://doi.org/10.5281/zenodo.591597
107+
:alt: Zenodo DOI
108+
109+
Installation
110+
============
111+
112+
To install NiBabel's `current release`_ with ``pip``, run::
113+
114+
pip install nibabel
115+
116+
To install the latest development version, run::
117+
118+
pip install git+https://github.com/nipy/nibabel
119+
120+
When working on NiBabel itself, it may be useful to install in "editable" mode::
121+
122+
git clone https://github.com/nipy/nibabel.git
123+
pip install -e ./nibabel
124+
125+
For more information on previous releases, see the `release archive`_ or `development changelog`_.
126+
127+
.. _current release: https://pypi.python.org/pypi/NiBabel
128+
.. _release archive: https://github.com/nipy/NiBabel/releases
129+
.. _development changelog: https://nipy.org/nibabel/changelog.html
130+
131+
Mailing List
132+
============
56133
57134
Please send any questions or suggestions to the `neuroimaging mailing list
58135
<https://mail.python.org/mailman/listinfo/neuroimaging>`_.
59136
60-
Code
61-
====
62-
63-
Install nibabel with::
64-
65-
pip install nibabel
66-
67-
You may also be interested in:
68-
69-
* the `nibabel code repository`_ on Github;
70-
* documentation_ for all releases and current development tree;
71-
* download the `current release`_ from pypi;
72-
* download `current development version`_ as a zip file;
73-
* downloads of all `available releases`_.
74-
75-
.. _nibabel code repository: https://github.com/nipy/nibabel
76-
.. _Documentation: http://nipy.org/nibabel
77-
.. _current release: https://pypi.python.org/pypi/nibabel
78-
.. _current development version: https://github.com/nipy/nibabel/archive/master.zip
79-
.. _available releases: https://github.com/nipy/nibabel/releases
80-
81137
License
82138
=======
83139
84-
Nibabel is licensed under the terms of the MIT license. Some code included
85-
with nibabel is licensed under the BSD license. Please see the COPYING file
86-
in the nibabel distribution.
140+
NiBabel is licensed under the terms of the `MIT license`_. Some code included
141+
with NiBabel is licensed under the `BSD license`_. For more information,
142+
please see the COPYING_ file.
87143
88-
Citing nibabel
89-
==============
144+
.. _BSD license: https://opensource.org/licenses/BSD-3-Clause
145+
.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING
146+
.. _MIT license: https://github.com/nipy/nibabel/blob/master/COPYING#nibabel
90147
91-
Please see the `available releases`_ for the release of nibabel that you are
92-
using. Recent releases have a Zenodo_ `Digital Object Identifier`_ badge at
93-
the top of the release notes. Click on the badge for more information.
148+
Citation
149+
========
150+
151+
NiBabel releases have a Zenodo_ `Digital Object Identifier`_ (DOI) badge at
152+
the top of the release notes. Click on the badge for more information.
94153
95-
.. _zenodo: https://zenodo.org
96154
.. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier
97-
"""
155+
.. _zenodo: https://zenodo.org
156+
""" # noqa: E501

0 commit comments

Comments
 (0)