Grid2Op

[](https://raw.githubusercontent.com/rte-france/Grid2Op/master/ https://discord.gg/cYsYrPT)

Grid2Op是一个以模块化为设计理念的平台，用于执行电网操作。 这就是它名称的含义：Grid To Operate（电网操作）。 Grid2Op作为pypownet的替代品， 是用于学习运行电网L2RPN的库。

该框架允许执行大多数类型的电网操作，从修改发电机的设定点， 到负荷切断、执行维护操作或修改电网的拓扑结构以解决安全问题。

官方文档：官方文档可在以下网址获取 https://grid2op.readthedocs.io/。

• 1 安装
  • 1.1 设置虚拟环境（可选）
  • 1.2 从源代码安装
  • 1.3 从PyPI安装
  • 1.4 为贡献者安装
  • 1.5 Docker
• 2 Grid2Op的主要特性
• 3 入门指南
  • [0 基本功能](https://github.com/rte-france/Grid2Op/blob/master/getting_started/0_basic_functionalities.ipynb
  • [1 基于观察的代理](https://github.com/rte-france/Grid2Op/blob/master/getting_started/1_Observation_Agents.ipynb
  • [2 基本动作电网操作](https://github.com/rte-france/Grid2Op/blob/master/getting_started/2_Action_GridManipulation.ipynb
  • [3 训练代理](https://github.com/rte-france/Grid2Op/blob/master/getting_started/3_TrainingAnAgent.ipynb
  • [4 研究你的代理](https://github.com/rte-france/Grid2Op/blob/master/getting_started/4_StudyYourAgent.ipynb
• 4 引用
• 5 文档
• 6 贡献
• 7 测试和已知问题
• 8 许可证信息

安装

要求

• Python >= 3.6

设置虚拟环境（可选）

创建虚拟环境

cd my-project-folder
pip3 install -U virtualenv
python3 -m virtualenv venv_grid2op

进入虚拟环境

source venv_grid2op/bin/activate

从PyPI安装

pip3 install grid2op

从源代码安装

git clone https://github.com/rte-france/Grid2Op.git
cd Grid2Op
pip3 install -U .
cd ..

为贡献者安装

git clone https://github.com/rte-france/Grid2Op.git
cd Grid2Op
pip3 install -e .
pip3 install -e .[optional]
pip3 install -e .[docs]

Docker

Grid2Op的Docker容器可在dockerhub上获取。

要在本地安装最新的Grid2Op容器，请使用以下命令：

docker pull bdonnot/grid2op:latest

Grid2Op的主要特性

核心功能

Grid2Op是一个以模块化为设计理念的库，用于"学习运行电网"L2RPN 竞赛系列。它还可以

其主要特性包括：

• 模拟任何规模和格式的电网行为（前提是正确实现了后端）
• 允许电网修改（有功和无功负荷值、发电机电压设定点、有功发电量，最重要的是电网拓扑结构，包括输电线路的连接/断开）
• 允许维护操作和电网拓扑结构变更
• 可以采用任何电网建模方法，特别是交流（AC）和直流（DC）近似计算
• 支持更改潮流求解器、动作、观察，以更好地满足电力系统运行建模的任何需求
• 具有面向强化学习的接口，与OpenAI-gym兼容：环境类使用相同的接口
• 参数、游戏规则或动作类型完全可参数化
• 可以适应任何类型的输入数据，支持各种格式（可能需要重写一个类）

潮流求解器

Grid2Op依赖于开源潮流求解器（PandaPower）， 但也兼容其他后端。如果您有其他潮流求解器， grid2op/Backend的文档可以帮助您将其集成到适当的"后端"中， 使Grid2Op使用这个潮流求解器而不是PandaPower。

入门指南

为Grid2Op包提供了一些Jupyter笔记本作为教程。它们位于 getting_started目录中。

待办事项：这需要重做、重构和更好地解释其中的一些内容。

这些笔记本将帮助您理解如何使用这个框架，并涵盖了这个框架最有趣的部分：

• [00_介绍](https://github.com/rte-france/Grid2Op/blob/master/getting_started/00_Introduction.ipynb 和 [00_小例子](https://github.com/rte-france/Grid2Op/blob/master/getting_started/00_SmallExample.ipynb 描述了grid2op框架所处理的内容（包括对电力系统和强化学习的简要介绍），并提供了一个小型电网操作的入门示例。

• [01_Grid2op框架](https://github.com/rte-france/Grid2Op/blob/master/getting_started/01_Grid2opFramework.ipynb 涵盖了Grid2Op框架的基础知识。它还介绍了如何创建有效的环境以及如何使用Runner类快速评估代理的表现。

• [02_观察](https://github.com/rte-france/Grid2Op/blob/master/getting_started/02_Observation.ipynb 详细说明了如何创建一个"专家代理"，该代理将根据从环境获得的观察结果采取预定义的动作。本笔记本还介绍了BaseObservation类的功能。

• [03_动作](https://github.com/rte-france/Grid2Op/blob/master/getting_started/03_Action.ipynb 演示了如何使用BaseAction类以及如何操作电网。

• [04_训练代理](https://github.com/rte-france/Grid2Op/blob/master/getting_started/04_TrainingAnAgent.ipynb 展示了如何在grid2op环境中开始强化学习。它展示了如何训练一个基于"stable baselines 3"PPO实现的"PPO"模型来操作电网的基础知识。

• [05_研究你的代理](https://github.com/rte-france/Grid2Op/blob/master/getting_started/05_StudyYourAgent.ipynb 展示了如何研究BaseAgent，例如重新加载已保存实验的方法，或根据观察结果绘制电网图等。这是一个入门笔记本。更加用户友好的图形界面将很快推出。

• [06_重新调度与削减](https://github.com/rte-france/Grid2Op/blob/master/getting_started/06_Redispatching_Curtailment.ipynb 解释了从负责保障电网安全的公司（即输电系统运营商）的角度来看，什么是"重新调度"和削减，以及如何在grid2op中操作这个概念。重新调度（和削减）允许你在电网问题上执行连续动作。

• [07_多环境](https://github.com/rte-france/Grid2Op/blob/master/getting_started/07_MultiEnv.ipynb 详细说明了grid2op如何原生支持单个代理同时与多个环境交互。这对于强化学习社区中训练"异步"代理特别有用。

• [08_绘图功能](https://github.com/rte-france/Grid2Op/blob/master/getting_started/08_PlottingCapabilities.ipynb 向你展示了可以用不同方式（视觉上）表示代理交互的电网。与许多开放式AI gym环境一样，这里提供了一个渲染器。但你也可以对代理进行后处理并制作视频，我们还开发了一个名为"grid2viz"的图形用户界面（GUI），可以在不同场景下深入研究代理的行为，甚至与基准进行比较。

• [09_环境修改](https://github.com/rte-france/Grid2Op/blob/master/getting_started/09_EnvironmentModifications.ipynb 详细介绍了维护、危险和攻击。这三者都代表可能使某些输电线断开的外部事件。本笔记本介绍了如何发现此类事件的发生，以及在维护或攻击结束后可以采取哪些措施。

• [10_储能单元](https://github.com/rte-france/Grid2Op/blob/master/getting_started/10_StorageUnits.ipynb 详细说明了储能单元的使用和行为 在Grid2Op中。

• [11_与现有强化学习框架的集成](https://github.com/rte-france/Grid2Op/blob/master/getting_started/11_IntegrationWithExistingRLFrameworks.ipynb 解释了如何将Grid2Op与其他强化学习框架一起使用。待办事项：这部分需要重新编写 借助mybinder的帮助,无需安装任何东西即可在您自己的浏览器中尝试使用:

或者借助Google Colab(所有链接都提供在笔记本描述附近)

引用

如果您在工作中使用了这个包,请引用:

@misc{grid2op,
    author = {B. Donnot},
    title = {{Grid2op- A testbed platform to model sequential decision making in power systems. }},
    year = {2020},
    publisher = {GitHub},
    journal = {GitHub repository},
    howpublished = {\url{https://GitHub.com/rte-france/grid2op}},
}

文档

官方文档可在https://grid2op.readthedocs.io/获取。

在本地构建文档

如果项目是从源代码安装的,可以构建文档的副本: 您需要Sphinx(一个文档构建工具)和一个漂亮的自定义类似于readthedocs.io的Sphinx主题。可以通过以下方式安装:

pip3 install -U grid2op[docs]

这将安装Sphinx包和自定义模板。

然后,在可以使用make的系统上(主要是gnu-linux和macos),可以使用以下命令构建文档:

make html

对于Windows或无法使用make的系统,可以使用以下命令:

sphinx-build -b html docs documentation

这将创建一个"documentation"子目录,文档的主入口点将位于index.html。

建议为方便起见在本地构建此文档。 例如,"入门"笔记本引用了帮助的一些页面。

<!-- sphinx-build -b html docs documentation-->

贡献

我们欢迎每个人的贡献。对于较小的更改,可以采取拉取请求的形式。 如果是重大更改(或者如果您对什么是"小更改"有疑问),请先开一个issue讨论您想要更改的内容。

要为此代码做出贡献,您需要:

1. 在https://github.com/rte-france/Grid2Op上fork存储库
2. 将您的fork与"grid2op的最新开发分支"同步。例如,如果pypi上最新的grid2op版本是1.6.5,您需要将您的存储库与名为dev_1.6.6或dev_1.7.0的分支同步(如果dev_1.6.6分支不存在)。它将是grid2op官方github存储库中dev_*分支中的最高数字。
3. 实现您的功能/编写您的修改或其他任何内容
4. 如果适用,请确保添加测试和文档
5. 开发完成后,再次将您的存储库与最新开发分支同步(参见上面的第2点),并确保解决任何可能的冲突
6. 编写拉取请求,并确保针对正确的分支(即"最新开发分支")

贡献中的代码应通过所有测试,对新功能有专门的测试(如果适用),并有文档(如果适用)。

在实现任何主要功能之前,请先创建一个github issue。

测试和已知问题

目前执行的测试

Grid2op目前在Windows、Linux和macOS上进行测试。

单元测试包括在Linux机器上测试grid2op与以下版本的正确集成:

• python 3.8
• python 3.9
• python 3.10
• python 3.11
• python 3.12

在所有这些情况下,我们测试了grid2op在所有可用的numpy版本 >= 1.20上的表现(注意可用的numpy版本取决于python版本)。

完整的测试套件在Linux上使用python 3.10的最新numpy版本运行。

已知问题

由于Windows上Python版本中"multiprocessing"包的基本行为,grid2op的"Runner"的"multiprocessing"在Windows上不受支持。这在未来可能会改变,但目前不在我们的优先考虑范围内。

一个已知可行的快速修复方法是在使用grid2op.make(..., experimental_read_from_local_dir=True)创建环境时设置experimental_read_from_local_dir(有关更多信息,请参阅文档)

有时,在某些配置(Python版本)下,我们不建议将grid2op与pandas>=2.2一起使用。如果遇到任何问题,请降级到pandas<2.2。这种行为在我们的持续集成环境中出现在python >=3.9上,但无法在本地复现。

在本地执行测试

假设Grid2Op是从源代码安装的:

安装额外的依赖项

pip3 install -U grid2op[optional]

启动测试

cd grid2op/tests
python3 -m unittest discover

许可信息

版权所有 2019-2020 RTE France RTE: http://www.rte-france.com

此源代码受Mozilla公共许可证(MPL)v2的条款约束,也可在此处获得