EPM/mkdocs.yml at main · ESMAP-World-Bank-Group/EPM · 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
site_name: EPM — Electricity Planning Model
site_description: Least-cost capacity expansion and dispatch model for power system planning
site_author: ESMAP — World Bank
# site_url: https://esmap-world-bank-group.github.io/EPM
repo_url: https://github.com/ESMAP-World-Bank-Group/EPM
repo_name: ESMAP-World-Bank-Group/EPM
edit_uri: edit/main/docs/

docs_dir: docs
exclude_docs: |
  _build/
  data/~$*

theme:
  name: material
  logo: images/esmap_white.png
  favicon: images/favicon.webp
  language: en
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: custom
      accent: custom
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.collapse
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
    - header.autohide

nav:
  - Introduction:
    - What is EPM?: introduction/introduction.md
    - EPM in Practice: introduction/introduction_case_studies.md
    - How EPM Works: introduction/introduction_workflow.md
  - Installation & Run:
    - Installation: run/run_installation.md
    - Run from Dashboard: run/run_dashboard.md
    - Run from Python: run/run_python.md
    - Run from GAMS Studio: run/run_gams_studio.md
    - Run on Remote Server: run/run_remote_server.md
    - Publish & Sync Data (DVC): run/run_data_sync.md
    - Dispatch Mode: run/run_dispatch.md
    - Solver Options: run/options_solver.md
    - Performance & Threads: run/options_thread.md
    - Debugging: run/run_debugging.md
  - Model:
    - Overview: model/model_overview.md
    - Objective Function: model/model_objective.md
    - Time Representation: input/input_representative_days.md
    - Constraints: model/model_constraints.md
    - Reference: model/equations.md
  - Input:
    - Setup: input/input_setup.md
    - Typical Values: input/input_parameter_guide.md
    - Input Catalog: input/input_detailed.md
    - Open Data Sources: input/input_open_data.md
  - Output:
    - Overview: output/output_overview.md
    - Output Catalog: output/output_catalog.md
    - Visualization: output/visualization.md
  - Contributing:
    - Get Involved: contributing/contributing_issues.md
    - Contribute Code: contributing/contributing_code.md
    - Contribute Docs: contributing/contributing_docs.md
  - Resources:
    - Data Preparation: preprocessing/pre_overview.md
    - Study Methodology: other/other_process.md
    - Transmission Costing: other/interconnection.md
    - Citation: resources/citation.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  - javascripts/mathjax.js
  - javascripts/header_logos.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ESMAP-World-Bank-Group/EPM
  generator: false

copyright: >
  All content is subject to the
  <a href="https://raw.githubusercontent.com/worldbank/template/main/LICENSE">World Bank Master Community License Agreement</a>.
  &nbsp;&nbsp;|&nbsp;&nbsp; Contact:
  <a href="mailto:cnicolas@worldbank.org">Claire Nicolas</a>