add notebooks

{{ cookiecutter.package_name }}/notebooks/README.md

@@ -0,0 +1,29 @@
+# Notebooks
+
+<!-- For Jupyter and other research notebooks.
+     The notebooks are listed and described.
+-->
+
+Table of Contents:
+<!-- MarkdownTOC -->
+
+- [Sample Notebook](#sample-notebook)
+
+<!-- /MarkdownTOC -->
+
+
+
+<a id="sample-notebook"></a>
+## [Sample Notebook](_sample/README.md)
+
+This is a short description for the sample notebook.
+
+Quick Links:
+
+- [here](_sample/README.md) for further documentation.
+- [notebook link](_sample/notebook.ipynb).
+- Description and code for [figures](_sample/figures/README.md).
+
+The most important image might be shown.
+
+<img src="_sample/figures/example-image-a.jpg" alt="sample image" width="300">

{{ cookiecutter.package_name }}/notebooks/_sample/README.md

@@ -0,0 +1,7 @@
+# Sample Notebook
+
+A longer description of this notebook.
+
+The goal of this notebook is to...
+
+The figures are also described in more detail [here](figures/README.md)

{{ cookiecutter.package_name }}/notebooks/_sample/figures/README.md

@@ -0,0 +1,46 @@
+# Sample Figures
+
+<!--
+This is a good place for a description of the figures. When writing a paper, these serve well as the figure captions.
+
+Figures can be embedded with the command 
+
+![Caption](example-image-a.jpg "Example Image Alt")
+
+Or with HTML, for finer control.
+
+<figure>
+    <img src="example-image-a.jpg" alt="Example Image Alt"
+        title="An Example Image" width="75%" height="75%" />
+    <figcaption>Fig.1 - Caption.</figcaption>
+</figure>
+-->
+
+Table of Contents:
+<!-- MarkdownTOC -->
+
+- [Figure 1](#figure-1)
+
+<!-- /MarkdownTOC -->
+
+
+- - -
+
+<a id="figure-1"></a>
+## Figure 1
+
+This is the descriptive text for the figure
+
+<figure>
+    <img src="example-image-a.jpg" alt="Example Image Alt"
+        title="An Example Image" width="75%" height="75%" />
+    <figcaption>Fig.1 - Caption.</figcaption>
+</figure>
+
+The code for this figure:
+
+```python
+import mycode
+
+mycode.make_figure_1()
+```

{{ cookiecutter.package_name }}/notebooks/_sample/notebook.ipynb

@@ -0,0 +1,138 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "source": [
+        "```markdown\n",
+        "TITLE   :  \n",
+        "AUTHOR  :\n",
+        "PROJECT :  \n",
+        "```\n"
+      ],
+      "metadata": {}
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "<span style='font-size:30px;font-weight:650'>\n",
+        "    About\n",
+        "</span>\n",
+        "\n",
+        "Information about this notebook.\n"
+      ],
+      "metadata": {}
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "<br><br>\n",
+        "\n",
+        "- - - \n",
+        "\n",
+        "# Prepare\n",
+        "\n",
+        "In this section we import packages, set parameters, and define basic functions.\n",
+        "\n",
+        "\n"
+      ],
+      "metadata": {}
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "## Imports"
+      ],
+      "metadata": {
+        "collapsed": false,
+        "outputHidden": false,
+        "inputHidden": false
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "# BUILT-IN\n",
+        "\n",
+        "# THIRD PARTY\n",
+        "\n",
+        "# PROJECT-SPECIFIC"
+      ],
+      "outputs": [],
+      "execution_count": 2,
+      "metadata": {
+        "collapsed": false,
+        "outputHidden": false,
+        "inputHidden": false,
+        "execution": {
+          "iopub.status.busy": "2020-09-10T18:56:17.184Z",
+          "iopub.execute_input": "2020-09-10T18:56:17.188Z",
+          "iopub.status.idle": "2020-09-10T18:56:17.193Z",
+          "shell.execute_reply": "2020-09-10T18:56:17.196Z"
+        }
+      }
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "<br><br>\n",
+        "\n",
+        "- - - \n",
+        "\n",
+        "\n",
+        "# Code"
+      ],
+      "metadata": {}
+    },
+    {
+      "cell_type": "code",
+      "source": [],
+      "outputs": [],
+      "execution_count": 4,
+      "metadata": {
+        "collapsed": false,
+        "outputHidden": false,
+        "inputHidden": false
+      }
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "<br><br>\n",
+        "\n",
+        "- - - \n",
+        "\n",
+        "<span style='font-size:40px;font-weight:650'>\n",
+        "    END\n",
+        "</span>"
+      ],
+      "metadata": {}
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "name": "python3",
+      "language": "python",
+      "display_name": "Python 3"
+    },
+    "language_info": {
+      "name": "python",
+      "version": "3.7.4",
+      "mimetype": "text/x-python",
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "pygments_lexer": "ipython3",
+      "nbconvert_exporter": "python",
+      "file_extension": ".py"
+    },
+    "nteract": {
+      "version": "0.25.0"
+    },
+    "kernel_info": {
+      "name": "python3"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 2
+}