Overview — IPython 0.11 documentation

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- Installation »

# Overview

This document describes the steps required to install IPython. 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.

Please let us know if you have problems installing IPython or any of its dependencies. Officially, IPython requires Python version 2.6 or 2.7. There is an experimental port of IPython for Python3 on GitHub

Warning

Officially, IPython supports Python versions 2.6 and 2.7.

IPython 0.11 has a hard syntax dependency on 2.6, and will no longer work on Python <= 2.5.

Some of the installation approaches use the `setuptools` package and its easy_install command line program. In many scenarios, this provides the most simple method of installing IPython and its dependencies. It is not required though. More information about `setuptools` can be found on its website.

Note

On Windows, IPython does depend on `setuptools`, and it is recommended that you install the `distribute` package, which improves `setuptools` and fixes various bugs.

We hope to remove this dependency in 0.12.

More general information about installing Python packages can be found in Python’s documentation at http://www.python.org/doc/.

# Quickstart

If you have `setuptools` installed and you are on OS X or Linux (not Windows), the following will download and install IPython and the main optional dependencies:

    $ easy_install ipython[zmq,test]

This will get pyzmq, which is needed for IPython’s parallel computing features as well as the nose package, which will enable you to run IPython’s test suite.

To run IPython’s test suite, use the iptest command:

    $ iptest

Read on for more specific details and instructions for Windows.

# Installing IPython itself

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 `readline` module. The IPython shell will work without `readline`, but will lack many features that users depend on, such as tab completion and command line editing. If you install IPython with `setuptools`, (e.g. with easy_install), then the appropriate `readline` for your platform will be installed. See below for details of how to make sure you have a working `readline`.

## Installation using easy_install

If you have `setuptools` installed, the easiest way of getting IPython is to simple use easy_install:

    $ easy_install ipython

That’s it.

## Installation from source

If you don’t want to use easy_install, or don’t have it installed, just 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 higher permissions, you may need to run the last command with sudo.

## Windows

Note

On Windows, IPython requires `setuptools` or `distribute`.

We hope to remove this dependency in 0.12.

There are a few caveats for Windows users. The main issue is that a basic `python setup.py install` approach won’t create `.bat` file or Start Menu shortcuts, which most users want. To get an installation with these, you can use any of the following alternatives:

1. Install using easy_install.
2. Install using our binary `.exe` Windows installer, which can be found here
3. Install from source, but using `setuptools` (`python setupegg.py install`).

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 Console 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.

Note for Windows 64 bit users: you may have difficulties with the stock installer on 64 bit systems; in this case (since we currently do not have 64 bit builds of the Windows installer) your best bet is to install from source with the setuptools method indicated in #3 above. See this bug report for further details.

## Installing the development version

It is also possible to install the development version of IPython from our Git source code repository. To do this you will need to have Git installed on your system. Then just do:

    $ git clone https://github.com/ipython/ipython.git
    $ cd ipython
    $ python setup.py install

Again, this last step on Windows won’t create `.bat` files or Start Menu shortcuts, so you will have to use one of the other approaches listed above.

Some users want to be able to follow the development branch as it changes. If you have `setuptools` installed, this is easy. Simply replace the last step by:

    $ python setupegg.py develop

This creates links in the right places and installs the command line script to the appropriate places. Then, if you want to update your IPython at any time, just do:

    $ git pull

# Basic optional dependencies

There are a number of basic optional dependencies that most users will want to get. These are:

- readline (for command line editing, tab completion, etc.)
- nose (to run the IPython test suite)
- pexpect (to use things like irunner)

If you are comfortable installing these things yourself, have at it, otherwise read on for more details.

## readline

In principle, all Python distributions should come with a working `readline` module. But, reality is not quite that simple. There are two common situations where you won’t have a working `readline` module:

- If you are using the built-in Python on Mac OS X.
- If you are running Windows, which doesn’t have a `readline` module.

When IPython is installed with `setuptools`, (e.g. with easy_install), readline is added as a dependency on OS X, and PyReadline on Windows, and will be installed on your system. However, if you do not use setuptools, you may have to install one of these packages yourself.

On OS X, the built-in Python doesn’t not have `readline` because of license issues. Starting with OS X 10.5 (Leopard), Apple’s built-in Python has a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9, many of the issues related to the differences between readline and libedit seem to have been resolved. 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.

Therefore, we strongly recommend that on OS X you get the full `readline` module. We will not consider completion/history problems to be bugs for IPython if you are using libedit.

To get a working `readline` module, just do (with `setuptools` installed):

    $ easy_install readline

Note

Other Python distributions on OS X (such as fink, MacPorts and the official python.org binaries) already have readline installed so you likely don’t have to do this step.

If needed, the readline egg can be build and installed from source (see the wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).

On Windows, you will need the PyReadline module. PyReadline is a separate, Windows only implementation of readline that uses native Windows calls through `ctypes`. The easiest way of installing PyReadline is you use the binary installer available here.

## nose

To run the IPython test suite you will need the `nose` 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 easy_install:

    $ easy_install nose

Another way of getting this is to do:

    $ easy_install ipython[test]

For more installation options, see the nose website.

Once you have nose installed, you can run IPython’s test suite using the iptest command:

    $ iptest

## pexpect

The pexpect package is used in IPython’s irunner script, as well as for managing subprocesses [pexpect]. IPython now includes a version of pexpect in `IPython.external`, but if you have installed pexpect, IPython will use that instead. On Unix platforms (including OS X), just do:

    $ easy_install pexpect

Windows users are out of luck as pexpect does not run there.

# Dependencies for IPython.parallel (parallel computing)

`IPython.kernel` has been replaced by `IPython.parallel`, which uses ZeroMQ for all communication.

IPython.parallel provides a nice architecture for parallel computing. The main focus of this architecture is on interactive parallel computing. These features require just one package: pyzmq. See the next section for pyzmq details.

On a Unix style platform (including OS X), if you want to use `setuptools`, you can just do:

    $ easy_install ipython[zmq]    # will include pyzmq

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 paramiko [paramiko].

# Dependencies for IPython.zmq

## pyzmq

IPython 0.11 introduced some new functionality, including a two-process execution model using ZeroMQ for communication [ZeroMQ]. The Python bindings to ZeroMQ are found in the pyzmq project, which is easy_install-able once you have ZeroMQ installed. If you are on Python 2.6 or 2.7 on OSX, or 2.7 on Windows, pyzmq has eggs that include ZeroMQ itself.

IPython.zmq depends on pyzmq >= 2.1.4.

# Dependencies for ipython qtconsole (new GUI)

## Qt

Also with 0.11, a new GUI was added using the work in `IPython.zmq`, which can be launched with `ipython qtconsole`. The GUI is built on Qt, and works with either PyQt, which can be installed from the PyQt website, or PySide, from Nokia.

## pygments

The syntax-highlighting in `ipython qtconsole` is done with the pygments project, which is easy_install-able [pygments].

[ZeroMQ] | ZeroMQ. http://www.zeromq.org

[paramiko] | paramiko. https://github.com/robey/paramiko

[pygments] | Pygments syntax highlighting. http://pygments.org

[pexpect] | Pexpect. http://www.noah.org/wiki/Pexpect

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- Installation »