Documentation

IPython manual

• Current Stable Version (2.x)
• Current Development Version

This introduction to some key features is a good place to start if you haven’t used IPython before.

See below for links to all versions of the documentation.

Other useful documentation

• Presentations we’ve given at various venues regarding IPython over the years.
• Videos and screencasts.
• IPython screenshots.
• IPython quick reference card.
• An article about IPython, written by Fernando Perez and Brian Granger, published in the May/June 2007 issue of the journal Computing in Science and Engineering.

External documentation, related presentations and tutorials

This is a collection of presentations, often by authors outside of the core IPython team. Some are focused on aspects of IPython itself while others may be about external projects that use IPython as a key component. If you have any material that fits this description, please contact the IPython team and let us know about it so we can post it here.

• The BCPy2000 project offers Python tools for Brain-Computer interface development, and it uses IPython in a really neat way to enable interactive debugging of all the components as they operate in real-time. This talk presented at the 2008 NIPS conference shows the system.
• Jose Unpingco made this really neat screencast showing how to couple IPython’s parallel capabilities with the Vision environment. Vision is an extremely impressive visual programming environment developed by Michel Sanner’s team at the Scripps Institute in La Jolla, CA.
• An article by Noah Gift on RedHat Magazine that covers using Python, and IPython, as a better Bash.
• An article by Noah Gift at the IBM Developer Works site, on using the Net-SNMP library to interactively explore and manage a network (the interactive part courtesy of IPython, of course).
• A post and video about using IPython’s GTK support to interactively control a Pigment application. It also uses the IPython demo class.
• A set of slides introducing IPython and summarizing its features. A good introduction for the newcomer, and even experienced users may find things there they didn’t know about.
• An article at Linux.com about IPython, by Conrad Koziol.
• An article by Jeremy Jones at ONLamp.com, introducing IPython to new users and giving a tour of its features as a replacement for the default Python shell.
• The O’Reilly book “Python for Unix and Linux System Administration” has a chapter (the first, and largest one) on IPython. IPython is also used throughout the book to illustrate other Python technologies.

Other projects using IPython

Here you can find a list of projects that use IPython in one form or another. If you use IPython as part of a project, please do add your information to this page or email Fernando.Perez@Berkeley.edu and I’ll be happy to add it. Also, if your project is of academic relevance, please provide a citation to IPython.

Docs for all releases

• 2.x
• 1.x
• 0.13.2
• 0.13.1
• 0.13
• 0.12.1
• 0.12
• 0.11: HTML and PDF.
• 0.10.2: HTML and PDF.
• 0.10.1: HTML and PDF.
• 0.10: HTML and PDF.
• 0.9.1: HTML and PDF.
• 0.9: HTML and PDF.