tutorial_template

OpenEnergy Platform

OpenEnergyPlatform



The development of tutorials for the Open Energy Family takes place publicly in a dedicated tutorial repository. Please report bugs and suggestions as new issues. If Jupyter Notebooks are new to you and you'd like to get an introduction, have a look at this less than 10 minute introduction video. Official installation instructions are available on jupyter's readthedocs page.

license: GNU Affero General Public License Version 3 (AGPL-3.0)
copyright: name_of_institution
authors: author1, author2

Title of Tutorial

Takeaways

  • one thing people will learn in this tutorial
  • another thing people will learn
  • the last thing people will learn in this tutorial

Introduction

This optional paragraph may give a more detailed description of what the reader can expect to go through with this tutorial. It's a summary with an outline of the steps followed, data used, concepts to be covered and may include references to internal and external resources for context.

Setup

You need the following things to run through the entire tutorial:

  • An account at the OEP to access your username and API Token.
  • An environment with the following dependencies installed:
    • oedialect
    • ...

Actual first chapter / Content of tutorial

Note: Do see the structure and headlines as a suggestion and feel free to create your own structure if it better suits your purpose when explaining something.

Styling help for tutorial creators

Running the following commands will delete the tables from the database which you have in your ordered ORM. Take care that you only delete tables you actually want to have removed.

This shows up as a blue block. Suitable styling for tips / notes / infos.
This shows up as a yellow block. Suitable styling for warnings.
This shows up as a red block. Suitable styling for marking danger. Use sparingly e.g. when data loss is a possible risk.
This shows up as a green block. Suitable styling for success messages.
  • item in list
    • item in sublist
      1. first item in subsublist
      2. second item in subsublist
    • another item in sublist

This is a link and it refers to a markdown cheatsheet for Jupyter notebooks, so you can look up more styling options.

In [ ]:
 

If you find bugs or if you have ideas to improve the Open Energy Platform, you are welcome to add your comments to the existing issues on GitHub.
You can also fork the project and get involved.

Please note that the platform is still under construction and therefore the design of this page is still highly volatile!