Running The Notebook - Jupyter Documentation

Skip to main content Back to top Ctrl+K

• Try Jupyter
• Usage
• Projects
• Community
• Contributing
• Reference
• jupyter.org

• GitHub
• Discourse

Section Navigation

• Install and Use
  • Installing the classic Jupyter Notebook interface
  • Upgrading Jupyter Notebook
  • Installing Kernels
• Running the Notebook

• Try Jupyter
• Running the Notebook

Running the Notebook#

Contents

• Basic Steps

• Starting the Notebook Server

• Introducing the Notebook Server’s Command Line Options

  • How do I open a specific Notebook?

  • How do I start the Notebook using a custom IP or port?

  • How do I start the Notebook server without opening a browser?

  • How do I get help about Notebook server options?

• Using a command-line interface

Basic Steps#

1. Start the notebook server from the command line:

   jupyter notebook

2. You should see the notebook open in your browser.

Starting the Notebook Server#

After you have installed the Jupyter Notebook on your computer, you are ready to run the notebook server. You can start the notebook server from the command line (using Terminal on Mac/Linux, Command Prompt on Windows) by running:

jupyter notebook

This will print some information about the notebook server in your terminal, including the URL of the web application (by default, http://localhost:8888):

$jupyternotebook [I08:58:24.417NotebookApp]Servingnotebooksfromlocaldirectory:/Users/catherine [I08:58:24.417NotebookApp]0activekernels [I08:58:24.417NotebookApp]TheJupyterNotebookisrunningat:http://localhost:8888/ [I08:58:24.417NotebookApp]UseControl-Ctostopthisserverandshutdownallkernels(twicetoskipconfirmation).

It will then open your default web browser to this URL.

When the notebook opens in your browser, you will see the Notebook Dashboard, which will show a list of the notebooks, files, and subdirectories in the directory where the notebook server was started. Most of the time, you will wish to start a notebook server in the highest level directory containing notebooks. Often this will be your home directory.

Notebook Dashboard

Introducing the Notebook Server’s Command Line Options#

How do I open a specific Notebook?#

The following code should open the given notebook in the currently running notebook server, starting one if necessary.

jupyternotebooknotebook.ipynb

How do I start the Notebook using a custom IP or port?#

By default, the notebook server starts on port 8888. If port 8888 is unavailable or in use, the notebook server searches the next available port. You may also specify a port manually. In this example, we set the server’s port to 9999:

jupyternotebook--port9999

How do I start the Notebook server without opening a browser?#

Start notebook server without opening a web browser:

jupyternotebook--no-browser

How do I get help about Notebook server options?#

The notebook server provides help messages for other command line arguments using the --help flag:

jupyternotebook--help

See also

Jupyter Installation, Configuration, and Usage

Detailed information about command line arguments, configuration, and usage.

Using a command-line interface#

Notebooks can be executed from your terminal using the execute subcommand. It expects notebook paths as input arguments and accepts optional flags to modify the default behavior.

Running a notebook is this easy.

jupyterexecutenotebook.ipynb

You can pass more than one notebook as well.

jupyterexecutenotebook.ipynbnotebook2.ipynb

By default, notebook errors will be raised and printed into the terminal. You can suppress them by passing the --allow-errors flag.

jupyterexecutenotebook.ipynb--allow-errors

For more sophisticated execution options, consider the papermill library.

On this page

• Basic Steps
• Starting the Notebook Server
• Introducing the Notebook Server’s Command Line Options
  • How do I open a specific Notebook?
  • How do I start the Notebook using a custom IP or port?
  • How do I start the Notebook server without opening a browser?
  • How do I get help about Notebook server options?
• Using a command-line interface

Edit on GitHub

This Page

• Show Source