Added picture and note at front page

ESDLMapEditorESSIM · Feb 3, 2021 · c670a05 · c670a05
1 parent 614184c
commit c670a05
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/docs/source/example_workflows/exploring_roof_pv_panels_potential.rst b/docs/source/example_workflows/exploring_roof_pv_panels_potential.rst
@@ -103,7 +103,12 @@ The last functionality is to convert (part of) the potential to installed capaci
   .. image:: images/use_rooftop_pv_potential.png
     :alt: Use Rooftop PV Potential
 
-3. If you open the building editor again, the result looks like this. By right clicking on an icon for a PV installation and selecting 'Edit' from the menu, values can be inspected (the produced energy is connected as a SingleValue profile to the OutPort of the PVInstallation asset).
+3. If you open the building editor again, the result looks like this. By right clicking on an icon for a PV installation and selecting 'Edit' from the menu, values can be inspected.
 
   .. image:: images/building_editor_installed_pv_installations.png
     :alt: Installed PV installations
+
+.. note::
+    ESDL: The produced energy in kWh is connected as a SingleValue profile to the OutPort of the PVInstallation asset.
+    Other models, like for example the Energy Transition Model, know how to handle this information and are able to
+    take these values into account.
diff --git a/docs/source/images/mapeditor.png b/docs/source/images/mapeditor.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,14 @@
 Welcome to the ESDL MapEditor documentation
 ===========================================
 
+.. image:: images/mapeditor.png
+  :alt: The ESDL MapEditor
+
+.. note::
+    This documentation is work in progress and far from finished. New sections will be added in the near future.
+    Whenever questions or feedback is received from end users, we're trying to update this documentation on the fly.
+    So don't hesitate to contact us, whenever you run into problems.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: