Skip to content

Commit

Permalink
Add link to new Jupyter docs and small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Jul 14, 2015
1 parent 0f62673 commit b939784
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions docs/what_is_jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
What is Jupyter Notebook
========================

**Jupyter Notebook App** (formerly **IPython Notebook**) is an application which runs inside your
browser.
For the purpose of this guide, *Jupyter Notebook App* is run locally like a normal desktop
application and does not require accessing any remote server.
**Jupyter Notebook App** (formerly **IPython Notebook**) is
an application which runs inside your browser.
This guide describes how to install and use *Jupyter Notebook App*
as normal desktop application, without using any remote server.

"notebooks" (all lower case) are text documents
produced by the *Jupyter Notebook App* which contain both python code and rich text format elements
(paragraph, equations, figures, links, etc...).
produced by the *Jupyter Notebook App* which contain both computer code (e.g. python)
and rich text format elements (paragraph, equations, figures, links, etc...).
Notebook documents are both human-readable documents containing the analysis
description and the results (figures, tables, etc..) as well as executable documents
which can be run to perform data analysis.
Expand All @@ -22,8 +22,9 @@ Official Jupyter Project Pages:

- `Project Jupyter <https://jupyter.org/>`__
- `IPython Notebook Homepage <http://ipython.org/notebook.html>`__
- `Jupyter Documentation <http://jupyter.readthedocs.org/>`__

Some more in-depth (but slightly outdated) introduction:
A more in-depth (but slightly outdated) introduction on using the *Jupyter Notebook App*:

- `What is the IPython Notebook? <http://nbviewer.ipython.org/github/jupyter/strata-sv-2015-tutorial/blob/master/00%20-%20Introduction.ipynb>`__

Expand All @@ -36,9 +37,9 @@ Quick Glossary
~~~~~~~~~~~~~~~~~~~~~~

The *Jupyter Notebook App* is a server application that allows
operating on notebook documents (open, close, run, etc...).
In this guide, the *Jupyter Notebook App* is run on a local desktop
and does not require any internet access.
operating on notebook documents (open, close, run, etc...) via a web browser.
The *Jupyter Notebook App* can be run on a local desktop
and without requiring internet access.
In addition to displaying/editing/running notebook documents,
the *Jupyter Notebook App* has a "Dashboard" (:ref:`dashboard`),
a "control panel" showing local files and allowing to
Expand All @@ -54,8 +55,8 @@ A notebook *kernel* is a "computational engine"
that executes the code contained in a notebook document.
In this guide, we always refer to a specific kernel called *ipython kernel*
which executes python code.
Kernels for many other languages exists; the *ipython kernel* is the one
for the python language.
Kernels for many other languages exists
(`official kernels <http://jupyter.readthedocs.org/en/latest/#kernels>`__).

When opening a notebook document, the associated *kernel* is automatically launched.
When the notebook is *executed* (either cell-by-cell or with menu *Cell -> Run All*),
Expand All @@ -73,7 +74,8 @@ highlights notebooks with running kernels and allows to shut them down.
*Notebook Dashboard*
~~~~~~~~~~~~~~~~~~~~

The *Notebook Dashboard* is the component of the *Jupyter Notebook App* which is shown first when the :ref:`notebook_app` is launched.
The *Notebook Dashboard* is the component of the *Jupyter Notebook App* which
is shown first when the :ref:`notebook_app` is launched.

The *Notebook Dashboard* is mainly used to open notebook documents, and to manage
the running :ref:`kernels <kernel>` (visualize and shutdown).
Expand Down

0 comments on commit b939784

Please sign in to comment.