Python包来处理Energyplus输入和输出
opyplus的Python项目详细描述
opyplus公司
opyplus是一个允许在Python中使用EnergyPlus的包。在
更具体地说,它允许:
- 高效地解析、查询和修改idf文件,并进行多项检查以确保idf文件保持正确 在你的工作中
- 解析并创建epw文件
- 在EnergyPlus上进行发射模拟
- 分析EnergyPlus输出文件
安装
要安装opyplus,请运行:pip install opyplus
或conda install -c conda-forge opyplus
文件
文档可在https://opyplus.readthedocs.io
兼容性
Python版本
opyplus设计用于python3.6及更新版本。在
它目前是针对以下python版本自动测试的:
- 3.6条
- 3.7款
EnergyPlus版本
opyplus设计用于任何EnergyPlus版本。 目前,它会自动针对以下版本进行测试(列在测试的\u EPLUS_版本中:oplus.tests.util)公司名称:
- 9.0.1条
因此,每个测试都要运行多次:每个测试版本一次。要在所有版本上自动运行测试,请使用 eplus_测试仪功能(oplus.tests.util). 在
操作系统
opyplus设计用于任何操作系统。它会自动针对最新版本的 以下操作系统:
- 乌班图
- 马科斯
- 微软Windows
贡献
本地测试
安装pytest和中列出的包要求.txt使用pip或conda。在
安装EnergyPlus v9.0.1。在
在存储库的根目录下,运行pytest:python -m pytest
。在
薄片8
我们使用flake8来执行样式,包括docstring。在
要运行它,请使用pip或conda安装flake8和flake8 docstrings。在
在存储库的根目录下,运行flake8:python -m flake8 opyplus/
文档
要构建配置:
在文档中安装需求/要求.txt在
在opyplus docs目录中运行make html
。在
为了确保文档中的示例保持最新,使用doctest扩展名对它们进行测试: https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html
在opyplus docs目录中运行make doctest
来测试文档。在
在向文档中添加代码示例时,请尽可能使用doctest扩展,因为它有助于确保
样本将保持最新:使用.. testcode::
和{
发布工作流
- 开发者XX在他的分支上工作(XX-…)。 完成后,他完成了发布.md不写版本号(他在“下一步”下完成)。 然后他在master中创建一个pull请求。在
- 一旦拉请求被管理员接受(测试必须通过等等),分支将在主节点上合并。在
- 当管理员想要创建一个版本时,他完成了发布.md版本号设置版本.py,提交并创建一个标记(vX.X.X)。 然后他推。测试应该成功,因为所有拉请求测试都已成功。 然后,Azure管道将自动执行conda和pip构建。在
- 项目
标签: