simses/mkdocs.yml at main · tum-ees/simses · GitHub

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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
site_name: simses
site_description: A Python simulator for battery energy storage systems.
site_author: TUM EES
site_url: https://tum-ees.github.io/simses/

repo_url: https://github.com/tum-ees/simses
repo_name: tum-ees/simses
edit_uri: edit/main/docs/

docs_dir: docs
theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tracking
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
  - mkdocs-jupyter:
      execute: true
      include_source: true
      remove_tag_config:
        remove_input_tags:
          - hide-input
        remove_all_outputs_tags:
          - hide-output

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Concepts:
      - Battery Model: concepts/battery.md
      - Converter: concepts/converter.md
      - Degradation: concepts/degradation.md
      - Thermal Models: concepts/thermal.md
  - User Guides:
      - Installation: guides/installation.md
      - Choosing a Cell Model: guides/cell-models.md
      - Choosing an Aging Model: guides/aging-models.md
      - Choosing a Converter Model: guides/converter-models.md
      - Multi-String Systems: guides/multi-string.md
      - Logging and Plots: guides/logging-and-plots.md
      - Extending Cell Models: guides/extending-cells.md
      - Extending Converter Models: guides/extending-converters.md
      - Extending Degradation: guides/extending-degradation.md
      - Extending Storage: guides/extending-storage.md
  - Tutorials:
      - Overview: tutorials/index.md
      - Demo: tutorials/demo.ipynb
  - API Reference:
      - Overview: api/index.md
      - Battery: api/battery.md
      - Converter: api/converter.md
      - Degradation: api/degradation.md
      - Thermal: api/thermal.md
      - Interpolation: api/interpolation.md
      - Models: api/models.md
  - Contributing: contributing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tum-ees/simses

copyright: Copyright &copy; 2020&ndash;2026 TUM EES