{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# CIGI Lab Jupyter Notebook Style Guide: Template Notebook"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This Notebook is a template for creating new Jupyter Notebooks according to the CIGI Lab style. This notebook is a companion to the CIGI Lab – Public-Facing Jupyter Notebook Checklist and Style Guide, which can be found at https://drive.google.com/file/d/1EJ_pSjX2IiNv8K8heGOLsXGHUxIIclrf/view?usp=sharing.\n",
"\n",
"Notebook author: **Rebecca Vandewalle**\n",
"
Notebook created: Feb 10, 2021. Last updated: **Feb 12, 2021**"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"**Style notes for Notebook start:**\n",
"Include author and creation/update date on separate lines for better visibility"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Notebook Outline:\n",
"1. [Introduction](#intro)\n",
"1. [Descriptive Text](#desc_text)\n",
" 1. [Figures](#figs)\n",
" 1. [Tables](#tables)\n",
" 1. [Markdown vs. Html](#mkdwn_vs_html)\n",
"1. [Working with Code Cells](#code)\n",
"1. [References](#refs)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"**Style notes for Table of Contents:**\n",
"Use autonumbering (ex. 1. 1. 1. and let Markdown number sections), and keep anchor ids to section topics rather than section order (ex. 'figs' rather than sect_1a). This will help if you decide to restructure the Notebook."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"## Introduction"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This is a good spot to introduce the topic of the notebook and the problem. Should be a general overview but more detailed than the summary at the beginning of the notebook."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"## Descriptive Text"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"You can have multiple paragraphs in a cell or have one cell per paragraph depending on how you prefer to organize your text.\n",
"\n",
"Here is one way to add footnotes or references. [1](#wang_2010)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"### Figures"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Local and remote images can be added. Preferably store local images in an \"img\" folder. You can add images in Markdown, but `` tags can be easier to work with."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This is an easy way to include an image using Markdown.\n",
"\n",
"![This is a cat](img/example_cat.jpg \"My cat picture\")\n",
"\n",
"**Figure 1**: An image of a cat, image created using Markdown"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Setting image properties such as width and float behavior is easier using html.\n",
"\n",
"\n",
"\n",
"**Figure 2**: An image of a cat, image created using html `` tag"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"### Tables"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Tables can be created using Markdown, HTML, or from code output. Some examples follow. Tables should be described in the descriptive text and should include a table caption where relevant."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This is an example of a straightforward Markdown table.\n",
"\n",
"| Col 1 | Col 2 | Col 3 |\n",
"| --- | --- | --- |\n",
"| 2 | 4.5 | 6 |\n",
"| 0 | 1.98 | 10|\n",
"\n",
"**Table 1**: An example table in Markdown\n",
"\n",
"This is an example of a table using HTML.\n",
"\n",
"
Col 1 | Col 2 | Col 3 |
---|---|---|
2 | 4.5 | 6 |
0 | 1.98 | 10 |