Skip to content

Update tool_interface.rst #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
catcad wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Update tool_interface.rst #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/tool_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
Tool interface description
**************************

The tool should enable its users to model a local energy system (like an industry park or a district) with the possibility to include sector-coupling. This web-based tool is thought for planning purposes and not operation. It should allow the user to optimize the energy system model subject to equality constraints.
The tool should enable its users to model a local energy system (like an industry park, a district or a small village) with the possibility to include sector-coupling. This web-based tool is thought for planning purposes and not for operation. It should allow the user to optimize the energy system model subject to equality constraints.

The optimization is taken care of in the backend with the `oemof <https://oemof.org/>`_ framework. The role of the interface is thus to gather the necessary input parameters and to provide a vizualization of the outputs.

It is wished that this interface helps several actors with different perspectives and backgrounds to run scenarios or re-run scenarios changing only a few input parameters, compare their results with other scenarios and possibly engage in a dialogue.
It is wished that this interface helps several actors with different perspectives and backgrounds to run scenarios or re-run scenarios changing only a few input parameters, compare their results with other scenarios and possibly engage in a dialogue based on the knowledge gained.

One way to fullfill this wish, is to design the tool's interface collaboratively: by inviting different actors in a dialogue about the interface's functionalities before implementing the interface itself.

Expand All @@ -30,7 +30,7 @@ In order to describe the interface, a few definitions are required at first.

view
----
Description of a given state of the user interface: what should the user be able to interact with in that *view*, which other *view* can the user visit from the current *view*. The collection of *views* form together the user interface. Note: the view does not describe how the interface looks like to the user, this is described in the *view-rendering*.
Description of a given state of the user interface: what should the user be able to interact with in that *view*, which other *view* can the user visit from the current *view*. The collection of *views* form together the user interface. Note: the view does not describe how the interface looks like to the user (e.g. color, position), this is described in the *view-rendering*.

.. _view-component-def:

Expand Down Expand Up @@ -282,4 +282,4 @@ Inputs definition

.. _inputs-label:

.. include:: input_output/inputs.rst
.. include:: input_output/inputs.rst