Dtk readthedocs

[tolga-akan]

Create Read The Docs documentation for Design Tool Kit.

Main idea:

• Add/improve existing MESIDO documentation for the purpose of making it part of DTK general documentation
• Intended use: general user
• Add new chapter: something generic like: “Supported Tools”. In this chapter sub section: “DTK tool support”

1. Workflows:

• List and give definition of each workflow that is meaningful to a general user

2. DTK Assets and asset attributes (settings do we need) supported, items to include:

• Table: Asset attribute document
• Asset physics: Links to implemented assets (high level and detail)
• Asset attribute excel document is not perfect at the moment. Settings missing currently in the excel document:
  • heating demand needs a profile, like profile constraints and other constraints (do not support all constraints yet)?
• Example for instance Configuration — ESSIM Documentation documentation

3. Getting started idea -> Example case (PoC for example -> can now use the new training?):

• Goal to show steps on how to start from scratch and create results, no detail interpretation of the results/KPIs
• 1 case step by step guide on how to draw, connect, setup case, run case, view results/KPIs

4. Asset connection configuration:

• Small screen shots on way to connect different types of assets

5. Assets:

• How are the assets represented/modelled and what are the main assumptions, link to relevant MESIDO documentation section.
• High level documentation, explaining of what the asset is, assumption etc (maybe specific to DTK?). Link to relevant MESIDO existing documentation, but if very specific assumption etc. for DTK then a new section (maybe add this info the DTK assets supported) would be needed.