Jupyter Notebooks

Overview:

• Teaching: 10 min
• Exercises: 10 min

Questions

• What is a Jupyter notebook?
• Why should I use one?

Objectives

• Create a Jupyter notebook
• Enter code into the notebook
• Augment the code with a description in markdown

You should have a Python 3 notebook open, if not take a look at the setup page (the previous page in the schedule).

Trying things out

In this lesson you can have a Python 3 jupyter notebook open to try out any of the commands you see here and reproduce the results.

Python in notebooks

Jupyter provides a nice web-based interface to Python. In the below cells you can type a line of Python. For example, here we type in

a = 5

When we press SHIFT+Return this Python line is interpreted interactively

a = 5

To see that this has worked, let's print the value of a

print(a)

5

You can type whatever Python you want, and it will be evaluated interactively. For example...

b = 10

print(a + b)

15

One of the cool things about a Jupyter Python notebook is that you can edit the above cells and re-execute them. For example, change the value of b above and re-execute the lines [3] and [4] (by selecting the cell and pressing SHIFT+Return.

Out of order execution

The ability to go back and change only small snippets of code is very useful, but also very dangerous form a coding point of view. If you edit a code cell and don't run all the code cells after it, then any cell that isn't re-executed is still using the old code. Jupyter allows you to keep track of this by numbering its input, In [3] for instance means this block was executed third.

If you get in a complete mess you can also clear all output, without removing the input and re-execute the code blocks in order.

All of the standard Python help is available from within the notebook. This means that you can type

help(something)

to get help about something. For example, type and execute help(print) to get help about the print function.

help(print)

Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    
    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

You can set the name of the notebook by clicking on the name at the top, and setting the name. The notebook is currently saved to a file called Untitled (the extension is short for 'interactive python notebook'). You can save the notebook using the File menu at the top, using Download as e.g. saving as a normal Python script, or as a PDF file, webpage or downloading the python notebook itself.

More information is available at the Jupyter website.

Hello Notebook!

Use the cells in your notebook to type into the three Python lines

a = "Hello"
b = "Notebook!"
print(a,b)

Execute the cells. This should print out Hello Notebook!.

Now go back and change the values of a and b to Goodbye and Everyone. Re-execute your cells. This should now print out Goodbye Everyone.

Solution

Getting help

Use the interactive Python help to get help about the open function for reading and writing files.

Solution

Markdown in notebooks

Another useful feature is that you can mix documentation into your notebook. Do this by selecting a cell and using the dropdown menu (on the toolbar at the top) to change the cell type to markdown. You can now add documentation, using markdown formatting. For example, use the hash symbol for headers.

Typing

# This is a big header

## This is a subheading

### This is a sub-sub-heading

and pressing Shift + Return results in:

This is a big header

This is a subheading

This is a sub-sub-heading

You can add in hyperlinks using square brackets and round brackets. For example

[link to github](https://github.com)

produces:

link to github

Mastering markdown

Now change the type of the cell in your notebook to markdown. Type in some markdown in the cell and experiment with adding in headings and hyperlinks. Take a look through the markdown cheat sheet and see if you can add bullet point lists, images, or code blocks to your cell.

Solution

Key Points:

• Jupyter notebooks allow you to write any Python code into a web interface.
• Cell contents can be easily modified.
• You need to be wary of out of order execution.
• Markdown is useful for explaining what the code does and presenting your work.

Previous

Schedule

Next