Merge pull request #37 from PowerGridModel/feature/workshop-context

chore: add readme and minor changes

Author: Thijss

power-grid-model-ds/README.md

@@ -0,0 +1,26 @@
+<!--
+SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
+
+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

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"
    ]
   },
   {

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,