opf-potpourri 0.2.0__tar.gz

opf_potpourri-0.2.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Institute for High Voltage Equipment and Grids,
+Digitalization and Energy Economics (IAEW), RWTH Aachen University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

opf_potpourri-0.2.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: opf-potpourri
+Version: 0.2.0
+Summary: Multi-period Optimal Power Flow for distribution grids with storage — Pyomo models over pandapower networks
+Author-email: Steffen Kortmann <s.kortmann@iaew.rwth-aachen.de>, Andreas Bong <a.bong@iaew.rwth-aachen.de>, Simon Braun <s.braun@iaew.rwth-aachen.de>, Alexander Och <a.och@iaew.rwth-aachen.de>, Farah Nasr <f.nasr@iaew.rwth-aachen.de>, Philip Kvesic <p.kvesic@iaew.rwth-aachen.de>, Nina Stumberger <n.stumberger@iaew.rwth-aachen.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/RWTH-IAEW/opf-potpourri
+Project-URL: Repository, https://github.com/RWTH-IAEW/opf-potpourri
+Project-URL: Documentation, https://opf-potpourri.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/RWTH-IAEW/opf-potpourri/issues
+Keywords: power systems,pandapower,optimal power flow,pyomo,distribution grid,multi-period,OPF
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Intended Audience :: Science/Research
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru>=0.7
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: numpy>=1.24
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: pandapower>=2.13
+Requires-Dist: pandas>=2.0
+Requires-Dist: pyomo>=6.7
+Requires-Dist: simbench>=1.4
+Provides-Extra: gurobi
+Requires-Dist: gurobipy>=10.0; extra == "gurobi"
+Provides-Extra: notebooks
+Requires-Dist: jupyterlab>=4.0; extra == "notebooks"
+Requires-Dist: notebook>=7.0; extra == "notebooks"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: pre-commit>=4.0; extra == "dev"
+Provides-Extra: performance-test
+Requires-Dist: perfplot>=0.10.2; extra == "performance-test"
+Dynamic: license-file
+
+# potpourri
+
+**Multi-Period Optimal Power Flow for Distribution Grids with Storage Application**
+
+> *Potpourri — piece of music composed from various popular smaller works or melodies*
+
+[![CI](https://github.com/RWTH-IAEW/opf-potpourri/actions/workflows/ci.yml/badge.svg)](https://github.com/RWTH-IAEW/opf-potpourri/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/opf-potpourri/badge/?version=latest)](https://opf-potpourri.readthedocs.io/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+`potpourri` is a Python library for AC/DC Optimal Power Flow (OPF) in distribution grids, with support for multi-period planning and flexible resources (batteries, EVs, heat pumps, PV, wind). It wraps [Pyomo](https://pyomo.readthedocs.io/) for optimisation modelling over [pandapower](https://pandapower.readthedocs.io/) network objects.
+
+**Repository:** <https://github.com/RWTH-IAEW/opf-potpourri>
+
+---
+
+## Documentation
+
+The project documentation is built with [MkDocs](https://www.mkdocs.org/).
+
+To serve the documentation locally:
+
+```bash
+pip install -e .[docs]
+mkdocs serve          # usually available at http://127.0.0.1:8000/
+```
+
+---
+
+## Installation
+
+Requires Python 3.9–3.12 and Conda (or Mamba).
+
+```bash
+conda env create -f environment.yaml
+conda activate potpourri_env
+pip install -e .
+```
+
+To update an existing environment:
+
+```bash
+conda env update -f environment.yaml --prune
+```
+
+A Dockerfile is provided for a fully containerised setup with IPOPT 3.14.16
+compiled from source, CBC, and SHOT solvers.
+
+---
+
+## Quick start
+
+### Single-period AC OPF
+
+```python
+import simbench as sb
+from potpourri.models.ACOPF_base import ACOPF
+
+net = sb.get_simbench_net("1-LV-rural1--0-sw")
+opf = ACOPF(net)
+opf.add_OPF()
+opf.add_voltage_deviation_objective()
+opf.solve(solver="ipopt", print_solver_output=False)
+
+# results available in net.res_bus, net.res_line, net.res_sgen, ...
+print(opf.net.res_bus[["vm_pu", "va_degree"]])
+```
+
+### Multi-period AC OPF with battery storage
+
+```python
+import simbench as sb
+from potpourri.models_multi_period.ACOPF_multi_period import ACOPF_multi_period
+from potpourri.technologies.battery import Battery_multi_period
+
+net = sb.get_simbench_net("1-LV-urban6--0-sw")
+opf = ACOPF_multi_period(net, toT=96, fromT=0)   # 96 × 15 min = 1 day
+
+battery = Battery_multi_period(opf.net, T=96, scenario=1)
+battery.get_all(opf.model)
+
+opf.add_OPF()
+opf.add_voltage_deviation_objective()
+opf.solve(solver="ipopt")
+```
+
+See `scripts/` for runnable examples covering each feature area.
+
+---
+
+## Architecture
+
+### Single-period models (`src/potpourri/models/`)
+
+```
+Basemodel     creates ConcreteModel, maps pandapower → Pyomo sets/params, solve()
+  ├── AC      full AC power flow (KCL/KVL, voltage magnitudes, reactive power)
+  ├── DC      linearised DC power flow (no reactive power)
+  └── OPF     operational constraints (P/Q limits, line loading, voltage bounds)
+
+ACOPF    = AC + OPF   (multiple inheritance)
+DCOPF    = DC + OPF
+HC_ACOPF = ACOPF + binary variables for hosting-capacity analysis
+```
+
+### Multi-period models (`src/potpourri/models_multi_period/`)
+
+```
+Basemodel_multi_period    adds time index T, integrates SimBench profiles
+  └── ACOPF_multi_period  (AC_multi_period + OPF_multi_period)
+
+Flexibility_multi_period  abstract base for all flexible devices
+  ├── Battery_multi_period
+  ├── HeatPump_multi_period
+  ├── PV_multi_period
+  ├── Windpower_multi_period
+  ├── Demand_multi_period
+  ├── Sgens_multi_period
+  └── Generator_multi_period
+```
+
+Flexible devices are **composed, not inherited** — each is instantiated
+separately and attaches its own Pyomo Sets/Params/Vars/Constraints to the
+parent model.
+
+### Data flow
+
+```
+pandapower net
+  → Basemodel.__init__()    pp.runpp(), extract admittance data
+  → create_model()          Pyomo ConcreteModel + sets/params/vars
+  → add_OPF()               unfix controllable vars, add limits/objectives
+  → .solve(solver)          SolverFactory → NLP/MIP
+  → pyo_to_net()            write solution back to net.res_*
+```
+
+---
+
+## External dependencies
+
+| Package | Role |
+|---|---|
+| `pandapower >= 2.13` | Network data model, initial power flow |
+| `pyomo >= 6.7` | Optimisation modelling |
+| `simbench >= 1.4` | Benchmark networks and time-series profiles |
+| `numpy`, `pandas` | Numerical / data processing |
+| `matplotlib` | Plotting |
+
+### Solvers
+
+`potpourri` does not bundle any solvers. Install at least one before
+calling `solve()`.
+
+| Solver | Type | Install |
+|---|---|---|
+| **IPOPT** | NLP — AC OPF | `conda install -c conda-forge ipopt` |
+| **GLPK** | LP / MIP — DC OPF | `conda install -c conda-forge glpk` |
+| **CBC** | LP / MIP | `conda install -c conda-forge coincbc` |
+| **Gurobi** | LP / MIP / NLP | `pip install gurobipy` (licence required) |
+| **NEOS** | Remote (free) | `opf.solve(solver='neos', neos_opt='ipopt')` |
+
+IPOPT and GLPK are included automatically when you create the environment
+from `environment.yaml`.
+
+---
+
+## Development
+
+```bash
+pip install -e ".[dev]"   # installs ruff, pytest, pytest-cov, pre-commit
+ruff check .              # lint
+ruff format .             # format
+pytest                    # run tests
+pytest -m "not integration"   # skip solver-dependent tests
+```
+
+Analysis and example scripts are in `scripts/`. See `scripts/README.md`
+for an overview of what each example demonstrates.
+
+---
+
+## Authors
+
+- Steffen Kortmann — IAEW, RWTH Aachen University
+- Andreas Bong — IAEW, RWTH Aachen University
+- Simon Braun — IAEW, RWTH Aachen University
+- Alexander Och — IAEW, RWTH Aachen University
+- Farah Nasr — IAEW, RWTH Aachen University
+- Philip Kvesic — IAEW, RWTH Aachen University
+- Nina Stumberger — IAEW, RWTH Aachen University
+
+---
+
+## Citation
+
+If you use `potpourri` in your research, please cite it using the metadata in
+[`CITATION.cff`](CITATION.cff). A BibTeX entry will be available once a
+Zenodo DOI is registered for the release.
+
+---
+
+## License
+
+`potpourri` is released under the [MIT License](LICENSE).

opf_potpourri-0.2.0/README.md

@@ -0,0 +1,204 @@
+# potpourri
+
+**Multi-Period Optimal Power Flow for Distribution Grids with Storage Application**
+
+> *Potpourri — piece of music composed from various popular smaller works or melodies*
+
+[![CI](https://github.com/RWTH-IAEW/opf-potpourri/actions/workflows/ci.yml/badge.svg)](https://github.com/RWTH-IAEW/opf-potpourri/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/opf-potpourri/badge/?version=latest)](https://opf-potpourri.readthedocs.io/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+`potpourri` is a Python library for AC/DC Optimal Power Flow (OPF) in distribution grids, with support for multi-period planning and flexible resources (batteries, EVs, heat pumps, PV, wind). It wraps [Pyomo](https://pyomo.readthedocs.io/) for optimisation modelling over [pandapower](https://pandapower.readthedocs.io/) network objects.
+
+**Repository:** <https://github.com/RWTH-IAEW/opf-potpourri>
+
+---
+
+## Documentation
+
+The project documentation is built with [MkDocs](https://www.mkdocs.org/).
+
+To serve the documentation locally:
+
+```bash
+pip install -e .[docs]
+mkdocs serve          # usually available at http://127.0.0.1:8000/
+```
+
+---
+
+## Installation
+
+Requires Python 3.9–3.12 and Conda (or Mamba).
+
+```bash
+conda env create -f environment.yaml
+conda activate potpourri_env
+pip install -e .
+```
+
+To update an existing environment:
+
+```bash
+conda env update -f environment.yaml --prune
+```
+
+A Dockerfile is provided for a fully containerised setup with IPOPT 3.14.16
+compiled from source, CBC, and SHOT solvers.
+
+---
+
+## Quick start
+
+### Single-period AC OPF
+
+```python
+import simbench as sb
+from potpourri.models.ACOPF_base import ACOPF
+
+net = sb.get_simbench_net("1-LV-rural1--0-sw")
+opf = ACOPF(net)
+opf.add_OPF()
+opf.add_voltage_deviation_objective()
+opf.solve(solver="ipopt", print_solver_output=False)
+
+# results available in net.res_bus, net.res_line, net.res_sgen, ...
+print(opf.net.res_bus[["vm_pu", "va_degree"]])
+```
+
+### Multi-period AC OPF with battery storage
+
+```python
+import simbench as sb
+from potpourri.models_multi_period.ACOPF_multi_period import ACOPF_multi_period
+from potpourri.technologies.battery import Battery_multi_period
+
+net = sb.get_simbench_net("1-LV-urban6--0-sw")
+opf = ACOPF_multi_period(net, toT=96, fromT=0)   # 96 × 15 min = 1 day
+
+battery = Battery_multi_period(opf.net, T=96, scenario=1)
+battery.get_all(opf.model)
+
+opf.add_OPF()
+opf.add_voltage_deviation_objective()
+opf.solve(solver="ipopt")
+```
+
+See `scripts/` for runnable examples covering each feature area.
+
+---
+
+## Architecture
+
+### Single-period models (`src/potpourri/models/`)
+
+```
+Basemodel     creates ConcreteModel, maps pandapower → Pyomo sets/params, solve()
+  ├── AC      full AC power flow (KCL/KVL, voltage magnitudes, reactive power)
+  ├── DC      linearised DC power flow (no reactive power)
+  └── OPF     operational constraints (P/Q limits, line loading, voltage bounds)
+
+ACOPF    = AC + OPF   (multiple inheritance)
+DCOPF    = DC + OPF
+HC_ACOPF = ACOPF + binary variables for hosting-capacity analysis
+```
+
+### Multi-period models (`src/potpourri/models_multi_period/`)
+
+```
+Basemodel_multi_period    adds time index T, integrates SimBench profiles
+  └── ACOPF_multi_period  (AC_multi_period + OPF_multi_period)
+
+Flexibility_multi_period  abstract base for all flexible devices
+  ├── Battery_multi_period
+  ├── HeatPump_multi_period
+  ├── PV_multi_period
+  ├── Windpower_multi_period
+  ├── Demand_multi_period
+  ├── Sgens_multi_period
+  └── Generator_multi_period
+```
+
+Flexible devices are **composed, not inherited** — each is instantiated
+separately and attaches its own Pyomo Sets/Params/Vars/Constraints to the
+parent model.
+
+### Data flow
+
+```
+pandapower net
+  → Basemodel.__init__()    pp.runpp(), extract admittance data
+  → create_model()          Pyomo ConcreteModel + sets/params/vars
+  → add_OPF()               unfix controllable vars, add limits/objectives
+  → .solve(solver)          SolverFactory → NLP/MIP
+  → pyo_to_net()            write solution back to net.res_*
+```
+
+---
+
+## External dependencies
+
+| Package | Role |
+|---|---|
+| `pandapower >= 2.13` | Network data model, initial power flow |
+| `pyomo >= 6.7` | Optimisation modelling |
+| `simbench >= 1.4` | Benchmark networks and time-series profiles |
+| `numpy`, `pandas` | Numerical / data processing |
+| `matplotlib` | Plotting |
+
+### Solvers
+
+`potpourri` does not bundle any solvers. Install at least one before
+calling `solve()`.
+
+| Solver | Type | Install |
+|---|---|---|
+| **IPOPT** | NLP — AC OPF | `conda install -c conda-forge ipopt` |
+| **GLPK** | LP / MIP — DC OPF | `conda install -c conda-forge glpk` |
+| **CBC** | LP / MIP | `conda install -c conda-forge coincbc` |
+| **Gurobi** | LP / MIP / NLP | `pip install gurobipy` (licence required) |
+| **NEOS** | Remote (free) | `opf.solve(solver='neos', neos_opt='ipopt')` |
+
+IPOPT and GLPK are included automatically when you create the environment
+from `environment.yaml`.
+
+---
+
+## Development
+
+```bash
+pip install -e ".[dev]"   # installs ruff, pytest, pytest-cov, pre-commit
+ruff check .              # lint
+ruff format .             # format
+pytest                    # run tests
+pytest -m "not integration"   # skip solver-dependent tests
+```
+
+Analysis and example scripts are in `scripts/`. See `scripts/README.md`
+for an overview of what each example demonstrates.
+
+---
+
+## Authors
+
+- Steffen Kortmann — IAEW, RWTH Aachen University
+- Andreas Bong — IAEW, RWTH Aachen University
+- Simon Braun — IAEW, RWTH Aachen University
+- Alexander Och — IAEW, RWTH Aachen University
+- Farah Nasr — IAEW, RWTH Aachen University
+- Philip Kvesic — IAEW, RWTH Aachen University
+- Nina Stumberger — IAEW, RWTH Aachen University
+
+---
+
+## Citation
+
+If you use `potpourri` in your research, please cite it using the metadata in
+[`CITATION.cff`](CITATION.cff). A BibTeX entry will be available once a
+Zenodo DOI is registered for the release.
+
+---
+
+## License
+
+`potpourri` is released under the [MIT License](LICENSE).

opf_potpourri-0.2.0/pyproject.toml

@@ -0,0 +1,111 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "opf-potpourri"
+version = "0.2.0"
+description = "Multi-period Optimal Power Flow for distribution grids with storage — Pyomo models over pandapower networks"
+readme = "README.md"
+requires-python = ">=3.9,<3.13"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Steffen Kortmann", email = "s.kortmann@iaew.rwth-aachen.de" },
+    { name = "Andreas Bong",     email = "a.bong@iaew.rwth-aachen.de" },
+    { name = "Simon Braun",      email = "s.braun@iaew.rwth-aachen.de" },
+    { name = "Alexander Och",    email = "a.och@iaew.rwth-aachen.de" },
+    { name = "Farah Nasr",       email = "f.nasr@iaew.rwth-aachen.de" },
+    { name = "Philip Kvesic",    email = "p.kvesic@iaew.rwth-aachen.de" },
+    { name = "Nina Stumberger",  email = "n.stumberger@iaew.rwth-aachen.de" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Intended Audience :: Science/Research",
+]
+keywords = [
+    "power systems",
+    "pandapower",
+    "optimal power flow",
+    "pyomo",
+    "distribution grid",
+    "multi-period",
+    "OPF",
+]
+dependencies = [
+    "loguru>=0.7",
+    "matplotlib>=3.7",
+    "numpy>=1.24",
+    "openpyxl>=3.1",
+    "pandapower>=2.13",
+    "pandas>=2.0",
+    "pyomo>=6.7",
+    "simbench>=1.4",
+]
+
+[project.optional-dependencies]
+gurobi = [
+    "gurobipy>=10.0",
+]
+notebooks = [
+    "jupyterlab>=4.0",
+    "notebook>=7.0",
+]
+docs = [
+    "mkdocs>=1.5",
+    "mkdocs-material>=9.0",
+]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.4",
+    "pre-commit>=4.0",
+]
+performance-test = [
+    "perfplot>=0.10.2",
+]
+
+[project.urls]
+Homepage      = "https://github.com/RWTH-IAEW/opf-potpourri"
+Repository    = "https://github.com/RWTH-IAEW/opf-potpourri"
+Documentation = "https://opf-potpourri.readthedocs.io/"
+"Bug Tracker" = "https://github.com/RWTH-IAEW/opf-potpourri/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"potpourri" = ["data/*.pkl", "data/*.xlsx"]
+
+[tool.ruff]
+line-length = 79
+
+[tool.ruff.lint]
+extend-select = ["E501"]
+# F403/F405: `from pyomo.environ import *` is standard Pyomo convention.
+# E741: single-letter `l` is the standard line-index variable in power systems math.
+ignore = ["E741", "F403", "F405"]
+
+[tool.ruff.lint.per-file-ignores]
+# Tutorial notebooks converted to percent-format scripts; imports appear mid-file.
+"tutorials/*.py"   = ["E402", "E501"]
+"tutorials/*.ipynb" = ["E501"]
+"scripts/*.py"     = ["E501"]
+"tests/**/*.py"    = ["E501"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = [
+    "slow: marks tests as slow (deselect with -m 'not slow')",
+    "integration: marks tests that require a remote solver or network access",
+]

opf_potpourri-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+