用于python的buildsim云api库
BuildSimHubA的Python项目详细描述
此库允许您通过python快速方便地使用buildsimhub web api v1。
此库表示buildsimhub上云模拟功能的开始。我们希望这个库是社区驱动的，并由buildsimhub领导。我们需要你的帮助来实现这个目标。为了帮助，确保我们正在按照正确的顺序构建正确的东西，我们要求您创建一个或多个简单的注释或注释。 感谢您的持续支持，谢谢！
有关更多信息、示例和教程，请查看我们的wiki page。
目录
- EplusGIT model management system - compare, merge and copy - can be accessed through API
- Regional project and global project. - the newly added global project allows user upload custom weather files for simulation / parametrics.
- Design day condition - automatically update design day conditions.
Previous update:
Version 1.5.5:
- Package and distribution on PYPI
- New monte carlo算法是在参数研究中实现的。
- 在单一模型中修改能效测量和参数的新方法。
1.5.0版：
- api库现在支持模型下载。看看这个script
- 模型上载支持自定义（.csv）计划。看看这个script
- 支持从单个模型中每小时提取数据。script
- 支持从HTML中提取单个表。script
- 使用API打开三维几何图形查看器。script
- 区域加载/加载组件提取。script
- 添加后处理功能-将数据转换为pandas数据框，并利用plotly进行绘图。
Installation
Prerequisites
- The BuildSimHub service, starting at the free level
- Python3.5或3.6版，Python2.7正在测试中。
- 如果希望使用内置的绘图功能，则需要最新的plotly python包。安装指令可以在here 中找到
安装软件包
pip install BuildSimHubAPI
设置环境
除了安装python之外，普通用户不需要访问buildsim云。 但是，对于希望集成buildsim云的软件供应商，可以修改info.config文件中的供应商密钥。
编辑info.configvendor_id:[Your name]
如果您决定使用buildsim cloud，请将您的特定供应商ID发送给我们：weili.xu@buildsimhub.net。
项目密钥（必需）
要通过API客户端激活模拟，您需要提供一个项目密钥—一个帮助BuildSim将本地应用程序连接到项目的密钥。 项目密钥可以在两个位置找到。
- 项目列表页：只需单击“复制键”按钮并将其粘贴到应用程序中。
- 在“每个模型”下的“项目”选项卡中：在“每个模型”下，在“项目”选项卡中搜索“项目API键”字段。
'''Example of how to innitialize API client'''project_api_key='abcdef-ghijkl-mnopqrst'bsh=buildsimhub.BuildSimHubAPIClient()new_sj=bsh.new_simulation_job(project_api_key)
型号键（可选）
api库中的某些函数要求您提供model_api_key。这些函数允许您更新模型的历史记录或从指定项目下的模型检索仿真结果。在每个模型中都可以找到model_api_key（在下图中突出显示）。
Quick Start
Hello BuildSim
^{pr 3}$The ^{run()方法可以启动云模拟。返回的对象是model object，它包含一组完整的模拟结果。
参数化模拟快速入门
importBuildSimHubAPIasbsh_apiproject_api_key='8d0aa6f4-50c3-4471-84e6-9bd4877ed19a'file_dir="/Users/weilixu/Desktop/data/UnitTest/5ZoneAirCooled.idf"bsh=bsh_api.BuildSimHubAPIClient()new_pj=bsh.new_parametric_job(project_api_key)# Define EEMs measure_list=list()wwr=bsh_api.measures.WindowWallRatio()wwr.set_min(0.3)wwr.set_max(0.6)measure_list.append(wwr)lpd=bsh_api.measures.LightLPD('ip')lpd.set_min(0.6)lpd.set_max(1.2)measure_list.append(lpd)heatEff=bsh_api.measures.HeatingEfficiency()heatEff.set_min(0.8)heatEff.set_max(0.95)measure_list.append(heatEff)# Add EEMs to parametric job new_pj.add_model_measures(measure_list)# Start! parametric=new_pj.submit_parametric_study_local(file_dir,algorithm='montecarlo',size=10,track=True)print(parametric.net_site_eui())
参数化工作流需要用户指定的节能措施。度量值的完整列表可以在BuildSimHub wiki中找到。
路线图
- 我们正在研究一种标准的eems，它允许用户对任何idf模型应用通用的能效措施。如果在标准eem库中没有看到任何所需的eem，请打开一个问题！
- 以后会增加更多的模拟配置和输出结果返回！
- buildsim plot：这是一个新项目，我们正在将plotly包与我们的标准api库集成，以提供可视化的能力。
- buildsim learn：这是一个新项目我们正在努力将scikit-learn集成到当前工作流中，以增强参数化工作流。
- 如果您对这个项目的未来方向感兴趣，请看一下我们的开放式issues和pull requests。我们很想听听你的反馈。
About
buildsimhub-python is guided and supported by the BuildSimHub Developer Experience Team。
buildsimhub python由buildsimhub，inc.维护和资助。buildsimhub python的名称和徽标是buildsimhub，inc.的商标。
License
欢迎加入QQ群-->： 979659372
