Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
245 lines (225 loc) · 8.23 KB
/
Copy pathmkdocs.yml
File metadata and controls
245 lines (225 loc) · 8.23 KB
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# SPDX-FileCopyrightText: PyPSA-Earth and PyPSA-Eur Authors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
site_name: PyPSA-Earth Documentation
site_url: https://pypsa-earth.readthedocs.io
repo_url: https://github.com/pypsa-meets-earth/pypsa-earth
repo_name: pypsa-earth
edit_uri: edit/main/doc/
# Documentation directory
docs_dir: doc
# Watch additional directories for live reload
watch:
- doc
- scripts
hooks:
- doc/assets/hooks/cleanup.py
# Navigation
nav:
- Home:
- index.md
- Introduction: home/introduction.md
- Installation: home/installation.md
- Quick Start: home/quick-start.md
- Tutorials:
- tutorials/tutorial-overview.md
- How to build and validate PyPSA-Earth model for a new country:
- "Part 1: Build a Baseline Model": tutorials/use-cases/1-baseline-model.md
- "Part 2: Analyse Results": tutorials/use-cases/2-analyze-results.md
- "Part 3: Calibrate Electricity Demand": tutorials/use-cases/3-demand-data.md
- "Part 4: Calibrate the Generation Fleet": tutorials/use-cases/4-generation-data.md
- "Part 5: Adapt Fuel and Generation Costs": tutorials/use-cases/5-adapting-costs.md
- "Part 6: Fix Isolated Nodes and Load Shedding": tutorials/use-cases/6-network-topology.md
- "Part 7: Improve the Transmission Network": tutorials/use-cases/7-transmission-network.md
- Generic Tutorials:
- Electricity Model: tutorials/generic-examples/electricity-model.md
- Sector-Coupled Model: tutorials/generic-examples/sector-coupled-model.md
- Examples: tutorials/generic-examples/examples.md
- Model Customization:
- General Modeling Guidelines: user-guide/model-customization.md
- Basic Setup: user-guide/customization/basic-setup.md
- Copernicus Data: user-guide/customization/copernicus-data.md
- Validation: user-guide/customization/validation.md
- Running Models: user-guide/customization/running-models.md
- User Guide:
- Structure: user-guide/structure.md
- Data Workflow: user-guide/data-workflow.md
- Configuration: user-guide/configuration.md
- Wildcards: user-guide/wildcards.md
- Costs: user-guide/costs.md
- Custom Data Integration: user-guide/custom-data.md
- Rules Overview: user-guide/rules-overview.md
- Plotting & Visualization: user-guide/plotting.md
- Rules Reference:
- Download & Filter:
- Overview: user-guide/rules-reference/download-and-filter/index.md
- Build Shapes: user-guide/rules-reference/download-and-filter/build-shapes.md
- Retrieve Data Bundle: user-guide/rules-reference/download-and-filter/retrieve-databundle-light.md
- Retrieve Emissions: user-guide/rules-reference/download-and-filter/retrieve-emissions.md
- Populate Data:
- Overview: user-guide/rules-reference/populate/index.md
- Build Bus Regions: user-guide/rules-reference/populate/build-bus-regions.md
- Build Cutout: user-guide/rules-reference/populate/build-cutout.md
- Build CO2 Emissions: user-guide/rules-reference/populate/build-co2-emissions.md
- Build Demand Profiles: user-guide/rules-reference/populate/build-demand-profiles.md
- Build Natura Raster: user-guide/rules-reference/populate/build-natura-raster.md
- Build Powerplants: user-guide/rules-reference/populate/build-powerplants.md
- Build Renewable Profiles: user-guide/rules-reference/populate/build-renewable-profiles.md
- Create Network:
- Overview: user-guide/rules-reference/create-network/index.md
- Base Network: user-guide/rules-reference/create-network/base-network.md
- Add Electricity: user-guide/rules-reference/create-network/add-electricity.md
- Simplify Network: user-guide/rules-reference/create-network/simplify-network.md
- Cluster Network: user-guide/rules-reference/create-network/cluster-network.md
- Alternative Clustering: user-guide/rules-reference/create-network/alternative-clustering.md
- Augmented Line Connection: user-guide/rules-reference/create-network/augmented-line-connections.md
- Add Extra Components: user-guide/rules-reference/create-network/add-extra-components.md
- Prepare Network: user-guide/rules-reference/create-network/prepare-network.md
- Solving:
- Overview: user-guide/rules-reference/solving/index.md
- Solve Network: user-guide/rules-reference/solving/solve-network.md
- Educational Materials:
- Optimization: user-guide/optimization.md
- Features:
- Monte Carlo: utilities/monte-carlo.md
- PyPSA-Earth CLI: utilities/pypsa-earth-cli.md
- Community & Resources:
- Contributing: community/contributing.md
- Project Structure: community/project-structure.md
- Users List: community/users-list.md
- Talks & Papers: community/talks-and-papers.md
- Learning Materials: community/learning-materials.md
- Software Hints: community/software-hints.md
- FAQ: community/faq.md
- API Reference:
- Overview: api-reference/index.md
- Data Download: api-reference/data-download.md
- Shapes & Regions: api-reference/shapes-regions.md
- Resources: api-reference/resources.md
- Network Building: api-reference/network-building.md
- Solving: api-reference/solving.md
- Sector-Coupling: api-reference/sector-coupling.md
- Analysis: api-reference/analysis.md
- Monte Carlo: api-reference/monte-carlo.md
- Utilities: api-reference/utilities.md
- Releases:
- Release Notes: releases/release-notes.md
- Maintenance: releases/maintenance-notes.md
# Theme settings
theme:
name: material
logo: https://github.com/pypsa-meets-earth/pypsa-meets-earth.github.io/raw/main/assets/img/logo.png
favicon: https://github.com/pypsa-meets-earth/pypsa-meets-earth.github.io/raw/main/assets/img/logo.png
font:
text: Roboto
code: Roboto Mono
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.indexes
- navigation.top
- header.autohide
- content.action.edit
- content.action.view
- content.code.copy
- toc.follow
- search.suggest
- search.highlight
- search.share
- announce.dismiss
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to light mode
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
- assets/javascripts/mermaid-init.js
- assets/javascripts/tutorial-cards.js
markdown_extensions:
# Standard Extensions
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- md_in_html
- toc:
title: On this page
permalink: true
toc_depth: 4
- footnotes
- attr_list
- md_in_html
# PyMdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.caret
- pymdownx.tilde
- pymdownx.mark
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ['.', 'doc']
- abbr
- attr_list
- def_list
- tables
plugins:
- search
- git-revision-date-localized:
type: timeago
timezone: UTC
enable_creation_date: true
- mkdocstrings:
enabled: true
default_handler: python
handlers:
python:
options:
docstring_style: sphinx
show_source: false
show_root_heading: true
show_root_full_path: false
show_symbol_type_heading: true
show_symbol_type_toc: true
members_order: source
group_by_category: true
- table-reader:
data_path: "doc"
allow_missing_files: false
- autorefs
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/pypsa-meets-earth/pypsa-earth
- icon: fontawesome/brands/discord
link: https://discord.gg/AnuJBk23FU
- icon: fontawesome/brands/google
link: https://drive.google.com/drive/folders/1U7fgktbxlaGzWxT2C0-Xv-_ffWCxAKZz
version:
provider: mike