Skip to content

Commit 707965c

Browse files
committed
DOC: update installation instructions
Prefer pip, forget easy_install
1 parent ff380bd commit 707965c

File tree

2 files changed

+32
-24
lines changed

2 files changed

+32
-24
lines changed

doc/source/installation.rst

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
Installation
1414
************
1515

16-
NiBabel is a pure python package at the moment, and it should be easy to get
16+
NiBabel is a pure Python package at the moment, and it should be easy to get
1717
NiBabel running on any system. For the most popular platforms and operating
1818
systems there should be packages in the respective native packaging format
1919
(DEB, RPM or installers). On other systems you can install NiBabel using
20-
``easy_install`` or by downloading the source package and running the usual
21-
``python setup.py install``.
20+
pip_ or by downloading the source package and running the usual ``python
21+
setup.py install``.
2222

2323
.. This remark below is not yet true; comment to avoid confusion
2424
To run all of the tests, you may need some extra data packages - see
@@ -29,17 +29,23 @@ Installer and packages
2929

3030
.. _install_pypi:
3131

32-
The python package index
33-
------------------------
32+
pip and the Python package index
33+
--------------------------------
3434

35-
NiBabel is available via `pypi`_. If you already have setuptools_ or
36-
distribute_ installed, you can run::
35+
By far the best way to install NiBabel is via pip_. If you don't have pip
36+
already, follow the `pip install instructions`_.
3737

38-
easy_install nibabel
38+
Then open a terminal (Terminal.app on OSX, cmd or Poweshell on Windows), and
39+
type::
3940

40-
to download nibabel and its dependencies. Alternatively go to the `nibabel
41-
pypi`_ page and select the source distribution you want. Download the
42-
distribution, unpack it, and then, from the unpacked directory, run::
41+
pip install nibabel
42+
43+
This will download and install NiBabel.
44+
45+
If you really like doing stuff manually, you can install NiBabel by downoading
46+
the source from `NiBabel pypi`_ . Go to this page and select the source
47+
distribution you want. Download the distribution, unpack it, and then, from
48+
the unpacked directory, run::
4349

4450
python setup.py install
4551

@@ -52,15 +58,13 @@ or (if you need root permission to install on a unix system)::
5258
Debian/Ubuntu
5359
-------------
5460

55-
NiBabel is available as a `NeuroDebian package`_. Please follow the instructions
56-
on the NeuroDebian_ website on how access their repositories. Once this is done,
57-
installing NiBabel is::
61+
Our friendas at NeuroDebian_ have packaged NiBabel at `NiBabel NeuroDebian`_.
62+
Please follow the instructions on the NeuroDebian_ website on how to access
63+
their repositories. Once this is done, installing NiBabel is::
5864

5965
apt-get update
6066
apt-get install python-nibabel
6167

62-
.. _NeuroDebian package: http://neuro.debian.net/pkgs/python-nibabel.html
63-
6468
Install from source
6569
===================
6670

@@ -71,7 +75,7 @@ Requirements
7175
------------
7276

7377
* Python_ 2.6 or greater
74-
* NumPy_ 1.2 or greater
78+
* NumPy_ 1.5 or greater
7579
* SciPy_ (for full SPM-ANALYZE support)
7680
* PyDICOM_ 0.9.7 or greater (for DICOM support)
7781
* `Python Imaging Library`_ (for PNG conversion in DICOMFS)
@@ -81,11 +85,11 @@ Requirements
8185
Get the sources
8286
---------------
8387

84-
The latest release is always available from `nibabel pypi`_.
88+
The latest release is always available from `NiBabel pypi`_.
8589

8690
Alternatively, you can download a tarball of the latest development snapshot
8791
(i.e. the current state of the *master* branch of the NiBabel source code
88-
repository) from the `nibabel github`_ page.
92+
repository) from the `NiBabel github`_ page.
8993

9094
If you want to have access to the full NiBabel history and the latest
9195
development code, do a full clone (aka checkout) of the NiBabel
@@ -95,9 +99,9 @@ repository::
9599

96100
or::
97101

98-
git clone http://github.com/nipy/nibabel.git
102+
git clone https://github.com/nipy/nibabel.git
99103

100-
(The first will be faster, the second more likely to work behind a firewall).
104+
(The first may be faster, the second more likely to work behind a firewall).
101105

102106
Installation
103107
------------
@@ -110,10 +114,9 @@ If sudo is not configured (or even installed) you might have to use
110114
``su`` instead.
111115

112116
Now fire up Python and try importing the module to see if everything is fine.
113-
It should look similar to this::
114-
117+
It should look something like this::
115118

116-
Python 2.7.3 (v2.7.3:70274d53c1dd, Apr 9 2012, 20:52:43)
119+
Python 2.7.8 (v2.7.8:ee879c0ffa11, Jun 29 2014, 21:07:35)
117120
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
118121
Type "help", "copyright", "credits" or "license" for more information.
119122
>>> import nibabel

doc/source/links_names.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,10 @@
9494
.. _networkx: http://networkx.lanl.gov/
9595
.. _setuptools: http://pypi.python.org/pypi/setuptools
9696
.. _distribute: http://packages.python.org/distribute
97+
.. _pip: https://pip.readthedocs.org/en/latest
98+
.. _pip install instructions:
99+
https://pip.readthedocs.org/en/latest/installing.html
100+
.. _twine: https://pypi.python.org/pypi/twine
97101
.. _datapkg: http://okfn.org/projects/datapkg
98102
.. _python imaging library: http://www.pythonware.com
99103

@@ -172,6 +176,7 @@
172176
.. _enthought: <http://www.enthought.com>
173177
.. _kitware: http://www.kitware.com
174178
.. _NeuroDebian: http://neuro.debian.net
179+
.. _nibabel NeuroDebian: http://neuro.debian.net/pkgs/python-nibabel.html
175180
.. _nitrc: http://www.nitrc.org
176181

177182
.. General information links

0 commit comments

Comments
 (0)