Skip to content

chore: add readme and minor changes #37

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

Merged
merged 2 commits into from
Jun 3, 2025
Merged

chore: add readme and minor changes #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf85010
chore: add readme and minor changes
jaapschoutenalliander May 30, 2025
db07a1f
chore: reuse
jaapschoutenalliander May 30, 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
26 changes: 26 additions & 0 deletions power-grid-model-ds/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!--
SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>

SPDX-License-Identifier: MPL-2.0
-->

# Power Grid Model DS Workshop

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.

## Workshop Structure

The workshop includes two Jupyter notebooks:

1. **Introduction Notebook**
A beginner-friendly guide that walks you through the basics of using the Power Grid Model DS interface. Ideal for first-time users.

2. **Advanced Notebook**
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.

## How to Load Solutions

Each notebook includes optional solution cells. To reveal a solution, simply run the appropriate `%load` command. For example:

```python
%load solutions/introduction_1_1_define_array_extensions
2 changes: 1 addition & 1 deletion power-grid-model-ds/advanced.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install pandas power-grid-model-ds[visualizer] --quiet"
"!pip install 'pandas' 'power-grid-model-ds[visualizer]' --quiet"
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions power-grid-model-ds/introduction.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install power-grid-model-ds[visualizer] --quiet"
"!pip install 'power-grid-model-ds[visualizer]' --quiet"
]
},
{
Expand Down Expand Up @@ -540,7 +540,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -554,7 +554,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.13.2"
"version": "3.12.6"
}
},
"nbformat": 4,
Expand Down