Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise Electricity Tutorial #1359

Merged
merged 10 commits into from
Feb 25, 2025
Merged

Revise Electricity Tutorial #1359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fa298b2
revised tutorial for electricity
GbotemiB Feb 21, 2025
e900f8d
included copybutton into prompts
GbotemiB Feb 24, 2025
87c108e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 24, 2025
f67bb7c
include copy button into requirements
GbotemiB Feb 24, 2025
2ec1957
merge pre-commit changes
GbotemiB Feb 24, 2025
65cf122
included retrivedatabundle option to tutorial config
GbotemiB Feb 24, 2025
0cc7434
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 24, 2025
010d3db
included workflow dag
GbotemiB Feb 24, 2025
7213c12
merge pre-commit changes
GbotemiB Feb 24, 2025
b147ae6
fixed spacing
GbotemiB Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config.tutorial.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ tutorial: true
countries: ["NG", "BJ"]

enable:
retrieve_databundle: true
build_natura_raster: true
progress_bar: false

Expand Down
5 changes: 5 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx.ext.graphviz",
"sphinx_copybutton",
# "sphinx.ext.pngmath",
# "sphinxcontrib.tikz",
# "rinoh.frontend.sphinx",
Expand Down Expand Up @@ -184,3 +185,7 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

copybutton_prompt_text = r"\.{3}/[^$]*\$ " # Matches the pattern .../something $
copybutton_prompt_is_regexp = True
copybutton_only_copy_prompt_lines = True
4 changes: 2 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Documentation
* :doc:`introduction`
* :doc:`installation`
* :doc:`docker_containers`
* :doc:`short_tutorial`
* :doc:`tutorial_electricity`
* :doc:`tutorial`
* :doc:`data_workflow`
* :doc:`notebooks`
Expand All @@ -114,7 +114,7 @@ Documentation
introduction
installation
docker_containers
short_tutorial
tutorial_electricity
tutorial
data_workflow
notebooks
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ sphinx
sphinx_book_theme
sphinxcontrib-bibtex
myst-parser # recommark is deprecated, https://stackoverflow.com/a/71660856/13573820
sphinx-copybutton

pypsa >=0.24, <0.25
vresutils>=0.3.1
Expand Down
107 changes: 0 additions & 107 deletions doc/short_tutorial.rst
View file
Open in desktop

This file was deleted.

Loading
Loading