{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "**To begin this interactive lesson, click on the rocket ship in the top navigation and then select \"Binder\" to launch the Jupyter Notebook. It may take a few moments to load the first time you launch it.**\n", "\n", "\"The

\n", "\n", "\n", "**When you are in the interactive environment, you will see a Jupyter logo in the upper left-hand corner.**\n", "\n", "\"The
\n", "\n", "___ \n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Welcome to your first Jupyter notebook!\n", "You are currently looking at a document in an online tool called [Jupyter Notebooks](https://constellate.org/docs/key-terms/#the-jupyter-notebook).\n", "\n", "This document is called a \"notebook\" and contains blocks of text, images, and code that you can interact with.\n", "\n", "Any time you open a notebook, you will be working on your own temporary copy that you can edit without affecting the original or anyone else's work. So please feel free to press buttons and edit and delete things without fear. You can always close and re-open this document if you need to start over.\n", "\n", "## Why are we using Jupyter Notebooks?\n", "There are two reasons we are using notebooks for this workshop:\n", "1. **They allow you to write code immediately.**
A notebook is like a virtual computer that is ready for you to write and run code in immediately. This means you can start coding without having to install the programming language (in our case Python) or a program to write the language in (an \"Integrated Development Environment\" or \"IDE\" such as Visual Studio) on your own computer.\n", "

\n", "2. **They look prettier than raw code.**
Jupyter Notebooks combine text, images, and code so that the document you are working in looks more like a website than raw code. This makes the code easier to annotate and to follow and learn from. " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## What am I looking at?\n", "There are two parts to a notebook:\n", "1. Document controls\n", "1. Document content, which is made up of components called \"cells\"\n", "\n", "" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## What are cells?\n", "Similar to the way a word document is composed of paragraphs, Jupyter notebooks are composed of [cells](https://docs.tdm-pilot.org/key-terms/#cell) that contain different kinds of content. There are two types of cells:\n", "\n", "1. [Markdown Cells](https://docs.tdm-pilot.org/key-terms/#markdown-cell) — Contain text and images.\n", "2. [Code Cells](https://docs.tdm-pilot.org/key-terms/#code-cell) — Contain code that you can run.\n", "\n", "\n", "The text you are reading right now is in a Markdown cell. If you were to edit it, you would see that it is written in \"Markdown,\" a shorthand writing system that allows you to format text to look like a website without having to write HTML. Here is an example of some Markdown and its output: \n", "\n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", "
MarkdownOutput

# This makes a header\n", "
This makes regular text.\n", "
\n", "
* this makes a bulleted list\n", "
* this makes a bulleted list\n", "
* this makes a bulleted list\n", "

\n", "

This makes a header

\n", " This makes regular text.\n", "
    \n", "
  • this makes a bulleted list
    • \n", "
  • this makes a bulleted list
    • \n", "
  • this makes a bulleted list
    • \n", "
\n", "
\n", "\n", "Below is a a code cell. You can recognize it by the pair of brackets and a colon on the left, like so ``[ ]:``" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# This is a code cell " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## How do I interact with cells?\n", "The buttons at the top of the Jupyter Notebook are controls that allow you to add, remove, move, run, or change the type of cells. To get familiar with the controls, let's go through a series of exercises.\n", "\n", "### Exercise 1: Run a code cell.\n", "To run the code cell below, click on the cell and then press the \"Run cell\" button ()." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "1 + 1" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "When you have run the cell, you should see an output appear like so:\n", "\n", "\n", "\n", "You will also see the brackets on the left change from being empty, to containing a number. This tells you that the cell has successfully been run. Brackets will give you information about a code cell, like so:\n", "* ``[ ]:`` never been run\n", "* ``[*]:`` still running\n", "* ``[1]:`` was run 1st of all the cells in the document\n", "* ``[7]:`` was run 7th of all the cells in the document\n", "\n", "If you run this code cell a second time, you will see the brackets change to ``[2]:``. The number will always update to reflect the last time you ran the cell.\n", "\n", "Running code cells is something you will do a lot of during this workshop. You can either press the run button each time, or you can use the following keyboard shortcuts:\n", "* Windows: press Ctrl + Enter\n", "* Mac: press Shift + Return" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Exercise 2: Edit a Markdown cell.\n", "To practice editing a Markdown cell, double-click on the Markdown cell below:" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "> ### Double-click on this markdown cell\n", "This text looks a little different than the other text on this page because it uses the \">\" block-quote markdown symbol." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "When you have double-clicked the cell, you should see something like this:\n", "\n", "\n", "\n", "What you are seeing is:\n", "1. **Markdown.** — This gray box is where you can edit the Markdown by clicking in the box and then typing.\n", "1. **Output.** — This is a preview of what the Markdown will actually look like.\n", "\n", "At any time, you can make the gray edit box disappear by pressing the \"Run cell\" button (). You will then only see the output.\n", "\n", "If you would like to learn more about Markdown, check out this quick [Markdown guide](https://www.markdownguide.org/cheat-sheet/) or this longer [Markdown tutorial](https://www.markdowntutorial.com/)." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Exercise 3: Add a cell.\n", "To add a cell, click on this cell and then click on the \"Insert cell bellow\" button (). This should add a cell below this one, between these lines:\n", "___" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "___\n", "When you have added a cell, you should see a blank code cell like this:\n", "\n", "\n", "\n", "The default type of cell is a code cell. You can change the type at any time by click on the the \"Code\" drop-down () and changing it to \"Markdown\" ()." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Exercise 4: Delete a cell.\n", "To delete a cell, click on one of the practice cells below and press the \"Cut selected cells\" button ()." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# delete me!" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# delete me!" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# delete me!" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "You should see that cell disappear." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Exercise 5: Restart this notebook.\n", "To completely restart this notebook and clear all of your work, click on the \"Kernel\" menu () and then click on the \"Restart & Clear Output\" option.\n", "\n", "\n", "\n", "Then, click \"Restart and Clear All Outputs\" on the pop-up window that appears.\n", "\n", "\n", "\n", "This will completely reset the notebook." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Lesson Complete!\n", "\n", "If you're curious about how we have set this notebook up, read on:\n", "\n", "* **[Binder](https://binder.constellate.org/)** is the *environment* we are using to access (\"run\") our Jupyter Notebooks inside a browser. It's kind of like a separate computer in the cloud that makes all of tools we need to use in Jupyter Notebooks work. We're using [Constellate's](https://constellate.org/) Binder for this session, but anyone can [create their own Binder](https://mybinder.org/).\n", "\n", "\n", "* We use **[Github](https://github.com/jasf-/tdm-nbs)** to store the Jupyter Notebooks (.ipynb files) for this session. Like any other computer, Binder will power down after a while--basically after a certain period of inactivity. So we need a place to make our Jupyter Notebooks available, and tell Binder where to find them the next time we start up a Binder session to interact with our notebooks." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "
\n", "\n", "Adapted by [Kate Kryder](https://library.northeastern.edu/about/library-staff-directory/kate-kryder) from two notebooks created by [Nathan Kelber](http://nkelber.com) and Ted Lawless for [JSTOR Labs](https://labs.jstor.org/) under [Creative Commons CC BY License](https://creativecommons.org/licenses/by/4.0/).
See [here](https://docs.tdm-pilot.org/tag/beginner-lessons/) for the original versions. Some content was also adapted from notebooks created by [Sarah Connell](https://library.northeastern.edu/about/library-staff-directory/sarah-connell) and [Jen Ferguson](https://library.northeastern.edu/about/library-staff-directory/jen-ferguson) for earlier versions of this workshop.
" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.8.3" }, "toc": { "base_numbering": 1, "nav_menu": {}, "number_sections": false, "sideBar": false, "skip_h1_title": true, "title_cell": "Table of Contents", "title_sidebar": "Contents", "toc_cell": false, "toc_position": { "height": "calc(100% - 180px)", "left": "10px", "top": "150px", "width": "165px" }, "toc_section_display": true, "toc_window_display": false } }, "nbformat": 4, "nbformat_minor": 5 }