Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
115 lines (76 sloc) 4.39 KB

What is the Jupyter Notebook?

In this page briefly introduce the main components of the Jupyter Notebook environment. For a more complete overview see :ref:`references`.

Notebook document

Notebook documents (or "notebooks", all lower case) are documents produced by the :ref:`notebook_app`, which contain both computer code (e.g. python) and rich text 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.

References: Notebook documents in the project homepage and in the official docs.

Jupyter Notebook App

The Jupyter Notebook App is a server-client application that allows editing and running :ref:`notebook documents <notebook_document>` via a web browser. The Jupyter Notebook App can be executed on a local desktop requiring no internet access (as described in this document) or can be 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 open notebook documents or shutting down their :ref:`kernels <kernel>`.

References: Jupyter Notebook App in the project homepage and in the official docs.

kernel

A notebook kernel is a "computational engine" that executes the code contained in a :ref:`notebook_document`. The ipython kernel, referenced in this guide, executes python code. Kernels for many other languages exist (official kernels).

When you open 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 CPU and RAM. Note that the RAM is not released until the kernel is shut-down.

See also :ref:`kernel_shutdown`.

References: from the official docs Opening Notebooks and Decoupled two-process model.

Notebook Dashboard

The Notebook Dashboard is the component which is shown first when you launch :ref:`notebook_app`. The Notebook Dashboard is mainly used to open :ref:`notebook documents <notebook_document>`, 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: from the official docs Opening Notebooks.

References

Official Jupyter Project Pages:

Official Documentation:

See also:


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