##// END OF EJS Templates
Update installation instructions....
Fernando Perez -
Show More
@@ -7,7 +7,6 b" All of the subpackages come with IPython, so you don't need to download and"
7 install them separately. However, to use a given subpackage, you will need to
7 install them separately. However, to use a given subpackage, you will need to
8 install all of its dependencies.
8 install all of its dependencies.
9
9
10
11 Please let us know if you have problems installing IPython or any of its
10 Please let us know if you have problems installing IPython or any of its
12 dependencies. Officially, IPython requires Python 2.6, 2.7, 3.1, or 3.2.
11 dependencies. Officially, IPython requires Python 2.6, 2.7, 3.1, or 3.2.
13
12
@@ -17,28 +16,24 b' dependencies. Officially, IPython requires Python 2.6, 2.7, 3.1, or 3.2.'
17 longer work on Python <= 2.5. You can find older versions of IPython which
16 longer work on Python <= 2.5. You can find older versions of IPython which
18 supported Python <= 2.5 `here <http://archive.ipython.org/release/>`_
17 supported Python <= 2.5 `here <http://archive.ipython.org/release/>`_
19
18
20 Some of the installation approaches use the :mod:`setuptools` package and its
19 Some of the installation approaches use the :mod:`distribute` package and its
21 :command:`easy_install` command line program. In many scenarios, this provides
20 :command:`easy_install` command line program. In many scenarios, this provides
22 the most simple method of installing IPython and its dependencies. It is not
21 the most simple method of installing IPython and its dependencies. More
23 required though. More information about :mod:`setuptools` can be found on its
22 information about :mod:`distribute` can be found on its website.
24 website.
25
23
26 .. note::
24 .. note::
27
25
28 On Windows, IPython *does* depend on :mod:`setuptools`, and it is recommended
26 On Windows, IPython has a hard dependency on :mod:`distribute`. We hope to
29 that you install the :mod:`distribute` package, which improves
27 change this in the future, but for now on Windows, you *must* install
30 :mod:`setuptools` and fixes various bugs. Installing on Python 3 requires
28 :mod:`distribute`.
31 :mod:`distribute` on all platforms.
32
33 We hope to remove this dependency in the future.
34
29
35 More general information about installing Python packages can be found in
30 More general information about installing Python packages can be found in
36 Python's documentation at http://www.python.org/doc/.
31 `Python's documentation <http://docs.python.org>`_.
37
32
38 Quickstart
33 Quickstart
39 ==========
34 ==========
40
35
41 If you have :mod:`setuptools` installed and you are on OS X or Linux (not
36 If you have :mod:`distribute` installed and you are on OS X or Linux (not
42 Windows), the following will download and install IPython *and* the main
37 Windows), the following will download and install IPython *and* the main
43 optional dependencies:
38 optional dependencies:
44
39
@@ -46,9 +41,8 b' optional dependencies:'
46
41
47 $ easy_install ipython[zmq,test]
42 $ easy_install ipython[zmq,test]
48
43
49 This will get pyzmq, which is needed for
44 This will get pyzmq, which is needed for IPython's parallel computing features
50 IPython's parallel computing features as well as the nose package, which will
45 as well as the nose package, which will enable you to run IPython's test suite.
51 enable you to run IPython's test suite.
52
46
53 To run IPython's test suite, use the :command:`iptest` command:
47 To run IPython's test suite, use the :command:`iptest` command:
54
48
@@ -66,14 +60,14 b' with no external dependencies. However, some Python distributions'
66 (particularly on Windows and OS X), don't come with a working :mod:`readline`
60 (particularly on Windows and OS X), don't come with a working :mod:`readline`
67 module. The IPython shell will work without :mod:`readline`, but will lack
61 module. The IPython shell will work without :mod:`readline`, but will lack
68 many features that users depend on, such as tab completion and command line
62 many features that users depend on, such as tab completion and command line
69 editing. If you install IPython with :mod:`setuptools`, (e.g. with `easy_install`),
63 editing. If you install IPython with :mod:`distribute`, (e.g. with `easy_install`),
70 then the appropriate :mod:`readline` for your platform will be installed.
64 then the appropriate :mod:`readline` for your platform will be installed.
71 See below for details of how to make sure you have a working :mod:`readline`.
65 See below for details of how to make sure you have a working :mod:`readline`.
72
66
73 Installation using easy_install
67 Installation using easy_install
74 -------------------------------
68 -------------------------------
75
69
76 If you have :mod:`setuptools` installed, the easiest way of getting IPython is
70 If you have :mod:`distribute` installed, the easiest way of getting IPython is
77 to simple use :command:`easy_install`:
71 to simple use :command:`easy_install`:
78
72
79 .. code-block:: bash
73 .. code-block:: bash
@@ -101,24 +95,22 b' permissions, you may need to run the last command with :command:`sudo`.'
101 Windows
95 Windows
102 -------
96 -------
103
97
104 .. note::
98 As mentioned above, on Windows, IPython requires :mod:`distribute`, and it also
105
99 requires the PyReadline library to properly support coloring and keyboard
106 On Windows, IPython requires :mod:`setuptools` or :mod:`distribute`.
100 management (features that the default windows console doesn't have). So on
101 Windows, the installation procedure is:
107
102
108 We hope to remove this dependency in the future.
103 1. Install `distribute <http://pypi.python.org/pypi/distribute>`_.
109
104
110 There are a few caveats for Windows users. The main issue is that a basic
105 2. Install `pyreadline <http://pypi.python.org/pypi/pyreadline>`_. You can use
111 ``python setup.py install`` approach won't create ``.bat`` file or Start Menu
106 the command ``easy_install pyreadline`` from a terminal, or the binary
112 shortcuts, which most users want. To get an installation with these, you can
107 installer appropriate for your platform from the PyPI page.
113 use any of the following alternatives:
114
108
115 1. Install using :command:`easy_install`.
109 3. Install IPython itself, which you can download from `PyPI
116
110 <http://pypi.python.org/pypi/ipython>`_ or from `our site
117 2. Install using our binary ``.exe`` Windows installer, which can be found
111 <http://ipython.org/download.html>`_. Note that on Windows 7, you *must*
118 `here <http://ipython.org/download.html>`_
112 right-click and 'Run as administrator' for the Start menu shortcuts to be
119
113 created.
120 3. Install from source, but using :mod:`setuptools` (``python setupegg.py
121 install``).
122
114
123 IPython by default runs in a terminal window, but the normal terminal
115 IPython by default runs in a terminal window, but the normal terminal
124 application supplied by Microsoft Windows is very primitive. You may want to
116 application supplied by Microsoft Windows is very primitive. You may want to
@@ -129,14 +121,6 b' from the working terminal.'
129
121
130 .. _Console: http://sourceforge.net/projects/console
122 .. _Console: http://sourceforge.net/projects/console
131
123
132 Note for Windows 64 bit users: you may have difficulties with the stock
133 installer on 64 bit systems; in this case (since we currently do not have 64
134 bit builds of the Windows installer) your best bet is to install from source
135 with the setuptools method indicated in #3 above. See `this bug report`_ for
136 further details.
137
138 .. _this bug report: https://bugs.launchpad.net/ipython/+bug/382214
139
140
124
141 Installing the development version
125 Installing the development version
142 ----------------------------------
126 ----------------------------------
@@ -151,11 +135,8 b' need to have Git installed on your system. Then just do:'
151 $ cd ipython
135 $ cd ipython
152 $ python setup.py install
136 $ python setup.py install
153
137
154 Again, this last step on Windows won't create ``.bat`` files or Start Menu
155 shortcuts, so you will have to use one of the other approaches listed above.
156
157 Some users want to be able to follow the development branch as it changes. If
138 Some users want to be able to follow the development branch as it changes. If
158 you have :mod:`setuptools` installed, this is easy. Simply replace the last
139 you have :mod:`distribute` installed, this is easy. Simply replace the last
159 step by:
140 step by:
160
141
161 .. code-block:: bash
142 .. code-block:: bash
@@ -170,6 +151,7 b' just do:'
170
151
171 $ git pull
152 $ git pull
172
153
154
173 Basic optional dependencies
155 Basic optional dependencies
174 ===========================
156 ===========================
175
157
@@ -186,33 +168,24 b' read on for more details.'
186 readline
168 readline
187 --------
169 --------
188
170
189 In principle, all Python distributions should come with a working
171 As indicated above, on Windows, PyReadline is a *mandatory* dependency.
190 :mod:`readline` module. But, reality is not quite that simple. There are two
172 PyReadline is a separate, Windows only implementation of readline that uses
191 common situations where you won't have a working :mod:`readline` module:
173 native Windows calls through :mod:`ctypes`. The easiest way of installing
192
174 PyReadline is you use the binary installer available `here
193 * If you are using the built-in Python on Mac OS X.
175 <http://pypi.python.org/pypi/pyreadline>`_.
194
195 * If you are running Windows, which doesn't have a :mod:`readline` module.
196
197 When IPython is installed with :mod:`setuptools`, (e.g. with `easy_install`),
198 readline is added as a dependency on OS X, and PyReadline on Windows, and will
199 be installed on your system. However, if you do not use setuptools, you may
200 have to install one of these packages yourself.
201
176
202 On OS X, the built-in Python doesn't not have :mod:`readline` because of
177 On OSX, if you are using the built-in Python shipped by Apple, you will be
203 license issues. Starting with OS X 10.5 (Leopard), Apple's built-in Python has
178 missing a full readline implementation as Apple ships instead a library called
204 a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9,
179 ``libedit`` that provides only some of readline's functionality. While you may
205 many of the issues related to the differences between readline and libedit seem
180 find libedit sufficient, we have occasional reports of bugs with it and several
206 to have been resolved. While you may find libedit sufficient, we have
181 developers who use OS X as their main environment consider libedit unacceptable
207 occasional reports of bugs with it and several developers who use OS X as their
182 for productive, regular use with IPython.
208 main environment consider libedit unacceptable for productive, regular use with
209 IPython.
210
183
211 Therefore, we *strongly* recommend that on OS X you get the full
184 Therefore, we *strongly* recommend that on OS X you get the full
212 :mod:`readline` module. We will *not* consider completion/history problems to
185 :mod:`readline` module. We will *not* consider completion/history problems to
213 be bugs for IPython if you are using libedit.
186 be bugs for IPython if you are using libedit.
214
187
215 To get a working :mod:`readline` module, just do (with :mod:`setuptools`
188 To get a working :mod:`readline` module, just do (with :mod:`distribute`
216 installed):
189 installed):
217
190
218 .. code-block:: bash
191 .. code-block:: bash
@@ -225,14 +198,11 b' installed):'
225 python.org binaries) already have readline installed so you likely don't
198 python.org binaries) already have readline installed so you likely don't
226 have to do this step.
199 have to do this step.
227
200
228 If needed, the readline egg can be build and installed from source (see the
201 When IPython is installed with :mod:`distribute`, (e.g. using the
229 wiki page at
202 ``easy_install`` command), readline is added as a dependency on OS X, and
230 http://web.archive.org/web/20090614162410/ipython.scipy.org/moin/InstallationOSXLeopard).
203 PyReadline on Windows, and will be installed on your system. However, if you
204 do not use distribute, you may have to install one of these packages yourself.
231
205
232 On Windows, you will need the PyReadline module. PyReadline is a separate,
233 Windows only implementation of readline that uses native Windows calls through
234 :mod:`ctypes`. The easiest way of installing PyReadline is you use the binary
235 installer available `here <https://launchpad.net/pyreadline/+download>`_.
236
206
237 nose
207 nose
238 ----
208 ----
@@ -281,13 +251,12 b' Dependencies for IPython.parallel (parallel computing)'
281 :mod:`IPython.kernel` has been replaced by :mod:`IPython.parallel`,
251 :mod:`IPython.kernel` has been replaced by :mod:`IPython.parallel`,
282 which uses ZeroMQ for all communication.
252 which uses ZeroMQ for all communication.
283
253
284 IPython.parallel provides a nice architecture for parallel computing. The
254 IPython.parallel provides a nice architecture for parallel computing, with a
285 main focus of this architecture is on interactive parallel computing. These
255 focus on fluid interactive workflows. These features require just one package:
286 features require just one package: PyZMQ. See the next section for PyZMQ
256 PyZMQ. See the next section for PyZMQ details.
287 details.
288
257
289 On a Unix style platform (including OS X), if you want to use
258 On a Unix style platform (including OS X), if you want to use
290 :mod:`setuptools`, you can just do:
259 :mod:`distribute`, you can just do:
291
260
292 .. code-block:: bash
261 .. code-block:: bash
293
262
@@ -346,8 +315,8 b' started withe command ``ipython notebook``.'
346 pyzmq
315 pyzmq
347 -----
316 -----
348
317
349 Like the :mod:`IPython.parallel` and :mod:`IPython.frontend.qt.console` packages,
318 Like the :mod:`IPython.parallel` and :mod:`IPython.frontend.qt.console`
350 the HTML notebook requires ZeroMQ and PyZMQ.
319 packages, the HTML notebook requires ZeroMQ and PyZMQ.
351
320
352 Tornado
321 Tornado
353 -------
322 -------
General Comments 0
You need to be logged in to leave comments. Login now