Template How-To Guide

Download: template_how_to.py

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This work is licensed under a BSD 0-Clause License.
#
# Permission to use, copy, modify, and/or distribute this software
# for any purpose with or without fee is hereby granted.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
# THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
# OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""# Title

## Problem

Briefly state the problem.

## Solution

Provide the solution, straight to the point.

## Step-by-step guide

Describe the steps illustrating the solution (if necessary).
"""

# Insert imports here.

# %%
# ### 1. Title
#
# Very little text, if any. Here are prerequisites only.

# Insert code (mostly) to create the prerequisites.

# %%
# ### 2. Title
#
# Very little text, if any.

# Insert code (mostly).

# %%
# ## Summary
#
# The solution to the problem posed.
#
# ## One step further
#
# If applicable.