ait-energy / iesopt

Python wrapper for the energy system optimization framework IESopt.
MIT License
7 stars 1 forks source link

Improvements for documentation of top-level config file (`config.iesopt.yaml`) needed #15

Open GerhardTotschnig opened 1 week ago

GerhardTotschnig commented 1 week ago

@sstroemer Presently the input fields for carriers, connections, decissions, nodes, profiles and units are available at: https://ait-energy.github.io/iesopt/pages/reference/yaml/index.html https://ait-energy.github.io/IESopt.jl/dev/pages/manual___reference/api/

Good would be to have additionally a documentation on:

  1. The first block of the iesopt.yaml: the config block.
  2. A list of default settings for the config block would be needed. In exmaple 04 of IESoptLib.jl it is mentioned that parameter _constraintsafety is true by default. A list of deffault vaules for this config block is important.
  3. Example iesopt.yaml with all the possible sections and keywords (addons, templates, ...)
  4. Explaination of the rules for the iesopt.yaml. Order of the blocks important or not? Naming convention. How to find the default values?
sstroemer commented 1 day ago

Some reworks as part of ait-energy/IESopt.jl#20 should fix this (for the most part) soon: