<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Quickstart — IPython 2.3.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="IPython 2.3.0 documentation" href="../index.html" />
<link rel="up" title="Installation" href="index.html" />
<link rel="next" title="Using IPython for interactive work" href="../interactive/index.html" />
<link rel="prev" title="Installation" href="index.html" />
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="http://ipython.org/"><img src="../_static/logo.png" border="0" alt="IPython Documentation"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../interactive/index.html" title="Using IPython for interactive work"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Installation"
accesskey="P">previous</a> |</li>
<li><a href="http://ipython.org">home</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="../index.html">documentation </a> »</li>
<li><a href="index.html" accesskey="U">Installation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Quickstart</a></li>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#installing-ipython-itself">Installing IPython itself</a><ul>
<li><a class="reference internal" href="#installation-using-pip">Installation using pip</a></li>
<li><a class="reference internal" href="#installation-from-source">Installation from source</a></li>
<li><a class="reference internal" href="#windows">Windows</a></li>
<li><a class="reference internal" href="#installing-the-development-version">Installing the development version</a></li>
</ul>
</li>
<li><a class="reference internal" href="#basic-optional-dependencies">Basic optional dependencies</a><ul>
<li><a class="reference internal" href="#readline">readline</a></li>
<li><a class="reference internal" href="#nose">nose</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dependencies-for-ipython-parallel-parallel-computing">Dependencies for IPython.parallel (parallel computing)</a></li>
<li><a class="reference internal" href="#dependencies-for-ipython-kernel-zmq">Dependencies for IPython.kernel.zmq</a><ul>
<li><a class="reference internal" href="#pyzmq">pyzmq</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dependencies-for-the-ipython-qt-console">Dependencies for the IPython QT console</a><ul>
<li><a class="reference internal" href="#id1">pyzmq</a></li>
<li><a class="reference internal" href="#qt">Qt</a></li>
<li><a class="reference internal" href="#pygments">pygments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dependencies-for-the-ipython-html-notebook">Dependencies for the IPython HTML notebook</a><ul>
<li><a class="reference internal" href="#id2">pyzmq</a></li>
<li><a class="reference internal" href="#tornado">Tornado</a></li>
<li><a class="reference internal" href="#jinja">Jinja</a></li>
<li><a class="reference internal" href="#mathjax">MathJax</a></li>
<li><a class="reference internal" href="#browser-compatibility">Browser Compatibility</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dependencies-for-nbconvert-converting-notebooks-to-various-formats">Dependencies for nbconvert (converting notebooks to various formats)</a><ul>
<li><a class="reference internal" href="#pandoc">pandoc</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Installation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../interactive/index.html"
title="next chapter">Using IPython for interactive work</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/install/install.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<p>IPython requires Python 2.7 or ≥ 3.3.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you need to use Python 2.6 or 3.2, you can find IPython 1.0
<a class="reference external" href="http://archive.ipython.org/release/">here</a>.</p>
</div>
<div class="section" id="quickstart">
<h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
<p>If you have <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt>,
the quickest way to get up and running with IPython is:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install ipython<span class="o">[</span>all<span class="o">]</span>
</pre></div>
</div>
<p>This will download and install IPython and its main optional dependencies:</p>
<ul class="simple">
<li>jinja2, needed for the notebook</li>
<li>sphinx, needed for nbconvert</li>
<li>pyzmq, needed for IPython’s parallel computing features, qt console and
notebook</li>
<li>pygments, used by nbconvert and the Qt console for syntax highlighting</li>
<li>tornado, needed by the web-based notebook</li>
<li>nose, used by the test suite</li>
<li>readline (on OS X) or pyreadline (on Windows), needed for the terminal</li>
</ul>
<p>To run IPython’s test suite, use the <strong class="command">iptest</strong> command:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>iptest
</pre></div>
</div>
</div>
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p>This document describes in detail the steps required to install IPython,
and its various optional dependencies.
For a few quick ways to get started with package managers or full Python distributions,
see <a class="reference external" href="http://ipython.org/install.html">the install page</a> of the IPython website.</p>
<p>IPython is organized into a number of subpackages, each of which has its own dependencies.
All of the subpackages come with IPython, so you don’t need to download and
install them separately. However, to use a given subpackage, you will need to
install all of its dependencies.</p>
<p>Please let us know if you have problems installing IPython or any of its dependencies.</p>
<p>IPython and most dependencies can be installed via <strong class="command">pip</strong>.
In many scenarios, this is the simplest method of installing Python packages.
More information about <tt class="xref py py-mod docutils literal"><span class="pre">pip</span></tt> can be found on
<a class="reference external" href="http://pypi.python.org/pypi/pip">its PyPI page</a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">On Windows, IPython <em>requires</em> <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt>. We hope to
change this in the future, but for now on Windows, you <em>must</em> install
<tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt> to use IPython.</p>
</div>
<p>More general information about installing Python packages can be found in
<a class="reference external" href="http://docs.python.org">Python’s documentation</a>.</p>
</div>
<div class="section" id="installing-ipython-itself">
<h1>Installing IPython itself<a class="headerlink" href="#installing-ipython-itself" title="Permalink to this headline">¶</a></h1>
<p>Given a properly built Python, the basic interactive IPython shell will work
with no external dependencies. However, some Python distributions
(particularly on Windows and OS X), don’t come with a working <a class="reference external" href="http://docs.python.org/2/library/readline.html#module-readline" title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">readline</span></tt></a>
module. The IPython shell will work without <a class="reference external" href="http://docs.python.org/2/library/readline.html#module-readline" title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">readline</span></tt></a>, but will lack
many features that users depend on, such as tab completion and command line
editing. If you install IPython with <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt>, (e.g. with
<cite>pip</cite>), then the appropriate <a class="reference external" href="http://docs.python.org/2/library/readline.html#module-readline" title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">readline</span></tt></a> for your platform will be
installed. See below for details of how to make sure you have a working
<a class="reference external" href="http://docs.python.org/2/library/readline.html#module-readline" title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">readline</span></tt></a>.</p>
<div class="section" id="installation-using-pip">
<h2>Installation using pip<a class="headerlink" href="#installation-using-pip" title="Permalink to this headline">¶</a></h2>
<p>If you have <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt> or <tt class="xref py py-mod docutils literal"><span class="pre">pip</span></tt>, the easiest way of getting IPython is
to simply use <strong class="command">pip</strong>:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install ipython
</pre></div>
</div>
<p>That’s it.</p>
</div>
<div class="section" id="installation-from-source">
<h2>Installation from source<a class="headerlink" href="#installation-from-source" title="Permalink to this headline">¶</a></h2>
<p>If you don’t want to use <strong class="command">pip</strong>, or don’t have it installed,
just grab the latest stable build of IPython from <a class="reference external" href="http://ipython.org/download.html">here</a>. Then do the following:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>tar -xzf ipython.tar.gz
<span class="nv">$ </span><span class="nb">cd </span>ipython
<span class="nv">$ </span>python setup.py install
</pre></div>
</div>
<p>If you are installing to a location (like <tt class="docutils literal"><span class="pre">/usr/local</span></tt>) that requires higher
permissions, you may need to run the last command with <strong class="command">sudo</strong>.</p>
</div>
<div class="section" id="windows">
<h2>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h2>
<p>As mentioned above, on Windows, IPython requires <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt>, and it also
requires the PyReadline library to properly support coloring and keyboard
management (features that the default windows console doesn’t have). So on
Windows, the installation procedure is:</p>
<ol class="arabic simple">
<li>Install <a class="reference external" href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</li>
<li>Install <a class="reference external" href="http://pypi.python.org/pypi/pyreadline">pyreadline</a>. You can use
the command <tt class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pyreadline</span></tt> from a terminal, or the binary
installer appropriate for your platform from the PyPI page.</li>
<li>Install IPython itself, which you can download from <a class="reference external" href="http://pypi.python.org/pypi/ipython">PyPI</a> or from <a class="reference external" href="http://ipython.org/download.html">our site</a>. Note that on Windows 7, you <em>must</em>
right-click and ‘Run as administrator’ for the Start menu shortcuts to be
created.</li>
</ol>
<p>IPython by default runs in a terminal window, but the normal terminal
application supplied by Microsoft Windows is very primitive. You may want to
download the excellent and free <a class="reference external" href="http://sourceforge.net/projects/console">Console</a> application instead, which is a far
superior tool. You can even configure Console to give you by default an
IPython tab, which is very convenient to create new IPython sessions directly
from the working terminal.</p>
</div>
<div class="section" id="installing-the-development-version">
<h2>Installing the development version<a class="headerlink" href="#installing-the-development-version" title="Permalink to this headline">¶</a></h2>
<p>It is also possible to install the development version of IPython from our
<a class="reference external" href="http://git-scm.com/">Git</a> source code repository. To do this you will
need to have Git installed on your system. Then just do:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>git clone --recursive https://github.com/ipython/ipython.git
<span class="nv">$ </span><span class="nb">cd </span>ipython
<span class="nv">$ </span>python setup.py install
</pre></div>
</div>
<p>Some users want to be able to follow the development branch as it changes. If
you have <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt> installed, this is easy. Simply replace the last
step by:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python setupegg.py develop
</pre></div>
</div>
<p>This creates links in the right places and installs the command line script to
the appropriate places.</p>
<p>Then, if you want to update your IPython at any time,
just do:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>git pull
</pre></div>
</div>
<p>IPython now uses git submodules to ship its javascript dependencies. If you run
IPython from git master, you may need to update submodules once in a while with:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>git submodule update
</pre></div>
</div>
<p>or</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python setup.py submodule
</pre></div>
</div>
<p>Another option is to copy <a class="reference external" href="https://github.com/ipython/ipython/tree/master/git-hooks">git hooks</a>
to your <tt class="docutils literal"><span class="pre">./git/hooks/</span></tt> directory to ensure that your submodules are up to date on each pull.</p>
</div>
</div>
<div class="section" id="basic-optional-dependencies">
<h1>Basic optional dependencies<a class="headerlink" href="#basic-optional-dependencies" title="Permalink to this headline">¶</a></h1>
<p>There are a number of basic optional dependencies that most users will want to
get. These are:</p>
<ul class="simple">
<li>readline (for command line editing, tab completion, etc.)</li>
<li>nose (to run the IPython test suite)</li>
</ul>
<p>If you are comfortable installing these things yourself, have at it, otherwise
read on for more details.</p>
<p>IPython uses several other modules, such as <a class="reference external" href="http://pexpect.readthedocs.org/en/latest/">pexpect</a> and path.py, if they are
installed on your system, but it can also use bundled versions from
<tt class="xref py py-mod docutils literal"><span class="pre">IPython.external</span></tt>, so there’s no need to install them separately.</p>
<div class="section" id="readline">
<h2>readline<a class="headerlink" href="#readline" title="Permalink to this headline">¶</a></h2>
<p>As indicated above, on Windows, to get full functionality in the console
version of IPython, PyReadline is needed.
PyReadline is a separate, Windows only implementation of readline that uses
native Windows calls through <a class="reference external" href="http://docs.python.org/2/library/ctypes.html#module-ctypes" title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">ctypes</span></tt></a>. The easiest way of installing
PyReadline is you use the binary installer available <a class="reference external" href="http://pypi.python.org/pypi/pyreadline">here</a>.</p>
<p>On OSX, if you are using the built-in Python shipped by Apple, you will be
missing a proper readline implementation as Apple ships instead a library called
<tt class="docutils literal"><span class="pre">libedit</span></tt> that provides only some of readline’s functionality. While you may
find libedit sufficient, we have occasional reports of bugs with it and several
developers who use OS X as their main environment consider libedit unacceptable
for productive, regular use with IPython.</p>
<p>Therefore, IPython on OS X depends on the <tt class="xref py py-mod docutils literal"><span class="pre">gnureadline</span></tt> module.
We will <em>not</em> consider completion/history problems to be bugs for IPython if you are using libedit.</p>
<p>To get a working <a class="reference external" href="http://docs.python.org/2/library/readline.html#module-readline" title="(in Python v2.7)"><tt class="xref py py-mod docutils literal"><span class="pre">readline</span></tt></a> module on OS X, just do (with <tt class="xref py py-mod docutils literal"><span class="pre">pip</span></tt>
installed):</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install gnureadline
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Other Python distributions on OS X (such as Anaconda, fink, MacPorts)
already have proper readline so you likely don’t have to do this step.</p>
</div>
<p>When IPython is installed with <tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt>, (e.g. using the
<tt class="docutils literal"><span class="pre">pip</span></tt> command), the correct readline should be installed if you specify the <cite>terminal</cite>
optional dependencies:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install ipython<span class="o">[</span>terminal<span class="o">]</span>
</pre></div>
</div>
</div>
<div class="section" id="nose">
<h2>nose<a class="headerlink" href="#nose" title="Permalink to this headline">¶</a></h2>
<p>To run the IPython test suite you will need the <tt class="xref py py-mod docutils literal"><span class="pre">nose</span></tt> package. Nose
provides a great way of sniffing out and running all of the IPython tests. The
simplest way of getting nose is to use <strong class="command">pip</strong>:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install nose
</pre></div>
</div>
<p>Another way of getting this is to do:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install ipython<span class="o">[</span><span class="nb">test</span><span class="o">]</span>
</pre></div>
</div>
<p>For more installation options, see the <a class="reference external" href="http://somethingaboutorange.com/mrl/projects/nose/">nose website</a>.</p>
<p>Once you have nose installed, you can run IPython’s test suite using the
iptest command:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>iptest
</pre></div>
</div>
</div>
</div>
<div class="section" id="dependencies-for-ipython-parallel-parallel-computing">
<h1>Dependencies for IPython.parallel (parallel computing)<a class="headerlink" href="#dependencies-for-ipython-parallel-parallel-computing" title="Permalink to this headline">¶</a></h1>
<p>IPython.parallel provides a nice architecture for parallel computing, with a
focus on fluid interactive workflows. These features require just one package:
PyZMQ. See the next section for PyZMQ details.</p>
<p>On a Unix style platform (including OS X), if you want to use
<tt class="xref py py-mod docutils literal"><span class="pre">setuptools</span></tt>, you can just do:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install ipython<span class="o">[</span>zmq<span class="o">]</span> <span class="c"># will include pyzmq</span>
</pre></div>
</div>
<p>Security in IPython.parallel is provided by SSH tunnels. By default, Linux
and OSX clients will use the shell ssh command, but on Windows, we also
support tunneling with <a class="reference external" href="https://github.com/robey/paramiko">paramiko</a>.</p>
</div>
<div class="section" id="dependencies-for-ipython-kernel-zmq">
<h1>Dependencies for IPython.kernel.zmq<a class="headerlink" href="#dependencies-for-ipython-kernel-zmq" title="Permalink to this headline">¶</a></h1>
<div class="section" id="pyzmq">
<h2>pyzmq<a class="headerlink" href="#pyzmq" title="Permalink to this headline">¶</a></h2>
<p>IPython 0.11 introduced some new functionality, including a two-process
execution model using <a class="reference external" href="http://www.zeromq.org">ZeroMQ</a> for communication. The Python bindings to ZeroMQ
are found in the <a class="reference external" href="https://github.com/zeromq/pyzmq">PyZMQ</a> project, which is pip install-able.
If you are on Python 2.7, 3.3, or 3.4 on OSX or Windows,
pyzmq has eggs and wheels that include ZeroMQ itself.</p>
<p>IPython.kernel.zmq depends on pyzmq >= 2.2.</p>
</div>
</div>
<div class="section" id="dependencies-for-the-ipython-qt-console">
<h1>Dependencies for the IPython QT console<a class="headerlink" href="#dependencies-for-the-ipython-qt-console" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id1">
<h2>pyzmq<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>Like the <a class="reference internal" href="../api/generated/IPython.parallel.html#module-IPython.parallel" title="IPython.parallel"><tt class="xref py py-mod docutils literal"><span class="pre">IPython.parallel</span></tt></a> package, the QT Console requires ZeroMQ and
PyZMQ.</p>
</div>
<div class="section" id="qt">
<h2>Qt<a class="headerlink" href="#qt" title="Permalink to this headline">¶</a></h2>
<p>Also with 0.11, a new GUI was added using the work in <tt class="xref py py-mod docutils literal"><span class="pre">IPython.kernel.zmq</span></tt>, which
can be launched with <tt class="docutils literal"><span class="pre">ipython</span> <span class="pre">qtconsole</span></tt>. The GUI is built on Qt, and works
with either PyQt, which can be installed from the <a class="reference external" href="http://www.riverbankcomputing.co.uk/">PyQt website</a>, or <a class="reference external" href="http://www.pyside.org/">PySide</a>, from Nokia.</p>
</div>
<div class="section" id="pygments">
<h2>pygments<a class="headerlink" href="#pygments" title="Permalink to this headline">¶</a></h2>
<p>The syntax-highlighting in <tt class="docutils literal"><span class="pre">ipython</span> <span class="pre">qtconsole</span></tt> is done with the <a class="reference external" href="http://pygments.org">pygments</a>
project, which is pip install-able.</p>
</div>
</div>
<div class="section" id="dependencies-for-the-ipython-html-notebook">
<span id="installnotebook"></span><h1>Dependencies for the IPython HTML notebook<a class="headerlink" href="#dependencies-for-the-ipython-html-notebook" title="Permalink to this headline">¶</a></h1>
<p>The IPython notebook is a notebook-style web interface to IPython and can be
started with the command <tt class="docutils literal"><span class="pre">ipython</span> <span class="pre">notebook</span></tt>.</p>
<div class="section" id="id2">
<h2>pyzmq<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
<p>Like the <a class="reference internal" href="../api/generated/IPython.parallel.html#module-IPython.parallel" title="IPython.parallel"><tt class="xref py py-mod docutils literal"><span class="pre">IPython.parallel</span></tt></a> and <tt class="xref py py-mod docutils literal"><span class="pre">IPython.frontend.qt.console</span></tt>
packages, the HTML notebook requires ZeroMQ and PyZMQ.</p>
</div>
<div class="section" id="tornado">
<h2>Tornado<a class="headerlink" href="#tornado" title="Permalink to this headline">¶</a></h2>
<p>The IPython notebook uses the <a class="reference external" href="http://www.tornadoweb.org">Tornado</a> project for its HTTP server. Tornado 2.1
is required, in order to support current versions of browsers, due to an update
to the websocket protocol.</p>
</div>
<div class="section" id="jinja">
<h2>Jinja<a class="headerlink" href="#jinja" title="Permalink to this headline">¶</a></h2>
<p>The IPython notebook uses the <a class="reference external" href="http://jinja.pocoo.org">Jinja</a> templating tool to render HTML pages.</p>
</div>
<div class="section" id="mathjax">
<h2>MathJax<a class="headerlink" href="#mathjax" title="Permalink to this headline">¶</a></h2>
<p>The IPython notebook uses the <a class="reference external" href="http://www.mathjax.org">MathJax</a> Javascript library for rendering LaTeX
in web browsers. Because MathJax is large, we don’t include it with
IPython. Normally IPython will load MathJax from a CDN, but if you have a slow
network connection, or want to use LaTeX without an internet connection at all,
you can install MathJax locally.</p>
<p>A quick and easy method is to install it from a python session:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">IPython.external.mathjax</span> <span class="kn">import</span> <span class="n">install_mathjax</span>
<span class="n">install_mathjax</span><span class="p">()</span>
</pre></div>
</div>
<p>If you need tighter configuration control, you can download your own copy
of MathJax from <a class="reference external" href="http://www.mathjax.org/download/">http://www.mathjax.org/download/</a> - use the MathJax-2.0 link.
When you have the file stored locally, install it with:</p>
<div class="highlight-python"><div class="highlight"><pre>python -m IPython.external.mathjax /path/to/source/mathjax-MathJax-v2.0-20-g07669ac.zip
</pre></div>
</div>
<p>For unusual needs, IPython can tell you what directory it wants to find MathJax in:</p>
<div class="highlight-python"><div class="highlight"><pre>python -m IPython.external.mathjax -d /some/other/mathjax
</pre></div>
</div>
<p>By default Mathjax will be installed in your ipython profile directory, but you
can make system wide install, please refer to the documentation and helper function
of <tt class="xref py py-mod docutils literal"><span class="pre">IPython.external.mathjax</span></tt></p>
</div>
<div class="section" id="browser-compatibility">
<h2>Browser Compatibility<a class="headerlink" href="#browser-compatibility" title="Permalink to this headline">¶</a></h2>
<p>The IPython notebook is officially supported on the following browsers:</p>
<ul class="simple">
<li>Chrome ≥ 13</li>
<li>Safari ≥ 5</li>
<li>Firefox ≥ 6</li>
</ul>
<p>The is mainly due to the notebook’s usage of WebSockets and the flexible box model.</p>
<p>The following browsers are unsupported:</p>
<ul class="simple">
<li>Safari < 5</li>
<li>Firefox < 6</li>
<li>Chrome < 13</li>
<li>Opera (any): CSS issues, but execution might work</li>
<li>Internet Explorer < 10</li>
</ul>
<p>The following specific combinations are known <strong>NOT</strong> to work:</p>
<ul class="simple">
<li>Safari, IPython 0.12, tornado ≥ 2.2.0</li>
<li>Safari with HTTPS connection to notebook and an untrusted certificate (websockets will fail)</li>
<li>The <a class="reference external" href="http://help.diigo.com/tools/chrome-extension">diigo Chrome extension</a> seems to interfere with scrolling</li>
</ul>
<p>There are some early reports that the Notebook works on Internet Explorer 10, but we
expect there will be some CSS issues related to the flexible box model.</p>
</div>
</div>
<div class="section" id="dependencies-for-nbconvert-converting-notebooks-to-various-formats">
<h1>Dependencies for nbconvert (converting notebooks to various formats)<a class="headerlink" href="#dependencies-for-nbconvert-converting-notebooks-to-various-formats" title="Permalink to this headline">¶</a></h1>
<div class="section" id="pandoc">
<h2>pandoc<a class="headerlink" href="#pandoc" title="Permalink to this headline">¶</a></h2>
<p>The most important dependency of nbconvert is <a class="reference external" href="http://johnmacfarlane.net/pandoc">Pandoc</a> 1.10 or later, a document format translation program.
This is not a Python package, so it cannot be expressed as a regular IPython dependency with setuptools.</p>
<p>To install pandoc on Linux, you can generally use your package manager:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo apt-get install pandoc
</pre></div>
</div>
<p>On other platforms, you can get pandoc from <a class="reference external" href="http://johnmacfarlane.net/pandoc/installing.html">their website</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../interactive/index.html" title="Using IPython for interactive work"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Installation"
>previous</a> |</li>
<li><a href="http://ipython.org">home</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="../index.html">documentation </a> »</li>
<li><a href="index.html" >Installation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright The IPython Development Team.
Last updated on Sep 02, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
c044f82ec6193fba7e13c97913613b07
>
files
>
956
