Skip to content

Commit

Permalink
added new content
Browse files Browse the repository at this point in the history
  • Loading branch information
edwinmatthijssen committed Jan 7, 2021
1 parent c05f16d commit 259995c
Show file tree
Hide file tree
Showing 6 changed files with 113 additions and 12 deletions.
12 changes: 11 additions & 1 deletion docs/source/features/building_information.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
Building information
====================

BAG data
Whenever you load an ESDL file, with buildings in it with their geometry (for example using the ESDL BAG service), the
MapEditor will visualize these buildings on the map. It will try to find three specific attributes of these buildings,
namely building year, building area and building type. The buildings will be colored according to these attributes. You
can choose the attribute that should be used for coloring in the dropdown menu at the top op the legend.

.. image:: images/building_information.png
:width: 800
:alt: Visualizing buildings with their building year, building area and building type attributes

ESDL BAG service
^^^^^^^^^^^^^^^^
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/source/features/workflow_definition.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Workflow definition
===================
19 changes: 9 additions & 10 deletions docs/source/introduction/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ The ESDL MapEditor is a map based editor for energy systems or energy transition
Energy System Description Language (ESDL).

It provides the following functionality:
- Draw an energy system scenario by dragging and dropping energy assets on a map
- Connect components, set typical component characteristics (installed power, efficiencies, costs)
- Attach power or energy profiles to assets (demand and production profiles)
- Set control strategies (specifically needed for ESSIM simulations)
- Query external ESDL data sources, for example for solar or wind potential
- Visualize WMS layers with information that can be used to define your scenario
- Convert shapefiles into ESDL assets
- Query the boundary service for area borders (provinces, municipalities)
- Visualize results of simulations on the map (KPI dashboards, load animations, color areas based on KPI outcomes, load duration curves)


* Draw an energy system scenario by dragging and dropping energy assets on a map
* Connect components, set typical component characteristics (installed power, efficiencies, costs)
* Attach power or energy profiles to assets (demand and production profiles)
* Set control strategies (specifically needed for ESSIM simulations)
* Query external ESDL data sources, for example for solar or wind potential
* Visualize WMS layers with information that can be used to define your scenario
* Convert shapefiles into ESDL assets
* Query the boundary service for area borders (provinces, municipalities)
* Visualize results of simulations on the map (KPI dashboards, load animations, color areas based on KPI outcomes, load duration curves)
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 91 additions & 1 deletion docs/source/user_interface/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Number Description
4 Line draw select tool
5 Area select; determines to which ESDL area assets are being added
6 Logout button
7 ESDL layer control
7 Layer control
8 Zoom buttons
9 Create screenshot of current view
10 ESSIM simulation controls
Expand All @@ -30,3 +30,93 @@ Number Description
16 Shows the coordinates (lat/lon) of the mouse pointer on the map
====== ====================================================================

Top level menus (1)
-------------------

File menu
^^^^^^^^^

.. csv-table::
:header: "Menu item", "Description"

"New ESDL", "Start with a new empty energy system. Remove all current ESDL files loaded."
"Load ESDL", "Load an ESDL file from your local file system. Remove all current ESDL files loaded."
"Import ESDL", "Import an ESDL file from your local file system. This ESDL will be added to the list of loaded ESDLs in the layer control section (7)."
"Save ESDL", "Save the currently selected ESDL to your local file system."
"Load from ESDL drive", "Load or import an ESDL file from the ESDL drive (ESDL cloud storage)."
"Save to ESDL drive", "Save an ESDL to the ESDL drive."

Only for Mondaine project partners (the Mondaine Hub was the predecessor of the ESDL drive):

.. csv-table::
:header: "Menu item", "Description"

"Load ESDL from Mondaine Hub", "Load or import an ESDL file from the Mondaine Hub"
"Save ESDL to Mondaine Hub", "Save an ESDL file to the Mondaine Hub"

Edit menu
^^^^^^^^^

.. csv-table::
:header: "Menu item", "Description"

"ESDL browser", ""
"Energy carriers", ""
"Sectors", ""
"Shapefile converter", ""

Services menu
^^^^^^^^^^^^^

.. csv-table::
:header: "Menu item", "Description"

"Energy system statistics", ""
"External ESDL services", ""
"Get boundary information", ""
"ESSIM simulation", ""
"Load animation", ""
"ESDL compare", ""
"ESDL merge", ""

View menu
^^^^^^^^^

.. csv-table::
:header: "Menu item", "Description"

"WMS layers", "Allows to visualize WMS layers in the MapEditor"
"Show/hide animation toolbar", "Show or hide the animation toolbar - for controlling the load animation"
"Show/hide asset draw toolbar", "Show or hide the asset draw toolbar - for quickly adding certain assets"
"Show/hide KPIs", "Show or hide KPI window"
"Settings", "Settings for the MapEditor and its plugins"

Layer control (7)
-----------------

The layer control is split into two sections:
* Base layers
* ESDL layers

The base layers section allows you to choose the backgorund of the map, either openstreetmap (the default), google or
no map. The latter one can be used for schematic diagrams where the physical location is not important.

In the ESDL layer section you will find one item for each ESDL loaded in the MapEditor. The ESDL information is separated
in different layers that can each be shown or hidden. See the table below for a detailed description of the different
ESDL sub layers.

.. image:: images/layer_control.png
:alt: ESDL layer control

================== =========================================================
Layer Description
================== =========================================================
Area Layer showing the area boundaries
Assets Layer showing all ESDL assets
Connections Layer showing logical connections between assets
Buildings Layer showing building geometries
Potentials Layer showing energy potential information
KPIs Layer showing KPIs
Simulation results Layer showing simulation results, like animation of loads
Notes Layer showing the notes
================== =========================================================

0 comments on commit 259995c

Please sign in to comment.