Show More
@@ -1,57 +1,30 b'' | |||
|
1 | Overview | |
|
2 | ======== | |
|
3 | ||
|
4 | This document describes the steps required to install IPython. IPython is | |
|
5 | organized into a number of subpackages, each of which has its own dependencies. | |
|
6 | 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 | |
|
8 | install all of its dependencies. | |
|
9 | ||
|
10 | Please let us know if you have problems installing IPython or any of its | |
|
11 | dependencies. Officially, IPython requires Python 2.6, 2.7, 3.1, or 3.2. | |
|
12 | ||
|
13 | .. warning:: | |
|
14 | ||
|
15 | Since version 0.11, IPython has a hard syntax dependency on 2.6, and will no | |
|
16 | longer work on Python <= 2.5. You can find older versions of IPython which | |
|
17 | supported Python <= 2.5 `here <http://archive.ipython.org/release/>`_ | |
|
18 | ||
|
19 | Some of the installation approaches use the :mod:`distribute` package and its | |
|
20 | :command:`easy_install` command line program. In many scenarios, this provides | |
|
21 | the most simple method of installing IPython and its dependencies. More | |
|
22 | information about :mod:`distribute` can be found on `its PyPI page | |
|
23 | <http://pypi.python.org/pypi/distribute>`__. | |
|
1 | IPython requires Python 2.6, 2.7, or β₯ 3.2. | |
|
24 | 2 | |
|
25 | 3 | .. note:: |
|
26 | 4 | |
|
27 | On Windows, IPython has a hard dependency on :mod:`distribute`. We hope to | |
|
28 | change this in the future, but for now on Windows, you *must* install | |
|
29 | :mod:`distribute`. | |
|
30 | ||
|
31 | More general information about installing Python packages can be found in | |
|
32 | `Python's documentation <http://docs.python.org>`_. | |
|
33 | ||
|
5 | If you need to use Python 2.5, you can find an old version (β€0.10) of IPython | |
|
6 | `here <http://archive.ipython.org/release/>`__. | |
|
34 | 7 | |
|
35 | 8 | Quickstart |
|
36 | 9 | ========== |
|
37 | 10 | |
|
38 | If you have :mod:`distribute` installed and you are on OS X or Linux (not | |
|
39 | Windows), the following will download and install IPython *and* the main | |
|
40 | optional dependencies: | |
|
11 | If you have :mod:`setuptools`, | |
|
12 | the quickest way to get up and running with IPython is: | |
|
41 | 13 | |
|
42 | 14 | .. code-block:: bash |
|
43 | 15 | |
|
44 | 16 | $ easy_install ipython[all] |
|
45 | 17 | |
|
46 | This will get: | |
|
18 | This will download and install IPython and its main optional dependencies: | |
|
47 | 19 | |
|
48 | 20 | - jinja2, needed for the notebook |
|
49 | 21 | - sphinx, needed for nbconvert |
|
50 | 22 | - pyzmq, needed for IPython's parallel computing features, qt console and |
|
51 |
notebook |
|
|
52 |
- pygments, used by nbconvert and the Qt console for syntax highlighting |
|
|
23 | notebook | |
|
24 | - pygments, used by nbconvert and the Qt console for syntax highlighting | |
|
53 | 25 | - tornado, needed by the web-based notebook |
|
54 |
- nose, used by the test suite |
|
|
26 | - nose, used by the test suite | |
|
27 | - readline (on OS X) or pyreadline (on Windows), needed for the terminal | |
|
55 | 28 | |
|
56 | 29 | To run IPython's test suite, use the :command:`iptest` command: |
|
57 | 30 | |
@@ -59,7 +32,48 b" To run IPython's test suite, use the :command:`iptest` command:" | |||
|
59 | 32 | |
|
60 | 33 | $ iptest |
|
61 | 34 | |
|
35 | .. note:: | |
|
36 | ||
|
37 | .. code-block:: bash | |
|
38 | ||
|
39 | $ pip install ipython[all] | |
|
62 | 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 | ||
|
46 | Overview | |
|
47 | ======== | |
|
48 | ||
|
49 | This document describes in detail the steps required to install IPython, | |
|
50 | and its various optional dependencies. | |
|
51 | For a few quick ways to get started with package managers or full Python distributions, | |
|
52 | see `the install page <http://ipython.org/install.html>`_ of the IPython website. | |
|
53 | ||
|
54 | IPython is organized into a number of subpackages, each of which has its own dependencies. | |
|
55 | All of the subpackages come with IPython, so you don't need to download and | |
|
56 | install them separately. However, to use a given subpackage, you will need to | |
|
57 | install all of its dependencies. | |
|
58 | ||
|
59 | Please let us know if you have problems installing IPython or any of its dependencies. | |
|
60 | ||
|
61 | IPython and most dependencies can be installed via :command:`easy_install`, | |
|
62 | provided by the :mod:`setuptools` package, or :command:`pip`. | |
|
63 | In many scenarios, this is the most simplest method of installing Python packages. | |
|
64 | More information about :mod:`setuptools` can be found on | |
|
65 | `its PyPI page <http://pypi.python.org/pypi/setuptools>`__. | |
|
66 | ||
|
67 | .. note:: | |
|
68 | ||
|
69 | On Windows, IPython *requires* :mod:`setuptools`. We hope to | |
|
70 | change this in the future, but for now on Windows, you *must* install | |
|
71 | :mod:`setuptools` to use IPython. | |
|
72 | ||
|
73 | More general information about installing Python packages can be found in | |
|
74 | `Python's documentation <http://docs.python.org>`_. | |
|
75 | ||
|
76 | ||
|
63 | 77 | Installing IPython itself |
|
64 | 78 | ========================= |
|
65 | 79 | |
@@ -76,15 +90,22 b' installed. See below for details of how to make sure you have a working' | |||
|
76 | 90 | Installation using easy_install or pip |
|
77 | 91 | -------------------------------------- |
|
78 | 92 | |
|
79 | If you have :mod:`setuptools`, the easiest way of getting IPython is | |
|
80 | to simply use :command:`easy_install`: | |
|
93 | 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`: | |
|
81 | 95 | |
|
82 | 96 | .. code-block:: bash |
|
83 | 97 | |
|
84 |
$ |
|
|
98 | $ pip install ipython | |
|
85 | 99 | |
|
86 | 100 | That's it. |
|
87 | 101 | |
|
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 | ||
|
88 | 109 | Installation from source |
|
89 | 110 | ------------------------ |
|
90 | 111 | |
@@ -140,7 +161,7 b' need to have Git installed on your system. Then just do:' | |||
|
140 | 161 | |
|
141 | 162 | .. code-block:: bash |
|
142 | 163 | |
|
143 | $ git clone https://github.com/ipython/ipython.git | |
|
164 | $ git clone --recursive https://github.com/ipython/ipython.git | |
|
144 | 165 | $ cd ipython |
|
145 | 166 | $ python setup.py install |
|
146 | 167 | |
@@ -160,7 +181,7 b' just do:' | |||
|
160 | 181 | |
|
161 | 182 | $ git pull |
|
162 | 183 | |
|
163 | ||
|
184 | ||
|
164 | 185 | Basic optional dependencies |
|
165 | 186 | =========================== |
|
166 | 187 | |
@@ -181,7 +202,7 b' As indicated above, on Windows, PyReadline is a *mandatory* dependency.' | |||
|
181 | 202 | PyReadline is a separate, Windows only implementation of readline that uses |
|
182 | 203 | native Windows calls through :mod:`ctypes`. The easiest way of installing |
|
183 | 204 | PyReadline is you use the binary installer available `here |
|
184 | <http://pypi.python.org/pypi/pyreadline>`_. | |
|
205 | <http://pypi.python.org/pypi/pyreadline>`__. | |
|
185 | 206 | |
|
186 | 207 | On OSX, if you are using the built-in Python shipped by Apple, you will be |
|
187 | 208 | missing a full readline implementation as Apple ships instead a library called |
@@ -218,17 +239,17 b' nose' | |||
|
218 | 239 | |
|
219 | 240 | To run the IPython test suite you will need the :mod:`nose` package. Nose |
|
220 | 241 | provides a great way of sniffing out and running all of the IPython tests. The |
|
221 |
simplest way of getting nose |
|
|
242 | simplest way of getting nose is to use :command:`easy_install` or :command:`pip`: | |
|
222 | 243 | |
|
223 | 244 | .. code-block:: bash |
|
224 | 245 | |
|
225 |
$ |
|
|
246 | $ pip install nose | |
|
226 | 247 | |
|
227 | 248 | Another way of getting this is to do: |
|
228 | 249 | |
|
229 | 250 | .. code-block:: bash |
|
230 | 251 | |
|
231 |
$ |
|
|
252 | $ pip install ipython[test] | |
|
232 | 253 | |
|
233 | 254 | For more installation options, see the `nose website |
|
234 | 255 | <http://somethingaboutorange.com/mrl/projects/nose/>`_. |
@@ -250,16 +271,18 b' that instead. On Unix platforms (including OS X), just do:' | |||
|
250 | 271 | |
|
251 | 272 | .. code-block:: bash |
|
252 | 273 | |
|
253 |
$ |
|
|
274 | $ pip install pexpect | |
|
275 | ||
|
276 | .. note:: | |
|
277 | ||
|
278 | On Python 3, you should actually install :mod:`pexpect-u`, | |
|
279 | a unicode-safe fork of pexpect. | |
|
254 | 280 | |
|
255 | 281 | Windows users are out of luck as pexpect does not run there. |
|
256 | 282 | |
|
257 | 283 | Dependencies for IPython.parallel (parallel computing) |
|
258 | 284 | ====================================================== |
|
259 | 285 | |
|
260 | :mod:`IPython.kernel` has been replaced by :mod:`IPython.parallel`, | |
|
261 | which uses ZeroMQ for all communication. | |
|
262 | ||
|
263 | 286 | IPython.parallel provides a nice architecture for parallel computing, with a |
|
264 | 287 | focus on fluid interactive workflows. These features require just one package: |
|
265 | 288 | PyZMQ. See the next section for PyZMQ details. |
General Comments 0
You need to be logged in to leave comments.
Login now