muse2 2.1.0

A tool for running simulations of energy systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

from table2md import MarkdownTable
from yaml import dump


def to_yaml_str(value) -> str:
    return dump(value).removesuffix("\n...\n")


def fields2table(fields: list[dict[str, str]]) -> str:
    data = []
    for f in fields:
        notes = f.get("notes", "")

        default = f.get("default", None)
        if default is not None:
            notes = f"Optional. Defaults to `{to_yaml_str(default)}`.\n\n{notes}"

        # MarkdownTable can't handle newlines, so replace with HTML equivalent
        notes = notes.replace("\n\n", "<br /><br />").replace("\n", " ")
        description = (
            f["description"].replace("\n\n", "<br /><br />").replace("\n", " ")
        )

        row = {
            "Field": f"`{f['name']}`",
            "Description": description,
            "Notes": notes,
        }
        data.append(row)
    return str(MarkdownTable.from_dicts(data))