Skip to content

Commit bf85010

Browse files
chore: add readme and minor changes
Signed-off-by: jaapschoutenalliander <[email protected]>
1 parent b4b6175 commit bf85010

File tree

3 files changed

+24
-4
lines changed

3 files changed

+24
-4
lines changed

power-grid-model-ds/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Power Grid Model DS Workshop
2+
3+
Welcome to the **Power Grid Model DS Workshop** — an introductory guide to the [Power Grid Model DS](https://github.com/PowerGridModel/power-grid-model-ds) project. This workshop is designed to help you get familiar with the PGM-DS interface and explore its capabilities through hands-on exercises.
4+
5+
## Workshop Structure
6+
7+
The workshop includes two Jupyter notebooks:
8+
9+
1. **Introduction Notebook**
10+
A beginner-friendly guide that walks you through the basics of using the Power Grid Model DS interface. Ideal for first-time users.
11+
12+
2. **Advanced Notebook**
13+
A more in-depth exploration featuring a grid contingency scenario. You'll apply your knowledge to solve a real-world power grid challenge using PGM-DS.
14+
15+
## How to Load Solutions
16+
17+
Each notebook includes optional solution cells. To reveal a solution, simply run the appropriate `%load` command. For example:
18+
19+
```python
20+
%load solutions/introduction_1_1_define_array_extensions

power-grid-model-ds/advanced.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"metadata": {},
88
"outputs": [],
99
"source": [
10-
"!pip install pandas power-grid-model-ds[visualizer] --quiet"
10+
"!pip install 'pandas' 'power-grid-model-ds[visualizer]' --quiet"
1111
]
1212
},
1313
{

power-grid-model-ds/introduction.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"metadata": {},
2929
"outputs": [],
3030
"source": [
31-
"!pip install power-grid-model-ds[visualizer] --quiet"
31+
"!pip install 'power-grid-model-ds[visualizer]' --quiet"
3232
]
3333
},
3434
{
@@ -540,7 +540,7 @@
540540
],
541541
"metadata": {
542542
"kernelspec": {
543-
"display_name": "Python 3 (ipykernel)",
543+
"display_name": ".venv",
544544
"language": "python",
545545
"name": "python3"
546546
},
@@ -554,7 +554,7 @@
554554
"name": "python",
555555
"nbconvert_exporter": "python",
556556
"pygments_lexer": "ipython3",
557-
"version": "3.13.2"
557+
"version": "3.12.6"
558558
}
559559
},
560560
"nbformat": 4,

0 commit comments

Comments
 (0)