power-system-simulation

This is a student project for Power System Simulation.

Installation

This project uses uv for dependency management.

In the root of the repository, sync all dependencies using:

uv sync

After installation, run the test.

uv run pytest

Code style and quality check

This project uses ruff for linting and formatting.

You can run the following command to check and auto-fix code issues:

uv run ruff check --fix .

You can run the following command to format your code:

uv run ruff format .

Working with Jupyter Notebooks

Jupyter notebooks in the example/ folder can be opened directly in VS Code. The project includes ipykernel in the development dependencies, which allows VS Code to run notebook cells using the .venv environment.

Folder structure of the repository

The folder structure of the repository is explained as below.

• src/power_system_simulation is the main folder of the package. You should put your new functionality code there.
• tests is the folder containing the test files. You should put your test code there.
• example contains the example notebook. You should modify the notebook for your presentation.
• .vscode contains the setting file for the IDE VSCode.
• .github/workflows contains the continuous integration (CI) configurations.