Skip to content

Commit

Permalink
Adding initial documentation on the notebook.
Browse files Browse the repository at this point in the history
  • Loading branch information
ellisonbg committed Aug 11, 2011
1 parent 46fc646 commit 1bcb722
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 4 deletions.
47 changes: 43 additions & 4 deletions docs/source/install/install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ 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
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
Expand All @@ -306,14 +306,14 @@ 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
to ZeroMQ are found in the pyzmq project [PyZMQ]_, 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)
============================================
Dependencies for the IPython QT console
=======================================

Qt
--
Expand All @@ -330,7 +330,46 @@ pygments
The syntax-highlighting in ``ipython qtconsole`` is done with the pygments project,
which is easy_install-able [pygments]_.

Dependencies for the IPython HTML notebook
==========================================

The IPython notebook is a notebook-style web interface to IPython and can be
started withe command ``ipython notebook``.

pyzmq
-----

Like the :mod:`IPython.parallel` and :mod:`IPython.frontend.qt.console` packages,
the HTML notebook requires ZeroMQ and PyZMQ.

Tornado
-------

The IPython notebook uses the Tornado project [Tornado]_ for its HTTP server and requires
version 2.0 or greater. Tornado can be installed with ``easy_install tornado``.

Browser Compatiblity
--------------------

The notebook uses WebSockets and the flexible box model. These features are
available in the following browsers:

* Chrome.
* Safari.
* Firefox 4 and 5. These browesrs have WebSocket support, but it is disabled by
default. You can enable it by entering ``about:config`` in the URL bar and then
setting ``network.websocket.enabled`` and ``network.websocket.override-security-block``
to ``true``.
* Firefox 6. Starting with version 6, Firefox has WebSocket support enabled by default.

Internet Explorer 9 does not support WebSockets or the flexible box model, but
these features should appear in Internet Explorer 10.


.. [ZeroMQ] ZeroMQ. http://www.zeromq.org
.. [PyZMQ] PyZMQ. https://github.com/zeromq/pyzmq
.. [paramiko] paramiko. https://github.com/robey/paramiko
.. [pygments] Pygments syntax highlighting. http://pygments.org
.. [pexpect] Pexpect. http://www.noah.org/wiki/Pexpect
.. [Tornado] Tornado. http://www.tornadoweb.org/

39 changes: 39 additions & 0 deletions docs/source/interactive/htmlnotebook.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. _htmlnotebook:

=========================
An HTML Notebook IPython
=========================

The IPython Notebook consists of two related components:

* An XML/JSON based Notebook document format for recording and distributing
Python code and rich text.
* A web-based user interface for authoring and running notebook documents.

The Notebook can be used by starting the Notebook server with the
command::

$ ipython notebook

This server uses the same ZeroMQ-based two process kernel architecture as
the QT Console as well Tornado for serving HTTP requests. Some of the main
features of the Notebook include:

* Display rich data (png/html/latex/svg) in the browser as a result of
computations.
* Compose text cells using HTML and Markdown.
* Import and export notebook documents in range of formats (.ipynb, .json, .py).
* In browser syntax highlighting, tab completion and autoindentation.
* Inline matplotlib plots that can be stored in Notebook documents and opened
later.

See :ref:`our installation documentation <install_index>` for directions on
how to install the notebook and its dependencies.

Basic Usage
===========

Notebook document format
========================


1 change: 1 addition & 0 deletions docs/source/interactive/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ Using IPython for interactive work
reference.txt
shell.txt
qtconsole.txt
htmlnotebook.txt


1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ def cleanup():
zmq = 'pyzmq>=2.1.4',
doc = 'Sphinx>=0.3',
test = 'nose>=0.10.1',
notebook = 'tornado>=2.0'
)
requires = setup_args.setdefault('install_requires', [])
setupext.display_status = False
Expand Down

0 comments on commit 1bcb722

Please sign in to comment.