The steps for the workshop are to follow Power Flow Example.ipynb and Power Flow Assignment.ipynb simultaneously. To complete the workshop on your own, go through Power Flow Example notebook while completing the respective assignment from at each checkpoint. If you like to be guided through the workshop, please visit our Power Grid Model Workshop recording.

Participants are expected to have knowledge of Juypter Notebook and numpy.

It is recommended to read the numpy structured array documentation.

Please create the relevant environment before the workshop. If you encounter problems, please raise a question in the discussion board

1. Open a terminal
   • Windows: Press Windows-Key + R, type cmd, press OK
   • Mac/Linux: Open a terminal
2. Download or clone this workshop/repository
   • if you download the repository, remember the destination location. For example:
     • Windows:C:\Users\YourUserName\Downloads\power-grid-model-workshop
     • Mac/Linux: ~/Downloads/power-grid-model-workshop
3. Install the uv package manager link for your operating system (Windows/Mac/Linux)
4. Navigate to the repository folder
   • Windows: cd Downloads\power-grid-model-workshop
   • Mac/Linux: cd ~/Downloads/power-grid-model-workshop
5. Setup python environment and install dependencies using uv:

   uv sync

6. Start jupyter notebook. It will probably (depending on your system) automatically open a browser at http://localhost:8888. If not, the console output will tell you where to find the jupyter notebook server.

   uv run jupyter notebook

7. Try any of the .ipynb files, for example Power Flow Example.ipynb and press the >> button to run the entire file. Note that the last section in the Power Flow Example is about error handling, so don't get scared if you see some error messages there.

1. Again, open a terminal

   • Windows: Press Windows-Key + R, type cmd, press OK
   • Mac/Linux: Open a terminal

2. Navigate to the repository folder

   • Example:
     • Windows: cd Downloads\power-grid-model-workshop
     • Mac/Linux: cd ~/Downloads/power-grid-model-workshop

3. Start jupyter notebook. It will probably (depending on your system) automatically open a browser at http://localhost:8888. If not, the console output will tell you where to find the jupyter notebook server.

   uv run jupyter notebook

This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.

Please read CODE_OF_CONDUCT and CONTRIBUTING for details on the process for submitting pull requests to us.

Visit Contribute for a list of good first issues in this repo.

Please read SUPPORT for how to connect and get into contact with the Power Grid Model project.