@@ -48,11 +48,16 @@ the source from `NiBabel pypi`_ . Go to the pypi page and select the source
4848distribution you want. Download the distribution, unpack it, and then, from
4949the unpacked directory, run::
5050
51- python setup.py install
51+ pip install .
5252
53- or (if you need root permission to install on a unix system)::
53+ If you get permission errors, this may be because ``pip `` is trying to install
54+ to the system directories. You can solve this error by using ``sudo ``, but we
55+ strongly suggest you either do an install into your "user" directories, like
56+ this::
5457
55- sudo python setup.py install
58+ pip install --user .
59+
60+ or you work inside a virtualenv _.
5661
5762.. _install_debian :
5863
@@ -66,60 +71,56 @@ their repositories. Once this is done, installing NiBabel is::
6671 apt-get update
6772 apt-get install python-nibabel
6873
69- Install from source
70- ===================
74+ Install a development version
75+ =============================
7176
72- If no installer or package is provided for your platform, you can install
73- NiBabel from source.
77+ If you want to test the latest development version of nibabel, or you'd like to
78+ help by contributing bug-fixes or new features (excellent!), then this section
79+ is for you.
7480
7581Requirements
7682------------
7783
78- * Python _ 2.6 or greater
79- * NumPy _ 1.5 or greater
80- * SciPy _ (for full SPM-ANALYZE support)
81- * PyDICOM _ 0.9.7 or greater (for DICOM support)
82- * `Python Imaging Library `_ (for PNG conversion in DICOMFS)
83- * nose _ 0.11 or greater (to run the tests)
84- * sphinx _ (to build the documentation)
84+ .. check these against:
85+ nibabel/info.py
86+ requirements.txt
87+ .travis.yml
8588
86- Get the sources
87- ---------------
89+ * Python _ 2.7 or greater
90+ * NumPy _ 1.5 or greater
91+ * SciPy _ (optional, for full SPM-ANALYZE support)
92+ * PyDICOM _ 0.9.7 or greater (optional, for DICOM support)
93+ * `Python Imaging Library `_ (optional, for PNG conversion in DICOMFS)
94+ * nose _ 0.11 or greater (optional, to run the tests)
95+ * sphinx _ (optional, to build the documentation)
8896
89- The latest release is always available from `NiBabel pypi `_.
97+ Get the development sources
98+ ---------------------------
9099
91- Alternatively, you can download a tarball of the latest development snapshot
92- (i.e. the current state of the *master * branch of the NiBabel source code
93- repository) from the `NiBabel github `_ page.
100+ You can download a tarball of the latest development snapshot (i.e. the current
101+ state of the *master * branch of the NiBabel source code repository) from the
102+ `NiBabel github `_ page.
94103
95104If you want to have access to the full NiBabel history and the latest
96- development code, do a full clone (aka checkout) of the NiBabel
105+ development code, do a full clone (AKA checkout) of the NiBabel
97106repository::
98107
99- git clone git://github.com/nipy/nibabel.git
100-
101- or::
102-
103108 git clone https://github.com/nipy/nibabel.git
104109
105- (The first may be faster, the second more likely to work behind a firewall).
106-
107110Installation
108111------------
109112
110113Just install the modules by invoking::
111114
112- sudo python setup.py install
113-
114- If sudo is not configured (or even installed) you might have to use
115- ``su `` instead.
115+ pip install .
116116
117+ See :ref: `install-pypi ` for advice on what to do for permission errors.
117118
118119Validating your install
119120-----------------------
120121
121- For a basic test of your installation, fire up Python and try importing the module to see if everything is fine.
122- It should look something like this::
122+ For a basic test of your installation, fire up Python and try importing the
123+ module to see if everything is fine. It should look something like this::
123124
124125 Python 2.7.8 (v2.7.8:ee879c0ffa11, Jun 29 2014, 21:07:35)
125126 [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
@@ -128,8 +129,10 @@ It should look something like this::
128129 >>>
129130
130131
131- To run the nibabel test suite, from the terminal run ``nosetests nibabel `` or ``python -c "import nibabel; nibabel.test() ``.
132+ To run the nibabel test suite, from the terminal run ``nosetests nibabel `` or
133+ ``python -c "import nibabel; nibabel.test() ``.
132134
133- To run an extended test suite that validates ``nibabel `` for long-running and resource-intensive cases, please see :ref: `advanced_testing `.
135+ To run an extended test suite that validates ``nibabel `` for long-running and
136+ resource-intensive cases, please see :ref: `advanced_testing `.
134137
135138.. include :: links_names.txt
0 commit comments