Skip to content

Commit

Permalink
Add a boilerplate concept for one of the tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
fwitte committed Nov 25, 2024
1 parent 8fa7a62 commit e470517
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 3 deletions.
47 changes: 44 additions & 3 deletions docs/introductory_tutorials/tutorial_1.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,47 @@
.. _tutorial_1_label:

First tutorial
~~~~~~~~~~~~~~~~~~~~~~
District heating supply optimization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This page will display the first basic tutorial.
In this tutorial we will optimize the portfolio of a heating provider. balblable
balblable

.. figure:: /_files/example_network.svg
:align: center
:alt: Structure of the heating supplier's portfolio
:figclass: only-light

Structure of the heating supplier's portfolio

.. figure:: /_files/example_network_darkmode.svg
:align: center
:alt: Structure of the heating supplier's portfolio
:figclass: only-dark

Structure of the heating supplier's portfolio

The tutorial is set up in four steps:

1. asdasd
2. asdasd
3. asdasd
4. asdasdsa

Step 1: Build the linear model
------------------------------

prepare the model, import stuff

.. literalinclude:: /../tutorial/introductory/utilities-heat-supply.py
:language: python
:start-after: [sec_1]
:end-before: [sec_2]

next step, we need demand data

.. literalinclude:: /../tutorial/introductory/utilities-heat-supply.py
:language: python
:start-after: [sec_2]
:end-before: [sec_3]

next step, we need demand data
5 changes: 5 additions & 0 deletions tutorial/introductory/utilities-heat-supply.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# %%[sec_1]
import oemof.solph as solph

Check notice

Code scanning / CodeQL

Unused import Note

Import of 'solph' is not used.
# %%[sec_2]
import oemof.solph as solph

Check notice

Code scanning / CodeQL

Unused import Note

Import of 'solph' is not used.
# %%[sec_3]

0 comments on commit e470517

Please sign in to comment.