##// END OF EJS Templates
Merge pull request #5837 from minrk/install-doc...
Thomas Kluyver -
r16709:6a112b49 merge
parent child Browse files
Show More
@@ -13,7 +13,7 b' the quickest way to get up and running with IPython is:'
13
13
14 .. code-block:: bash
14 .. code-block:: bash
15
15
16 $ easy_install ipython[all]
16 $ pip install ipython[all]
17
17
18 This will download and install IPython and its main optional dependencies:
18 This will download and install IPython and its main optional dependencies:
19
19
@@ -32,16 +32,6 b" To run IPython's test suite, use the :command:`iptest` command:"
32
32
33 $ iptest
33 $ iptest
34
34
35 .. note::
36
37 .. code-block:: bash
38
39 $ pip install ipython[all]
40
41 will also work in many cases, but it will ignore the binary eggs
42 of packages such as pyzmq and readline,
43 which may be required for some users on Windows or OS X.
44
45
35
46 Overview
36 Overview
47 ========
37 ========
@@ -58,11 +48,10 b' install all of its dependencies.'
58
48
59 Please let us know if you have problems installing IPython or any of its dependencies.
49 Please let us know if you have problems installing IPython or any of its dependencies.
60
50
61 IPython and most dependencies can be installed via :command:`easy_install`,
51 IPython and most dependencies can be installed via :command:`pip`.
62 provided by the :mod:`setuptools` package, or :command:`pip`.
52 In many scenarios, this is the simplest method of installing Python packages.
63 In many scenarios, this is the most simplest method of installing Python packages.
53 More information about :mod:`pip` can be found on
64 More information about :mod:`setuptools` can be found on
54 `its PyPI page <http://pypi.python.org/pypi/pip>`__.
65 `its PyPI page <http://pypi.python.org/pypi/setuptools>`__.
66
55
67 .. note::
56 .. note::
68
57
@@ -83,15 +72,15 b' with no external dependencies. However, some Python distributions'
83 module. The IPython shell will work without :mod:`readline`, but will lack
72 module. The IPython shell will work without :mod:`readline`, but will lack
84 many features that users depend on, such as tab completion and command line
73 many features that users depend on, such as tab completion and command line
85 editing. If you install IPython with :mod:`setuptools`, (e.g. with
74 editing. If you install IPython with :mod:`setuptools`, (e.g. with
86 `easy_install`), then the appropriate :mod:`readline` for your platform will be
75 `pip`), then the appropriate :mod:`readline` for your platform will be
87 installed. See below for details of how to make sure you have a working
76 installed. See below for details of how to make sure you have a working
88 :mod:`readline`.
77 :mod:`readline`.
89
78
90 Installation using easy_install or pip
79 Installation using pip
91 --------------------------------------
80 ----------------------
92
81
93 If you have :mod:`setuptools` or :mod:`pip`, the easiest way of getting IPython is
82 If you have :mod:`setuptools` or :mod:`pip`, the easiest way of getting IPython is
94 to simply use :command:`easy_install` or :command:`pip`:
83 to simply use :command:`pip`:
95
84
96 .. code-block:: bash
85 .. code-block:: bash
97
86
@@ -99,17 +88,11 b' to simply use :command:`easy_install` or :command:`pip`:'
99
88
100 That's it.
89 That's it.
101
90
102 .. note::
103
104 Many prefer :command:`pip` to :command:`easy_install`, but it ignores eggs (binary Python packages).
105 This mainly affects pyzmq and readline, which are compiled packages and provide
106 binary eggs. If you use :command:`pip` to install these packages,
107 it will always compile from source, which may not succeed.
108
91
109 Installation from source
92 Installation from source
110 ------------------------
93 ------------------------
111
94
112 If you don't want to use :command:`easy_install`, or don't have it installed,
95 If you don't want to use :command:`pip`, or don't have it installed,
113 just grab the latest stable build of IPython from `here
96 just grab the latest stable build of IPython from `here
114 <http://ipython.org/download.html>`_. Then do the following:
97 <http://ipython.org/download.html>`_. Then do the following:
115
98
@@ -133,7 +116,7 b' Windows, the installation procedure is:'
133 1. Install `setuptools <http://pypi.python.org/pypi/setuptools>`_.
116 1. Install `setuptools <http://pypi.python.org/pypi/setuptools>`_.
134
117
135 2. Install `pyreadline <http://pypi.python.org/pypi/pyreadline>`_. You can use
118 2. Install `pyreadline <http://pypi.python.org/pypi/pyreadline>`_. You can use
136 the command ``easy_install pyreadline`` from a terminal, or the binary
119 the command ``pip install pyreadline`` from a terminal, or the binary
137 installer appropriate for your platform from the PyPI page.
120 installer appropriate for your platform from the PyPI page.
138
121
139 3. Install IPython itself, which you can download from `PyPI
122 3. Install IPython itself, which you can download from `PyPI
@@ -227,33 +210,34 b' PyReadline is you use the binary installer available `here'
227 <http://pypi.python.org/pypi/pyreadline>`__.
210 <http://pypi.python.org/pypi/pyreadline>`__.
228
211
229 On OSX, if you are using the built-in Python shipped by Apple, you will be
212 On OSX, if you are using the built-in Python shipped by Apple, you will be
230 missing a full readline implementation as Apple ships instead a library called
213 missing a proper readline implementation as Apple ships instead a library called
231 ``libedit`` that provides only some of readline's functionality. While you may
214 ``libedit`` that provides only some of readline's functionality. While you may
232 find libedit sufficient, we have occasional reports of bugs with it and several
215 find libedit sufficient, we have occasional reports of bugs with it and several
233 developers who use OS X as their main environment consider libedit unacceptable
216 developers who use OS X as their main environment consider libedit unacceptable
234 for productive, regular use with IPython.
217 for productive, regular use with IPython.
235
218
236 Therefore, we *strongly* recommend that on OS X you get the full
219 Therefore, IPython on OS X depends on the :mod:`gnureadline` module.
237 :mod:`readline` module. We will *not* consider completion/history problems to
220 We will *not* consider completion/history problems to be bugs for IPython if you are using libedit.
238 be bugs for IPython if you are using libedit.
239
221
240 To get a working :mod:`readline` module, just do (with :mod:`setuptools`
222 To get a working :mod:`readline` module on OS X, just do (with :mod:`pip`
241 installed):
223 installed):
242
224
243 .. code-block:: bash
225 .. code-block:: bash
244
226
245 $ easy_install readline
227 $ pip install gnureadline
246
228
247 .. note::
229 .. note::
248
230
249 Other Python distributions on OS X (such as fink, MacPorts and the official
231 Other Python distributions on OS X (such as Anaconda, fink, MacPorts)
250 python.org binaries) already have readline installed so you likely don't
232 already have proper readline so you likely don't have to do this step.
251 have to do this step.
252
233
253 When IPython is installed with :mod:`setuptools`, (e.g. using the
234 When IPython is installed with :mod:`setuptools`, (e.g. using the
254 ``easy_install`` command), readline is added as a dependency on OS X, and
235 ``pip`` command), the correct readline should be installed if you specify the `terminal`
255 PyReadline on Windows, and will be installed on your system. However, if you
236 optional dependencies:
256 do not use setuptools, you may have to install one of these packages yourself.
237
238 .. code-block:: bash
239
240 $ pip install ipython[terminal]
257
241
258
242
259 nose
243 nose
@@ -261,7 +245,7 b' nose'
261
245
262 To run the IPython test suite you will need the :mod:`nose` package. Nose
246 To run the IPython test suite you will need the :mod:`nose` package. Nose
263 provides a great way of sniffing out and running all of the IPython tests. The
247 provides a great way of sniffing out and running all of the IPython tests. The
264 simplest way of getting nose is to use :command:`easy_install` or :command:`pip`:
248 simplest way of getting nose is to use :command:`pip`:
265
249
266 .. code-block:: bash
250 .. code-block:: bash
267
251
@@ -295,7 +279,7 b' On a Unix style platform (including OS X), if you want to use'
295
279
296 .. code-block:: bash
280 .. code-block:: bash
297
281
298 $ easy_install ipython[zmq] # will include pyzmq
282 $ pip install ipython[zmq] # will include pyzmq
299
283
300 Security in IPython.parallel is provided by SSH tunnels. By default, Linux
284 Security in IPython.parallel is provided by SSH tunnels. By default, Linux
301 and OSX clients will use the shell ssh command, but on Windows, we also
285 and OSX clients will use the shell ssh command, but on Windows, we also
@@ -309,11 +293,11 b' pyzmq'
309
293
310 IPython 0.11 introduced some new functionality, including a two-process
294 IPython 0.11 introduced some new functionality, including a two-process
311 execution model using ZeroMQ_ for communication. The Python bindings to ZeroMQ
295 execution model using ZeroMQ_ for communication. The Python bindings to ZeroMQ
312 are found in the PyZMQ_ project, which is easy_install-able once you have
296 are found in the PyZMQ_ project, which is pip install-able.
313 ZeroMQ installed. If you are on Python 2.6 or 2.7 on OSX, or 2.7 on Windows,
297 If you are on Python 2.7, 3.3, or 3.4 on OSX or Windows,
314 pyzmq has eggs that include ZeroMQ itself.
298 pyzmq has eggs and wheels that include ZeroMQ itself.
315
299
316 IPython.kernel.zmq depends on pyzmq >= 2.1.4.
300 IPython.kernel.zmq depends on pyzmq >= 2.2.
317
301
318 Dependencies for the IPython QT console
302 Dependencies for the IPython QT console
319 =======================================
303 =======================================
@@ -337,7 +321,7 b' pygments'
337 --------
321 --------
338
322
339 The syntax-highlighting in ``ipython qtconsole`` is done with the pygments_
323 The syntax-highlighting in ``ipython qtconsole`` is done with the pygments_
340 project, which is easy_install-able.
324 project, which is pip install-able.
341
325
342 .. _installnotebook:
326 .. _installnotebook:
343
327
@@ -397,7 +381,7 b' of :mod:`IPython.external.mathjax`'
397 Browser Compatibility
381 Browser Compatibility
398 ---------------------
382 ---------------------
399
383
400 The IPython notebook is officially supported on the following browers:
384 The IPython notebook is officially supported on the following browsers:
401
385
402 * Chrome ≥ 13
386 * Chrome ≥ 13
403 * Safari ≥ 5
387 * Safari ≥ 5
General Comments 0
You need to be logged in to leave comments. Login now