From bf85010f8db4ee74fceb527373426990a545d026 Mon Sep 17 00:00:00 2001 From: jaapschoutenalliander Date: Fri, 30 May 2025 14:26:23 +0200 Subject: [PATCH 1/2] chore: add readme and minor changes Signed-off-by: jaapschoutenalliander --- power-grid-model-ds/README.md | 20 ++++++++++++++++++++ power-grid-model-ds/advanced.ipynb | 2 +- power-grid-model-ds/introduction.ipynb | 6 +++--- 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 power-grid-model-ds/README.md diff --git a/power-grid-model-ds/README.md b/power-grid-model-ds/README.md new file mode 100644 index 0000000..c98f6e6 --- /dev/null +++ b/power-grid-model-ds/README.md @@ -0,0 +1,20 @@ +# 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 diff --git a/power-grid-model-ds/advanced.ipynb b/power-grid-model-ds/advanced.ipynb index 81993ce..537da60 100644 --- a/power-grid-model-ds/advanced.ipynb +++ b/power-grid-model-ds/advanced.ipynb @@ -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" ] }, { diff --git a/power-grid-model-ds/introduction.ipynb b/power-grid-model-ds/introduction.ipynb index c219ca0..318bb43 100644 --- a/power-grid-model-ds/introduction.ipynb +++ b/power-grid-model-ds/introduction.ipynb @@ -28,7 +28,7 @@ "metadata": {}, "outputs": [], "source": [ - "!pip install power-grid-model-ds[visualizer] --quiet" + "!pip install 'power-grid-model-ds[visualizer]' --quiet" ] }, { @@ -540,7 +540,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": ".venv", "language": "python", "name": "python3" }, @@ -554,7 +554,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.13.2" + "version": "3.12.6" } }, "nbformat": 4, From db07a1fa91e72dd038f981a2b917ec2b0eb8b62d Mon Sep 17 00:00:00 2001 From: jaapschoutenalliander Date: Fri, 30 May 2025 14:28:24 +0200 Subject: [PATCH 2/2] chore: reuse Signed-off-by: jaapschoutenalliander --- power-grid-model-ds/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/power-grid-model-ds/README.md b/power-grid-model-ds/README.md index c98f6e6..8f11b39 100644 --- a/power-grid-model-ds/README.md +++ b/power-grid-model-ds/README.md @@ -1,3 +1,9 @@ + + # 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.