Skip to content

Commit

Permalink
Remove redundancy and move links at the end.
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Jul 14, 2015
1 parent 04b1c8a commit 6a5d2d1
Showing 1 changed file with 41 additions and 33 deletions.
74 changes: 41 additions & 33 deletions docs/what_is_jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,37 @@
What is Jupyter Notebook
========================

**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
In this page briefly introduce the main componets of the *Jupyter Notebook*
environment.

.. _notebook_document:

Notebook document
-----------------

Notebook documents (or "notebooks", all lower case) are text documents
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.

External Links
--------------

Official Jupyter Project Pages:

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

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>`__
For a more complete overview see `IPython Notebook Homepage <http://ipython.org/notebook.html>`__.

Quick Glossary
--------------

.. _notebook_app:

*Jupyter Notebook App*
~~~~~~~~~~~~~~~~~~~~~~
Jupyter Notebook App
--------------------

The *Jupyter Notebook App* is a server application that allows
operating on notebook documents (open, close, run, etc...) via a web browser.
The *Jupyter Notebook App* is a server-client application that allows
operating on :ref:`notebook documents <notebook_document>` (open,
close, run, etc...) via a web browser.
The *Jupyter Notebook App* can be run on a local desktop
and without requiring internet access.
requiring no internet access (like described in this document)
or installed on a remote server and accessed through the internet.

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 @@ -48,17 +42,17 @@ open notebook documents or shutting down their :ref:`kernels <kernel>`.

.. _kernel:

*kernel*
~~~~~~~~
kernel
------

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*
that executes the code contained in a :ref:`notebook_document`.
In this guide, we refer to a specific kernel called *ipython kernel*
which executes python code.
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 opening a :ref:`notebook_document`, the associated *kernel* is automatically launched.
When the notebook is *executed* (either cell-by-cell or with menu *Cell -> Run All*),
the *kernel* performs the computation and produces the results.
Depending on the type of computations, the *kernel* may consume significant
Expand All @@ -71,18 +65,32 @@ highlights notebooks with running kernels and allows to shut them down.

.. _dashboard:

*Notebook Dashboard*
~~~~~~~~~~~~~~~~~~~~
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 which
is shown first when the launching :ref:`notebook_app`.

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

The *Notebook Dashboard* has other features similar to a file manager, namely
navigating folders and renaming/deleting files.

References
----------

Official Jupyter Project Pages:

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

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>`__


....

The *Next* button will bring you to the next section (*Installation*).

0 comments on commit 6a5d2d1

Please sign in to comment.