Skip to main content

PyPi | Read the Docs | Github | mail

lifecycle MIT License Test OPF-gym

General

A set of benchmark environments to solve the Optimal Power Flow (OPF) problem with reinforcement learning (RL) algorithms. It is also easily possible to create custom OPF environments. All environments use the gymnasium API. The modelling of the power systems and the calculation of power flows happens with pandapower. The benchmark power grids and time-series data of loads and generators are taken from SimBench.

Documentation can be found on https://opf-gym.readthedocs.io/en/latest/.

If you want to use the benchmark environments or the general framework to build your own environments, please cite this repository (see CITATION.cff) and/or cite the following publication, where the framework is first mentioned (in an early stage): https://doi.org/10.1016/j.egyai.2024.100410

Environments

Currently, five OPF benchmark environments are available.

  • EcoDispatch: Economic dispatch
  • VoltageControl: Voltage Control with reactive power
  • MaxRenewable: Maximize renewable feed-in
  • QMarket: Reactive power market
  • LoadShedding: Load shedding problem

Additionally, some example environments for more advanced features can be found in opfgym/examples.

Contribution

Any kind of contribution is welcome! Feel free to create issues or merge requests. Also, additional benchmark environment are highly appreciated. For example, the examples environments could be refined to difficult but solvable RL-OPF benchmarks. Here, it would be especially helpful to incorporate an OPF solver that is more capable than the very limited pandapower OPF. For example, it should be able to deal with multi-stage problems, discrete actuators like switches, and stochastic problems, which the pandapower OPF cannot. For questions, feedback, collaboration, etc., contact thomas.wolgast@uni-oldenburg.de.

Metadata

Release files for opfgym 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opfgym 1.0.1
File Size Uploaded Provenance Actions
opfgym-1.0.1.tar.gz 40.8 kB Without provenance Details for opfgym-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for opfgym 1.0.1
File Interpreter ABI Platform Actions
opfgym-1.0.1-py3-none-any.whl Python 3 none any Details for opfgym-1.0.1-py3-none-any.whl

Total release size: 88.9 kB

Release files / opfgym-1.0.1.tar.gz

Download URL opfgym-1.0.1.tar.gz
Size 40.8 kB
Tags Source
SHA-256 checksum
How to use checksums
c70fd273d24fef4269f5c09a54e63204543dd4d2d078e8deed8dd94c6f9c891d
BLAKE2b-256 checksum
How to use checksums
3a52291c8159d8dc10770d70e3ab1eda0aaff31e8c0363473b644d20e1a3dab1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / opfgym-1.0.1-py3-none-any.whl

Download URL opfgym-1.0.1-py3-none-any.whl
Size 48.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
801042f9a6aeb5357513055ccbb77eb1d505da674977b5618d2f0bff61a6dc7c
BLAKE2b-256 checksum
How to use checksums
7283c6bf8fcc7ced9feaa8073c96c9e8bc9479423a066c06f8aa0b8c28499e96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Security for opfgym 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page