##// END OF EJS Templates
Explicitly state what version of Pandoc is supported in the docs.
Jonathan Frederic -
Show More
@@ -1,448 +1,448 b''
1 IPython requires Python 2.7 or ≥ 3.3.
1 IPython requires Python 2.7 or ≥ 3.3.
2
2
3 .. note::
3 .. note::
4
4
5 If you need to use Python 2.6 or 3.2, you can find IPython 1.0
5 If you need to use Python 2.6 or 3.2, you can find IPython 1.0
6 `here <http://archive.ipython.org/release/>`__.
6 `here <http://archive.ipython.org/release/>`__.
7
7
8 Quickstart
8 Quickstart
9 ==========
9 ==========
10
10
11 If you have :mod:`setuptools`,
11 If you have :mod:`setuptools`,
12 the quickest way to get up and running with IPython is:
12 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 $ easy_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
20 - jinja2, needed for the notebook
20 - jinja2, needed for the notebook
21 - sphinx, needed for nbconvert
21 - sphinx, needed for nbconvert
22 - pyzmq, needed for IPython's parallel computing features, qt console and
22 - pyzmq, needed for IPython's parallel computing features, qt console and
23 notebook
23 notebook
24 - pygments, used by nbconvert and the Qt console for syntax highlighting
24 - pygments, used by nbconvert and the Qt console for syntax highlighting
25 - tornado, needed by the web-based notebook
25 - tornado, needed by the web-based notebook
26 - 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
27 - readline (on OS X) or pyreadline (on Windows), needed for the terminal
28
28
29 To run IPython's test suite, use the :command:`iptest` command:
29 To run IPython's test suite, use the :command:`iptest` command:
30
30
31 .. code-block:: bash
31 .. code-block:: bash
32
32
33 $ iptest
33 $ iptest
34
34
35 .. note::
35 .. note::
36
36
37 .. code-block:: bash
37 .. code-block:: bash
38
38
39 $ pip install ipython[all]
39 $ pip install ipython[all]
40
40
41 will also work in many cases, but it will ignore the binary eggs
41 will also work in many cases, but it will ignore the binary eggs
42 of packages such as pyzmq and readline,
42 of packages such as pyzmq and readline,
43 which may be required for some users on Windows or OS X.
43 which may be required for some users on Windows or OS X.
44
44
45
45
46 Overview
46 Overview
47 ========
47 ========
48
48
49 This document describes in detail the steps required to install IPython,
49 This document describes in detail the steps required to install IPython,
50 and its various optional dependencies.
50 and its various optional dependencies.
51 For a few quick ways to get started with package managers or full Python distributions,
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.
52 see `the install page <http://ipython.org/install.html>`_ of the IPython website.
53
53
54 IPython is organized into a number of subpackages, each of which has its own dependencies.
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
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
56 install them separately. However, to use a given subpackage, you will need to
57 install all of its dependencies.
57 install all of its dependencies.
58
58
59 Please let us know if you have problems installing IPython or any of its dependencies.
59 Please let us know if you have problems installing IPython or any of its dependencies.
60
60
61 IPython and most dependencies can be installed via :command:`easy_install`,
61 IPython and most dependencies can be installed via :command:`easy_install`,
62 provided by the :mod:`setuptools` package, or :command:`pip`.
62 provided by the :mod:`setuptools` package, or :command:`pip`.
63 In many scenarios, this is the most simplest method of installing Python packages.
63 In many scenarios, this is the most simplest method of installing Python packages.
64 More information about :mod:`setuptools` can be found on
64 More information about :mod:`setuptools` can be found on
65 `its PyPI page <http://pypi.python.org/pypi/setuptools>`__.
65 `its PyPI page <http://pypi.python.org/pypi/setuptools>`__.
66
66
67 .. note::
67 .. note::
68
68
69 On Windows, IPython *requires* :mod:`setuptools`. We hope to
69 On Windows, IPython *requires* :mod:`setuptools`. We hope to
70 change this in the future, but for now on Windows, you *must* install
70 change this in the future, but for now on Windows, you *must* install
71 :mod:`setuptools` to use IPython.
71 :mod:`setuptools` to use IPython.
72
72
73 More general information about installing Python packages can be found in
73 More general information about installing Python packages can be found in
74 `Python's documentation <http://docs.python.org>`_.
74 `Python's documentation <http://docs.python.org>`_.
75
75
76
76
77 Installing IPython itself
77 Installing IPython itself
78 =========================
78 =========================
79
79
80 Given a properly built Python, the basic interactive IPython shell will work
80 Given a properly built Python, the basic interactive IPython shell will work
81 with no external dependencies. However, some Python distributions
81 with no external dependencies. However, some Python distributions
82 (particularly on Windows and OS X), don't come with a working :mod:`readline`
82 (particularly on Windows and OS X), don't come with a working :mod:`readline`
83 module. The IPython shell will work without :mod:`readline`, but will lack
83 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
84 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
85 editing. If you install IPython with :mod:`setuptools`, (e.g. with
86 `easy_install`), then the appropriate :mod:`readline` for your platform will be
86 `easy_install`), 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
87 installed. See below for details of how to make sure you have a working
88 :mod:`readline`.
88 :mod:`readline`.
89
89
90 Installation using easy_install or pip
90 Installation using easy_install or pip
91 --------------------------------------
91 --------------------------------------
92
92
93 If you have :mod:`setuptools` or :mod:`pip`, the easiest way of getting IPython is
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`:
94 to simply use :command:`easy_install` or :command:`pip`:
95
95
96 .. code-block:: bash
96 .. code-block:: bash
97
97
98 $ pip install ipython
98 $ pip install ipython
99
99
100 That's it.
100 That's it.
101
101
102 .. note::
102 .. note::
103
103
104 Many prefer :command:`pip` to :command:`easy_install`, but it ignores eggs (binary Python packages).
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
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,
106 binary eggs. If you use :command:`pip` to install these packages,
107 it will always compile from source, which may not succeed.
107 it will always compile from source, which may not succeed.
108
108
109 Installation from source
109 Installation from source
110 ------------------------
110 ------------------------
111
111
112 If you don't want to use :command:`easy_install`, or don't have it installed,
112 If you don't want to use :command:`easy_install`, or don't have it installed,
113 just grab the latest stable build of IPython from `here
113 just grab the latest stable build of IPython from `here
114 <http://ipython.org/download.html>`_. Then do the following:
114 <http://ipython.org/download.html>`_. Then do the following:
115
115
116 .. code-block:: bash
116 .. code-block:: bash
117
117
118 $ tar -xzf ipython.tar.gz
118 $ tar -xzf ipython.tar.gz
119 $ cd ipython
119 $ cd ipython
120 $ python setup.py install
120 $ python setup.py install
121
121
122 If you are installing to a location (like ``/usr/local``) that requires higher
122 If you are installing to a location (like ``/usr/local``) that requires higher
123 permissions, you may need to run the last command with :command:`sudo`.
123 permissions, you may need to run the last command with :command:`sudo`.
124
124
125 Windows
125 Windows
126 -------
126 -------
127
127
128 As mentioned above, on Windows, IPython requires :mod:`setuptools`, and it also
128 As mentioned above, on Windows, IPython requires :mod:`setuptools`, and it also
129 requires the PyReadline library to properly support coloring and keyboard
129 requires the PyReadline library to properly support coloring and keyboard
130 management (features that the default windows console doesn't have). So on
130 management (features that the default windows console doesn't have). So on
131 Windows, the installation procedure is:
131 Windows, the installation procedure is:
132
132
133 1. Install `setuptools <http://pypi.python.org/pypi/setuptools>`_.
133 1. Install `setuptools <http://pypi.python.org/pypi/setuptools>`_.
134
134
135 2. Install `pyreadline <http://pypi.python.org/pypi/pyreadline>`_. You can use
135 2. Install `pyreadline <http://pypi.python.org/pypi/pyreadline>`_. You can use
136 the command ``easy_install pyreadline`` from a terminal, or the binary
136 the command ``easy_install pyreadline`` from a terminal, or the binary
137 installer appropriate for your platform from the PyPI page.
137 installer appropriate for your platform from the PyPI page.
138
138
139 3. Install IPython itself, which you can download from `PyPI
139 3. Install IPython itself, which you can download from `PyPI
140 <http://pypi.python.org/pypi/ipython>`_ or from `our site
140 <http://pypi.python.org/pypi/ipython>`_ or from `our site
141 <http://ipython.org/download.html>`_. Note that on Windows 7, you *must*
141 <http://ipython.org/download.html>`_. Note that on Windows 7, you *must*
142 right-click and 'Run as administrator' for the Start menu shortcuts to be
142 right-click and 'Run as administrator' for the Start menu shortcuts to be
143 created.
143 created.
144
144
145 IPython by default runs in a terminal window, but the normal terminal
145 IPython by default runs in a terminal window, but the normal terminal
146 application supplied by Microsoft Windows is very primitive. You may want to
146 application supplied by Microsoft Windows is very primitive. You may want to
147 download the excellent and free Console_ application instead, which is a far
147 download the excellent and free Console_ application instead, which is a far
148 superior tool. You can even configure Console to give you by default an
148 superior tool. You can even configure Console to give you by default an
149 IPython tab, which is very convenient to create new IPython sessions directly
149 IPython tab, which is very convenient to create new IPython sessions directly
150 from the working terminal.
150 from the working terminal.
151
151
152 .. _Console: http://sourceforge.net/projects/console
152 .. _Console: http://sourceforge.net/projects/console
153
153
154
154
155 Installing the development version
155 Installing the development version
156 ----------------------------------
156 ----------------------------------
157
157
158 It is also possible to install the development version of IPython from our
158 It is also possible to install the development version of IPython from our
159 `Git <http://git-scm.com/>`_ source code repository. To do this you will
159 `Git <http://git-scm.com/>`_ source code repository. To do this you will
160 need to have Git installed on your system. Then just do:
160 need to have Git installed on your system. Then just do:
161
161
162 .. code-block:: bash
162 .. code-block:: bash
163
163
164 $ git clone --recursive https://github.com/ipython/ipython.git
164 $ git clone --recursive https://github.com/ipython/ipython.git
165 $ cd ipython
165 $ cd ipython
166 $ python setup.py install
166 $ python setup.py install
167
167
168 Some users want to be able to follow the development branch as it changes. If
168 Some users want to be able to follow the development branch as it changes. If
169 you have :mod:`setuptools` installed, this is easy. Simply replace the last
169 you have :mod:`setuptools` installed, this is easy. Simply replace the last
170 step by:
170 step by:
171
171
172 .. code-block:: bash
172 .. code-block:: bash
173
173
174 $ python setupegg.py develop
174 $ python setupegg.py develop
175
175
176 This creates links in the right places and installs the command line script to
176 This creates links in the right places and installs the command line script to
177 the appropriate places. Then, if you want to update your IPython at any time,
177 the appropriate places. Then, if you want to update your IPython at any time,
178 just do:
178 just do:
179
179
180 .. code-block:: bash
180 .. code-block:: bash
181
181
182 $ git pull
182 $ git pull
183
183
184
184
185 Basic optional dependencies
185 Basic optional dependencies
186 ===========================
186 ===========================
187
187
188 There are a number of basic optional dependencies that most users will want to
188 There are a number of basic optional dependencies that most users will want to
189 get. These are:
189 get. These are:
190
190
191 * readline (for command line editing, tab completion, etc.)
191 * readline (for command line editing, tab completion, etc.)
192 * nose (to run the IPython test suite)
192 * nose (to run the IPython test suite)
193 * pexpect (to use things like irunner)
193 * pexpect (to use things like irunner)
194
194
195 If you are comfortable installing these things yourself, have at it, otherwise
195 If you are comfortable installing these things yourself, have at it, otherwise
196 read on for more details.
196 read on for more details.
197
197
198 readline
198 readline
199 --------
199 --------
200
200
201 As indicated above, on Windows, PyReadline is a *mandatory* dependency.
201 As indicated above, on Windows, PyReadline is a *mandatory* dependency.
202 PyReadline is a separate, Windows only implementation of readline that uses
202 PyReadline is a separate, Windows only implementation of readline that uses
203 native Windows calls through :mod:`ctypes`. The easiest way of installing
203 native Windows calls through :mod:`ctypes`. The easiest way of installing
204 PyReadline is you use the binary installer available `here
204 PyReadline is you use the binary installer available `here
205 <http://pypi.python.org/pypi/pyreadline>`__.
205 <http://pypi.python.org/pypi/pyreadline>`__.
206
206
207 On OSX, if you are using the built-in Python shipped by Apple, you will be
207 On OSX, if you are using the built-in Python shipped by Apple, you will be
208 missing a full readline implementation as Apple ships instead a library called
208 missing a full readline implementation as Apple ships instead a library called
209 ``libedit`` that provides only some of readline's functionality. While you may
209 ``libedit`` that provides only some of readline's functionality. While you may
210 find libedit sufficient, we have occasional reports of bugs with it and several
210 find libedit sufficient, we have occasional reports of bugs with it and several
211 developers who use OS X as their main environment consider libedit unacceptable
211 developers who use OS X as their main environment consider libedit unacceptable
212 for productive, regular use with IPython.
212 for productive, regular use with IPython.
213
213
214 Therefore, we *strongly* recommend that on OS X you get the full
214 Therefore, we *strongly* recommend that on OS X you get the full
215 :mod:`readline` module. We will *not* consider completion/history problems to
215 :mod:`readline` module. We will *not* consider completion/history problems to
216 be bugs for IPython if you are using libedit.
216 be bugs for IPython if you are using libedit.
217
217
218 To get a working :mod:`readline` module, just do (with :mod:`setuptools`
218 To get a working :mod:`readline` module, just do (with :mod:`setuptools`
219 installed):
219 installed):
220
220
221 .. code-block:: bash
221 .. code-block:: bash
222
222
223 $ easy_install readline
223 $ easy_install readline
224
224
225 .. note::
225 .. note::
226
226
227 Other Python distributions on OS X (such as fink, MacPorts and the official
227 Other Python distributions on OS X (such as fink, MacPorts and the official
228 python.org binaries) already have readline installed so you likely don't
228 python.org binaries) already have readline installed so you likely don't
229 have to do this step.
229 have to do this step.
230
230
231 When IPython is installed with :mod:`setuptools`, (e.g. using the
231 When IPython is installed with :mod:`setuptools`, (e.g. using the
232 ``easy_install`` command), readline is added as a dependency on OS X, and
232 ``easy_install`` command), readline is added as a dependency on OS X, and
233 PyReadline on Windows, and will be installed on your system. However, if you
233 PyReadline on Windows, and will be installed on your system. However, if you
234 do not use setuptools, you may have to install one of these packages yourself.
234 do not use setuptools, you may have to install one of these packages yourself.
235
235
236
236
237 nose
237 nose
238 ----
238 ----
239
239
240 To run the IPython test suite you will need the :mod:`nose` package. Nose
240 To run the IPython test suite you will need the :mod:`nose` package. Nose
241 provides a great way of sniffing out and running all of the IPython tests. The
241 provides a great way of sniffing out and running all of the IPython tests. The
242 simplest way of getting nose is to use :command:`easy_install` or :command:`pip`:
242 simplest way of getting nose is to use :command:`easy_install` or :command:`pip`:
243
243
244 .. code-block:: bash
244 .. code-block:: bash
245
245
246 $ pip install nose
246 $ pip install nose
247
247
248 Another way of getting this is to do:
248 Another way of getting this is to do:
249
249
250 .. code-block:: bash
250 .. code-block:: bash
251
251
252 $ pip install ipython[test]
252 $ pip install ipython[test]
253
253
254 For more installation options, see the `nose website
254 For more installation options, see the `nose website
255 <http://somethingaboutorange.com/mrl/projects/nose/>`_.
255 <http://somethingaboutorange.com/mrl/projects/nose/>`_.
256
256
257 Once you have nose installed, you can run IPython's test suite using the
257 Once you have nose installed, you can run IPython's test suite using the
258 iptest command:
258 iptest command:
259
259
260 .. code-block:: bash
260 .. code-block:: bash
261
261
262 $ iptest
262 $ iptest
263
263
264 pexpect
264 pexpect
265 -------
265 -------
266
266
267 The pexpect_ package is used in IPython's :command:`irunner` script, as well as
267 The pexpect_ package is used in IPython's :command:`irunner` script, as well as
268 for managing subprocesses. IPython now includes a version of pexpect in
268 for managing subprocesses. IPython now includes a version of pexpect in
269 :mod:`IPython.external`, but if you have installed pexpect, IPython will use
269 :mod:`IPython.external`, but if you have installed pexpect, IPython will use
270 that instead. On Unix platforms (including OS X), just do:
270 that instead. On Unix platforms (including OS X), just do:
271
271
272 .. code-block:: bash
272 .. code-block:: bash
273
273
274 $ pip install pexpect
274 $ pip install pexpect
275
275
276 .. note::
276 .. note::
277
277
278 On Python 3, you should actually install :mod:`pexpect-u`,
278 On Python 3, you should actually install :mod:`pexpect-u`,
279 a unicode-safe fork of pexpect.
279 a unicode-safe fork of pexpect.
280
280
281 Windows users are out of luck as pexpect does not run there.
281 Windows users are out of luck as pexpect does not run there.
282
282
283 Dependencies for IPython.parallel (parallel computing)
283 Dependencies for IPython.parallel (parallel computing)
284 ======================================================
284 ======================================================
285
285
286 IPython.parallel provides a nice architecture for parallel computing, with a
286 IPython.parallel provides a nice architecture for parallel computing, with a
287 focus on fluid interactive workflows. These features require just one package:
287 focus on fluid interactive workflows. These features require just one package:
288 PyZMQ. See the next section for PyZMQ details.
288 PyZMQ. See the next section for PyZMQ details.
289
289
290 On a Unix style platform (including OS X), if you want to use
290 On a Unix style platform (including OS X), if you want to use
291 :mod:`setuptools`, you can just do:
291 :mod:`setuptools`, you can just do:
292
292
293 .. code-block:: bash
293 .. code-block:: bash
294
294
295 $ easy_install ipython[zmq] # will include pyzmq
295 $ easy_install ipython[zmq] # will include pyzmq
296
296
297 Security in IPython.parallel is provided by SSH tunnels. By default, Linux
297 Security in IPython.parallel is provided by SSH tunnels. By default, Linux
298 and OSX clients will use the shell ssh command, but on Windows, we also
298 and OSX clients will use the shell ssh command, but on Windows, we also
299 support tunneling with paramiko_.
299 support tunneling with paramiko_.
300
300
301 Dependencies for IPython.kernel.zmq
301 Dependencies for IPython.kernel.zmq
302 ===================================
302 ===================================
303
303
304 pyzmq
304 pyzmq
305 -----
305 -----
306
306
307 IPython 0.11 introduced some new functionality, including a two-process
307 IPython 0.11 introduced some new functionality, including a two-process
308 execution model using ZeroMQ_ for communication. The Python bindings to ZeroMQ
308 execution model using ZeroMQ_ for communication. The Python bindings to ZeroMQ
309 are found in the PyZMQ_ project, which is easy_install-able once you have
309 are found in the PyZMQ_ project, which is easy_install-able once you have
310 ZeroMQ installed. If you are on Python 2.6 or 2.7 on OSX, or 2.7 on Windows,
310 ZeroMQ installed. If you are on Python 2.6 or 2.7 on OSX, or 2.7 on Windows,
311 pyzmq has eggs that include ZeroMQ itself.
311 pyzmq has eggs that include ZeroMQ itself.
312
312
313 IPython.kernel.zmq depends on pyzmq >= 2.1.4.
313 IPython.kernel.zmq depends on pyzmq >= 2.1.4.
314
314
315 Dependencies for the IPython QT console
315 Dependencies for the IPython QT console
316 =======================================
316 =======================================
317
317
318 pyzmq
318 pyzmq
319 -----
319 -----
320
320
321 Like the :mod:`IPython.parallel` package, the QT Console requires ZeroMQ and
321 Like the :mod:`IPython.parallel` package, the QT Console requires ZeroMQ and
322 PyZMQ.
322 PyZMQ.
323
323
324 Qt
324 Qt
325 --
325 --
326
326
327 Also with 0.11, a new GUI was added using the work in :mod:`IPython.kernel.zmq`, which
327 Also with 0.11, a new GUI was added using the work in :mod:`IPython.kernel.zmq`, which
328 can be launched with ``ipython qtconsole``. The GUI is built on Qt, and works
328 can be launched with ``ipython qtconsole``. The GUI is built on Qt, and works
329 with either PyQt, which can be installed from the `PyQt website
329 with either PyQt, which can be installed from the `PyQt website
330 <http://www.riverbankcomputing.co.uk/>`_, or `PySide
330 <http://www.riverbankcomputing.co.uk/>`_, or `PySide
331 <http://www.pyside.org/>`_, from Nokia.
331 <http://www.pyside.org/>`_, from Nokia.
332
332
333 pygments
333 pygments
334 --------
334 --------
335
335
336 The syntax-highlighting in ``ipython qtconsole`` is done with the pygments_
336 The syntax-highlighting in ``ipython qtconsole`` is done with the pygments_
337 project, which is easy_install-able.
337 project, which is easy_install-able.
338
338
339 .. _installnotebook:
339 .. _installnotebook:
340
340
341 Dependencies for the IPython HTML notebook
341 Dependencies for the IPython HTML notebook
342 ==========================================
342 ==========================================
343
343
344 The IPython notebook is a notebook-style web interface to IPython and can be
344 The IPython notebook is a notebook-style web interface to IPython and can be
345 started with the command ``ipython notebook``.
345 started with the command ``ipython notebook``.
346
346
347 pyzmq
347 pyzmq
348 -----
348 -----
349
349
350 Like the :mod:`IPython.parallel` and :mod:`IPython.frontend.qt.console`
350 Like the :mod:`IPython.parallel` and :mod:`IPython.frontend.qt.console`
351 packages, the HTML notebook requires ZeroMQ and PyZMQ.
351 packages, the HTML notebook requires ZeroMQ and PyZMQ.
352
352
353 Tornado
353 Tornado
354 -------
354 -------
355
355
356 The IPython notebook uses the Tornado_ project for its HTTP server. Tornado 2.1
356 The IPython notebook uses the Tornado_ project for its HTTP server. Tornado 2.1
357 is required, in order to support current versions of browsers, due to an update
357 is required, in order to support current versions of browsers, due to an update
358 to the websocket protocol.
358 to the websocket protocol.
359
359
360 Jinja
360 Jinja
361 -----
361 -----
362
362
363 The IPython notebook uses the Jinja_ templating tool to render HTML pages.
363 The IPython notebook uses the Jinja_ templating tool to render HTML pages.
364
364
365
365
366 MathJax
366 MathJax
367 -------
367 -------
368
368
369 The IPython notebook uses the MathJax_ Javascript library for rendering LaTeX
369 The IPython notebook uses the MathJax_ Javascript library for rendering LaTeX
370 in web browsers. Because MathJax is large, we don't include it with
370 in web browsers. Because MathJax is large, we don't include it with
371 IPython. Normally IPython will load MathJax from a CDN, but if you have a slow
371 IPython. Normally IPython will load MathJax from a CDN, but if you have a slow
372 network connection, or want to use LaTeX without an internet connection at all,
372 network connection, or want to use LaTeX without an internet connection at all,
373 you can install MathJax locally.
373 you can install MathJax locally.
374
374
375 A quick and easy method is to install it from a python session::
375 A quick and easy method is to install it from a python session::
376
376
377 from IPython.external.mathjax import install_mathjax
377 from IPython.external.mathjax import install_mathjax
378 install_mathjax()
378 install_mathjax()
379
379
380 If you need tighter configuration control, you can download your own copy
380 If you need tighter configuration control, you can download your own copy
381 of MathJax from http://www.mathjax.org/download/ - use the MathJax-2.0 link.
381 of MathJax from http://www.mathjax.org/download/ - use the MathJax-2.0 link.
382 When you have the file stored locally, install it with::
382 When you have the file stored locally, install it with::
383
383
384 python -m IPython.external.mathjax /path/to/source/mathjax-MathJax-v2.0-20-g07669ac.zip
384 python -m IPython.external.mathjax /path/to/source/mathjax-MathJax-v2.0-20-g07669ac.zip
385
385
386 For unusual needs, IPython can tell you what directory it wants to find MathJax in::
386 For unusual needs, IPython can tell you what directory it wants to find MathJax in::
387
387
388 python -m IPython.external.mathjax -d /some/other/mathjax
388 python -m IPython.external.mathjax -d /some/other/mathjax
389
389
390 By default Mathjax will be installed in your ipython profile directory, but you
390 By default Mathjax will be installed in your ipython profile directory, but you
391 can make system wide install, please refer to the documentation and helper function
391 can make system wide install, please refer to the documentation and helper function
392 of :mod:`IPython.external.mathjax`
392 of :mod:`IPython.external.mathjax`
393
393
394 Browser Compatibility
394 Browser Compatibility
395 ---------------------
395 ---------------------
396
396
397 The IPython notebook is officially supported on the following browers:
397 The IPython notebook is officially supported on the following browers:
398
398
399 * Chrome ≥ 13
399 * Chrome ≥ 13
400 * Safari ≥ 5
400 * Safari ≥ 5
401 * Firefox ≥ 6
401 * Firefox ≥ 6
402
402
403 The is mainly due to the notebook's usage of WebSockets and the flexible box model.
403 The is mainly due to the notebook's usage of WebSockets and the flexible box model.
404
404
405 The following browsers are unsupported:
405 The following browsers are unsupported:
406
406
407 * Safari < 5
407 * Safari < 5
408 * Firefox < 6
408 * Firefox < 6
409 * Chrome < 13
409 * Chrome < 13
410 * Opera (any): CSS issues, but execution might work
410 * Opera (any): CSS issues, but execution might work
411 * Internet Explorer < 10
411 * Internet Explorer < 10
412
412
413 The following specific combinations are known **NOT** to work:
413 The following specific combinations are known **NOT** to work:
414
414
415 * Safari, IPython 0.12, tornado ≥ 2.2.0
415 * Safari, IPython 0.12, tornado ≥ 2.2.0
416 * Safari with HTTPS connection to notebook and an untrusted certificate (websockets will fail)
416 * Safari with HTTPS connection to notebook and an untrusted certificate (websockets will fail)
417 * The [diigo Chrome extension](http://help.diigo.com/tools/chrome-extension) seems to interfere with scrolling
417 * The [diigo Chrome extension](http://help.diigo.com/tools/chrome-extension) seems to interfere with scrolling
418
418
419 There are some early reports that the Notebook works on Internet Explorer 10, but we
419 There are some early reports that the Notebook works on Internet Explorer 10, but we
420 expect there will be some CSS issues related to the flexible box model.
420 expect there will be some CSS issues related to the flexible box model.
421
421
422
422
423 Dependencies for nbconvert (converting notebooks to various formats)
423 Dependencies for nbconvert (converting notebooks to various formats)
424 ====================================================================
424 ====================================================================
425
425
426 pandoc
426 pandoc
427 ------
427 ------
428
428
429 The most important dependency of nbconvert is Pandoc_, a document format translation program.
429 The most important dependency of nbconvert is Pandoc_ 1.10 or later, a document format translation program.
430 This is not a Python package, so it cannot be expressed as a regular IPython dependency with setuptools.
430 This is not a Python package, so it cannot be expressed as a regular IPython dependency with setuptools.
431
431
432 To install pandoc on Linux, you can generally use your package manager::
432 To install pandoc on Linux, you can generally use your package manager::
433
433
434 sudo apt-get install pandoc
434 sudo apt-get install pandoc
435
435
436 On other platforms, you can get pandoc from `their website <http://johnmacfarlane.net/pandoc/installing.html>`_.
436 On other platforms, you can get pandoc from `their website <http://johnmacfarlane.net/pandoc/installing.html>`_.
437
437
438
438
439 .. _ZeroMQ: http://www.zeromq.org
439 .. _ZeroMQ: http://www.zeromq.org
440 .. _PyZMQ: https://github.com/zeromq/pyzmq
440 .. _PyZMQ: https://github.com/zeromq/pyzmq
441 .. _paramiko: https://github.com/robey/paramiko
441 .. _paramiko: https://github.com/robey/paramiko
442 .. _pygments: http://pygments.org
442 .. _pygments: http://pygments.org
443 .. _pexpect: http://www.noah.org/wiki/Pexpect
443 .. _pexpect: http://www.noah.org/wiki/Pexpect
444 .. _Jinja: http://jinja.pocoo.org
444 .. _Jinja: http://jinja.pocoo.org
445 .. _Sphinx: http://sphinx-doc.org
445 .. _Sphinx: http://sphinx-doc.org
446 .. _pandoc: http://johnmacfarlane.net/pandoc
446 .. _pandoc: http://johnmacfarlane.net/pandoc
447 .. _Tornado: http://www.tornadoweb.org
447 .. _Tornado: http://www.tornadoweb.org
448 .. _MathJax: http://www.mathjax.org
448 .. _MathJax: http://www.mathjax.org
General Comments 0
You need to be logged in to leave comments. Login now