IPython requires Python 2.7 or ≥ 3.3.
Note
If you need to use Python 2.6 or 3.2, you can find IPython 1.xhere,or get it with pip:
pip install 'ipython<2'
If you have pip,the quickest way to get up and running with IPython is:
$ pip install "ipython[all]"
This will download and install IPython and its main optional dependencies for the notebook,qtconsole, tests, and other functionality.Some dependencies (Qt, PyQt for the QtConsole, pandoc for nbconvert) are not pip-installable,and will not be pulled in by pip.
To run IPython’s test suite, use the iptest command:
$ iptest
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 the install page of the IPython website.
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 andinstall them separately. However, to use a given subpackage, you will need toinstall all of its dependencies.
Please let us know if you have problems installing IPython or any of its dependencies.
IPython and most dependencies can be installed via pip.In many scenarios, this is the simplest method of installing Python packages.More information about pip can be found onits PyPI page.
More general information about installing Python packages can be found inPython’s documentation.
Given a properly built Python, the basic interactive IPython shell will workwith no external dependencies. However, some Python distributions(particularly on Windows and OS X), don’t come with a working readlinemodule. The IPython shell will work without readline, but will lackmany features that users depend on, such as tab completion and command lineediting. If you install IPython with pip,then the appropriate readline for your platform will be installed.See below for details of how to make sure you have a working readline.
If you have pip, the easiest way of getting IPython is:
$ pip install ipython
That’s it.
If you don’t want to use pip, or don’t have it installed,grab the latest stable build of IPython from here. Then do the following:
$ tar -xzf ipython.tar.gz$ cd ipython$ python setup.py install
If you are installing to a location (like /usr/local) that requires higherpermissions, you may need to run the last command with sudo.
It is also possible to install the development version of IPython from ourGit source code repository. To do this you willneed to have Git installed on your system. Then do:
$ git clone --recursive https://github.com/ipython/ipython.git$ cd ipython$ python setup.py install
Some users want to be able to follow the development branch as it changes. Ifyou have pip, you can replace the last step by:
$ pip install -e .
This creates links in the right places and installs the command line script tothe appropriate places.
Then, if you want to update your IPython at any time, do:
$ git pull
IPython now uses git submodules to ship its javascript dependencies. If you runIPython from git master, you may need to update submodules once in a while with:
$ git submodule update
or
$ python setup.py submodule
Another option is to copy git hooksto your ./git/hooks/ directory to ensure that your submodules are up to date on each pull.
There are a number of basic optional dependencies that most users will want toget. These are:
If you are comfortable installing these things yourself, have at it, otherwiseread on for more details.
IPython uses several other modules, such as pexpect and path.py, if they areinstalled on your system, but it can also use bundled versions fromIPython.external, so there’s no need to install them separately.
As indicated above, on Windows, to get full functionality in the consoleversion of IPython, PyReadline is needed.PyReadline is a separate, Windows only implementation of readline that usesnative Windows calls through ctypes. The easiest way of installingPyReadline is you use the binary installer available here.
On OS X, if you are using the built-in Python shipped by Apple, you will bemissing a proper readline implementation as Apple ships instead a library calledlibedit that provides only some of readline’s functionality. While you mayfind libedit sufficient, we have occasional reports of bugs with it and severaldevelopers who use OS X as their main environment consider libedit unacceptablefor productive, regular use with IPython.
Therefore, IPython on OS X depends on the gnureadline module.We will not consider completion/history problems to be bugs for IPython if you are using libedit.
To get a working readline module on OS X, do (with pipinstalled):
$ pip install gnureadline
Note
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.
When IPython is installed with pip,the correct readline should be installed if you specify the terminaloptional dependencies:
$ pip install "ipython[terminal]"
To run the IPython test suite you will need the nose package. Noseprovides a great way of sniffing out and running all of the IPython tests. Thesimplest way of getting nose is to use pip:
$ pip install nose
Another way of getting this is to do:
$ pip install "ipython[test]"
For more installation options, see the nose website.
Once you have nose installed, you can run IPython’s test suite using theiptest command:
$ iptest
IPython’s inter-process communication uses the PyZMQ bindings for the ZeroMQ messaging library.This is the only dependency for IPython.parallel.
Shortcut:
pip install "ipython[parallel]"
or manual
pip install pyzmq
PyZMQ provides wheels for current Python on OS X and Windows, so installing pyzmq will typically not require compilation.
IPython.parallel can use SSH tunnels, which require paramiko on Windows.
pyzmq, pygments, PyQt (or PySide)
Shortcut:
pip install "ipython[qtconsole]"
or manual
pip install pyzmq pygments
PyQt/PySide are not pip installable, so generally must be installed via system package managers (or conda).
The HTML notebook is a complex web application with quite a few dependencies:
pyzmq, jinja2, tornado, mistune, jsonschema, pygments, terminado
Shortcut:
pip install "ipython[notebook]"
or manual:
pip install pyzmq jinja2 tornado mistune jsonschema pygments terminado
The IPython notebook is a notebook-style web interface to IPython and can bestarted with the command ipython notebook.
The IPython notebook uses the MathJax Javascript library for rendering LaTeXin web browsers. Because MathJax is large, we don’t include it withIPython. Normally IPython will load MathJax from a CDN, but if you have a slownetwork connection, or want to use LaTeX without an internet connection at all,you can install MathJax locally.
A quick and easy method is to install it from a python session:
python -m IPython.external.mathjax
If you need tighter configuration control, you can download your own copyof MathJax from http://www.mathjax.org/download/ - use the MathJax-2.0 link.When you have the file stored locally, install it with:
python -m IPython.external.mathjax /path/to/source/mathjax-MathJax-v2.0-20-g07669ac.zip
For unusual needs, IPython can tell you what directory it wants to find MathJax in:
python -m IPython.external.mathjax -d /some/other/mathjax
By default MathJax will be installed in your ipython directory, but youcan install MathJax system-wide. Please refer to the documentationof IPython.external.mathjax
The IPython notebook is officially supported on the following browsers:
The is mainly due to the notebook’s usage of WebSockets and the flexible box model.
The following browsers are unsupported:
Using Safari with HTTPS and an untrusted certificate is known to not work (websockets will fail).
For converting markdown to formats other than HTML, nbconvert uses Pandoc (1.12.1 or later).
To install pandoc on Linux, you can generally use your package manager:
sudo apt-get install pandoc
On other platforms, you can get pandoc from their website.
联系客服
