Skip to content

Commit b4db09c

Browse files
committed
[DOC] Update installation documentation for developers
1 parent 53cf6f8 commit b4db09c

File tree

1 file changed

+34
-25
lines changed

1 file changed

+34
-25
lines changed

doc/users/install.rst

+34-25
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,19 @@
66

77
This page covers the necessary steps to install Nipype.
88

9-
Download
10-
--------
11-
12-
Current release: `<https://github.com/nipy/nipype/releases/latest>`_.
13-
14-
Development version: [`zip <http://github.com/nipy/nipype/zipball/master>`__ `tar.gz
15-
<http://github.com/nipy/nipype/tarball/master>`__]
16-
17-
`Prior downloads <http://github.com/nipy/nipype/tags>`_
18-
19-
To check out the latest development version::
20-
21-
git clone git://github.com/nipy/nipype.git
22-
23-
or::
24-
25-
git clone https://github.com/nipy/nipype.git
26-
27-
Check out the list of nipype's `current dependencies <https://github.com/nipy/nipype/blob/master/requirements.txt>`_.
28-
29-
Install
30-
-------
9+
Nipype for users
10+
----------------
3111

3212
The installation process is similar to other Python packages.
3313

3414
If you already have a Python environment set up, you can do::
3515

36-
easy_install nipype
16+
easy_install nipype
3717

3818
or::
3919

40-
pip install nipype
20+
pip install nipype
21+
4122

4223
Debian and Ubuntu
4324
~~~~~~~~~~~~~~~~~
@@ -52,11 +33,19 @@ Mac OS X
5233
The easiest way to get nipype running on Mac OS X is to install Anaconda_ or
5334
Canopy_ and then add nipype by executing::
5435

55-
easy_install nipype
36+
easy_install nipype
37+
5638

5739
From source
5840
~~~~~~~~~~~
5941

42+
The current release is found here: `<https://github.com/nipy/nipype/releases/latest>`_.
43+
44+
The development version: [`zip <http://github.com/nipy/nipype/zipball/master>`__ `tar.gz
45+
<http://github.com/nipy/nipype/tarball/master>`__]
46+
47+
For previous versions: `prior downloads <http://github.com/nipy/nipype/tags>`_
48+
6049
If you downloaded the source distribution named something
6150
like ``nipype-x.y.tar.gz``, then unpack the tarball, change into the
6251
``nipype-x.y`` directory and install nipype using::
@@ -66,6 +55,26 @@ like ``nipype-x.y.tar.gz``, then unpack the tarball, change into the
6655

6756
**Note:** Depending on permissions you may need to use ``sudo``.
6857

58+
59+
Nipype for developers
60+
---------------------
61+
62+
To check out the latest development version::
63+
64+
git clone git://github.com/nipy/nipype.git
65+
66+
or::
67+
68+
git clone https://github.com/nipy/nipype.git
69+
70+
After cloning::
71+
72+
python setup.py develop
73+
74+
75+
Check out the list of nipype's `current dependencies <https://github.com/nipy/nipype/blob/master/requirements.txt>`_.
76+
77+
6978
Testing the install
7079
-------------------
7180

0 commit comments

Comments
 (0)