Skip to content

Commit

Permalink
Use Jupyter Notebook App and other naming conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Jun 14, 2015
1 parent 9a03f6a commit b7c65b5
Showing 1 changed file with 39 additions and 43 deletions.
82 changes: 39 additions & 43 deletions docs/execute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Running the Jupyter Notebook
Launching Jupyter Notebook
--------------------------

The Jupyter Notebook App can be launched by clicking on the IPython Notebook
The *Jupyter Notebook App* can be launched by clicking on the *IPython Notebook*
icon installed by Anaconda in the start menu (Windows) or by typing in
a terminal (*cmd* on Windows)::

Expand All @@ -14,67 +14,64 @@ This will launch a new browser window (or a new tab) showing the
Notebook Dashboard, a sort of control panel that allows (among other things)
to select which notebook to open.

When started, Jupyter Notebook can access only files within its start-up folder
(including any sub-folder). If you store the notebooks in a subfolder
When started, the *Jupyter Notebook App* can access only files within its start-up folder
(including any sub-folder). If you store the notebook documents in a subfolder
of your user folder no configuration is necessary.

Otherwise, you need to choose a folder which will contains all the notebooks
and set this as the Jupyter Notebook start-up folder.
and set this as the *Jupyter Notebook App* start-up folder.

See below for platform-specific instructions on how to start Jupyter Notebook
in a specific folder.
See below for platform-specific instructions on how to start
*Jupyter Notebook App* in a specific folder.

Change Jupyter Notebook startup folder (Windows)
''''''''''''''''''''''''''''''''''''''''''''''''

- Copy the IPython Notebook launcher from the menu to the desktop.
- Copy the *IPython Notebook* launcher from the menu to the desktop.

- Right click on the new launcher and change the "Start in" field by pasting
the folder previously chosen.

- Double-click on the IPython Notebook launcher to start the
Notebook application. Note that this will open two new windows:
a terminal (used only for error logging and for shut down) and a new
browser window showing the Jupyter Notebook application.
- Double-click on the *IPython Notebook* launcher to start the
*Jupyter Notebook App*, which will open a new browser window (or tab).
Note also that a secondary terminal window (used only for error logging and
for shut down) will be also opened.


Change Jupyter Notebook startup folder (OSX)
''''''''''''''''''''''''''''''''''''''''''''''''

To launch Jupyter Notebook:
To launch *Jupyter Notebook App*:

- Click on spotlight, type `terminal` to open a terminal window.
- Click on spotlight, type ``terminal`` to open a terminal window.

- Enter the startup folder by typing ``cd /some_folder_name``

- Type ``ipython notebook``. This will open a new window in your
default browser showing the content of your home folder.


Shutting down Jupyter Notebook
Shutting down the Jupyter Notebook App
------------------------------

In a nutshell, closing the browser (or the tab) will not close the
Jupyter Notebook application. To completely shut down Jupyter Notebook
you need to close the associated terminal.
*Jupyter Notebook App*. To shut it down you need to close the associated terminal.

More in details,
the Jupyter Notebook application (the server) appears in your browser
the *Jupyter Notebook App* is a server that appears in your browser
at a default address (*http://localhost:8888*).
Closing the browser will not close the Jupyter Notebook application.
Closing the browser will not shut down the server.
You can reopen the previous address (just start typing *localhost* in the
browser addressbar) and the Jupyter Notebook application will be redisplayed.
In addition, each notebook has an "execution engine" (called the kernel)
that is started when the notebook is opened. The Dashboard allows to shut-down
browser address bar) and the *Jupyter Notebook App* will be redisplayed.
In addition, each notebook has an "execution engine" (called the *kernel*)
that is started when the notebook is opened.
The *Notebook Dashboard* allows to shut-down
the notebook kernels or open new notebooks.

You can run many copies of the Jupyter Notebook application and they will show
up at a similar address except that the number (which is the port number)
will increment for each new copy.
You can run many copies of the *Jupyter Notebook App* and they will show
up at a similar address (only the number after ":", which is the port, will increment for each new copy).

For simplicity we do not recommend running multiple copies of Jupyter Notebook.
Note that with a single Jupyter Notebook Application you can as many notebooks
as you like.
Since from a single *Jupyter Notebook App* you can open on as many notebooks as you like, we do not recommend running multiple copies of *Jupyter Notebook App*.

Running a notebook
------------------
Expand All @@ -84,47 +81,46 @@ notebook folder (or a sub-folder of it).

Then follow these steps:

- Launch the Jupyter Notebook (see previous section).
- Launch the *Jupyter Notebook App* (see previous section).

- In the new Jupyter Notebook Dashboard navigate to find the notebook:
- In the new *Notebook Dashboard* navigate to find the notebook:
clicking on its name will open it in a new browser tab.

- Click on the menu *Help -> User Interface Tour* for an overview
of the Notebook environment.
of the *Jupyter Notebook App* user interface.

- You can run the notebooks step-by-step (one cell a time) by hitting
- You can run the notebook document step-by-step (one cell a time) by hitting
*shift + enter*.

- You can run the whole notebook in a single step by clicking on the menu
*Cell -> Run All*.

- To restart the notebook computations (the component performing the
computation is called the kernel), click on the menu
- To restart the *kernel* (i.e. the computational engine), click on the menu
*Kernel -> Restart*.

.. note::

Modifications to the notebooks are automatically saved every
few minutes. It is suggested that you make a copy of the
original tutorial (menu *File -> Make a copy ...*) and make
original notebook document (menu *File -> Make a copy ...*) and make
modifications on the copy.

.. note::

Closing the browser will not shut down the notebook computational kernel.
The notebook can be reopened and it will be still running.
To close a notebook and shut-down the kernel use the menu
Closing the browser will not shut down the *kernel*.
The notebook document can be reopened and it will be still running.
To "close the notebook document" and "shut-down the kernel" use the menu
*File -> Close and Halt*. A this point the notebook is closed,
Jupyter Notebook is still running and can open new notebooks.
*Jupyter Notebook App* is still running and can open new notebooks.

.. warning::

Please pay attention that if you open the **same** notebook on many
tabs and do edits, the edits on different tabs can overwrite each other.
To be safe, make sure you open each notebook in only one tab.
If by mistake you open a notebook twice in two tabs, please close one tab.
Please pay attention that if you open the **same** notebook document on many
tabs and do edits, the edits on different tabs can overwrite each other!
To be safe, make sure you open each notebook document in only one tab.
If, by mistake, you open a notebook twice in two tabs, just close one tab.

More info on using the Notebook environment:
More info on using the *Jupyter Notebook App* environment:

- `Jupyter Notebook documentation <http://ipython.org/notebook.html>`_

Expand Down

0 comments on commit b7c65b5

Please sign in to comment.