跳到主要内容

IESLab 类

Class: IESLabSimulation​

CloudPSS IESLabSimulation 基类

ieslabSimulation.id​

算例 id

ieslabSimulation.name​

算例名称

ieslabSimulation.project_group​

算例分组信息

ieslabSimulation.model​

算例拓扑信息

ieslabSimulation.dataManageModel​

算例的数据管理模块数据

IESLabSimulation.fetch(id)​

获取算例信息

IESLabSimulation.fetch(id)

IESLabSimulation.createProjectGroup(group_name, desc=None, createById=None)​

  • 静态方法
  • group_name: String 项目组名称
  • desc: String 项目组描述
  • createById: String 父项目组 id 可选参数，如果是从已有项目组导入的项目组，必填此项
  • Returns: Number 返回创建的项目组 id

创建项目组。

IESLabSimulation.createProjectGroup('test')

IESLabSimulation.createProject(name, project_group, desc=None, createById=None)​

  • 静态方法
  • name: String 项目名称
  • project_group: Number 父项目组 id
  • desc: String 项目描述
  • createById: Number 父项目 id, 可选参数, 如果是从已有项目导入的项目，必填此项
  • Returns: Number 返回创建的项目 id

创建项目。

IESLabSimulation.createProject('project', project_group=None, desc=None, createById=None)

ieslabSimulation.run(job, name=None)​

  • 实例方法
  • job: String 调用仿真时使用的计算方案
  • name: String 仿真任务名称，为空时使用项目的参数方案名称和计算方案名称
  • Returns: Job 返回一个仿真任务
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.run(job, name=None)

Class: IESLabPlan​

CloudPSS IESLabPlan 基类

ieslabPlan.id​

算例id。

ieslabPlan.name​

算例名称。

ieslabPlan.project_group​

算例分组信息。

ieslabPlan.model​

算例拓扑信息。

ieslabPlan.dataManageModel​

算例的数据管理模块数据。

ieslabPlan.planModel​

方案优选模块。

ieslabPlan.evaluationModel​

方案评估模块。

ieslabPlan.currentPlanResult​

方案优选结果数据。

ieslabPlan.currentEvaluationResult​

方案评估结果数据。

IESLabPlan.fetch(id)​

获取算例信息。

IESLabPlan.fetch(id)

IESLabPlan.createProjectGroup(group_name, desc=None, createById=None)​

  • 静态方法
  • group_name: String 项目组名称
  • desc: String 项目组描述
  • createById: Number 父项目组id 可选参数，如果是从已有项目组导入的项目组，必填此项
  • Returns: Number 返回创建的项目组 id

创建项目组。

IESLabPlan.createProjectGroup(group_name, desc=None, createById=None)

IESLabPlan.createProject(name, project_group, start_date, end_date, construction_cycle, desc=None, createById=None)​

  • 静态方法
  • name: String 项目名称
  • project_group: Number 项目组 id
  • start_date: Number 项目开始年限，范围在[1500,3000]之间
  • end_date: Number 项目结束年限，范围在项目开始时间之后且不超过五十年
  • construction_cycle: Number 项目建设周期(年), 必须小于等于 项目结束年限 - 项目开始年限
  • desc: String 项目描述
  • createById: 父项目 id, 可选参数, 如果是从已有项目导入的项目，必填此项
  • Returns: Number 返回创建的项目 id

创建项目。

IESLabPlan.createProject(name, project_group, start_date, construction_cycle, desc=None, createById=None)

ieslabPlan.iesLabTypicalDayRun(job=None, name=None, **kwargs)​

  • 实例方法
  • job: Dict 调用仿真时使用的计算方案，不指定将使用算例保存时选中的计算方案
  • name: String 任务名称，为空时使用项目的参数方案名称和计算方案名称
  • Returns: Job 返回一个运行实例

运行典型日计算。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.iesLabTypicalDayRun(job=None, name=None, **kwargs)

ieslabPlan.iesLabEvaluationRun(planId, type=None)​

  • 实例方法
  • planId: Number 方案 id，表示优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • type: String 评估类型，可选值为：能效评价、环保评价
  • Returns: Runner 返回方案评估运行实例

运行方案评估。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.iesLabEvaluationRun(planId, type=None)

ieslabPlan.iesLabEnergyEvaluationRun(planId)​

  • 实例方法
  • planId: Number 方案 id
  • Returns: Runner 返回能效评价运行实例

运行能效评价。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.iesLabEnergyEvaluationRun(planId)

ieslabPlan.iesLabPlanRun()​

  • 实例方法
  • Returns: Runner 返回方案优选运行实例

运行方案优选。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.iesLabPlanRun()

ieslabPlan.iesLabPlanKill()​

  • 实例方法

停止并删除方案优选算例。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.iesLabPlanKill()

Class: DataManageModel​

CloudPSS IESLab 数据管理模块类

datamanageModel.GetDataItem(ID)​

  • 实例方法
  • ID: String 数据项的标识符，可以在所有类型的数据项中实现唯一标识
  • Returns: Dict 返回该数据项的信息（源数据的引用）

获取 ID 对应的数据信息。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.GetDataItem(ID)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.GetDataItem(ID)

datamanageModel.GetItemList(dataType)​

  • 实例方法
  • dataType: Enum 数据的种类标识，包含：
    • 光伏: "PhotovoltaicSys"
    • 风机: "WindPowerGenerator"
    • 燃气轮机: "GasTurbine"
    • 热泵: "HeatPump"
    • 燃气锅炉: "GasBoiler"
    • 热管式太阳能集热器: "HPSolarCollector"
    • 电压缩制冷机: "CompRefrg"
    • 吸收式制冷机: "AbsorptionChiller"
    • 蓄电池: "Battery"
    • 储水罐: "WaterTank"
    • 变压器: "Transformer"
    • 传输线: "TransferLine"
    • 模块化多电平变流器: "MMC"
    • 离心泵: "CentrifugalPump"
    • 管道: "Pipe"
    • 采暖制冷负荷: "thermalLoads"
    • 电负荷: "electricLoads"
    • 燃料: "fuels"
    • 热: "HVACHeating"
    • 冷: "HVACCooling"
    • 常数电价: "常数电价"
    • 分时电价: "分时电价"
    • 阶梯电价: "阶梯电价"
    • 分时阶梯电价: "分时阶梯电价"
  • Returns: List 返回该种类下所有数据项的列表

获取 dataType 类型对应所有数据项的列表。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.GetItemList(dataType)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.GetItemList(dataType)

datamanageModel.AddDataItem(dataType, data)​

  • 实例方法
  • dataType: Enum 数据的种类标识，包含：
    • 光伏: "PhotovoltaicSys"
    • 风机: "WindPowerGenerator"
    • 燃气轮机: "GasTurbine"
    • 热泵: "HeatPump"
    • 燃气锅炉: "GasBoiler"
    • 热管式太阳能集热器: "HPSolarCollector"
    • 电压缩制冷机: "CompRefrg"
    • 吸收式制冷机: "AbsorptionChiller"
    • 蓄电池: "Battery"
    • 储水罐: "WaterTank"
    • 变压器: "Transformer"
    • 传输线: "TransferLine"
    • 模块化多电平变流器: "MMC"
    • 离心泵: "CentrifugalPump"
    • 管道: "Pipe"
    • 采暖制冷负荷: "thermalLoads"
    • 电负荷: "electricLoads"
    • 燃料: "fuels"
    • 热: "HVACHeating"
    • 冷: "HVACCooling"
    • 常数电价: "常数电价"
    • 分时电价: "分时电价"
    • 阶梯电价: "阶梯电价"
    • 分时阶梯电价: "分时阶梯电价"
  • data: Dict 添加的数据内容，其数据结构应满足对应数据项的结构要求
  • Returns: 返回新添加数据项的 ID，如果数据结构不满足要求，抛出异常

向 dataType 类型的数据库中添加内容为 data 的数据项。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.AddDataItem(dataType, data)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.AddDataItem(dataType, data)

datamanageModel.UpdateDataItem(ID, data)​

  • 实例方法
  • ID: String 数据项的标识符，可以在所有类型的数据项中实现唯一标识
  • data: Dict 添加的数据内容，其数据结构应满足对应数据项的结构要求
  • Returns: Boolean 返回 True，更新成功

更新数据库 ID 对应数据项。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.UpdateDataItem(ID, data)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.UpdateDataItem(ID, data)

datamanageModel.DeleteDataItem(ID)​

  • 实例方法
  • ID: String 数据项的标识符，可以在所有类型的数据项中实现唯一标识
  • Returns: Boolean 删除是否成功标志，如果ID错误，抛出异常

删除 ID 对应的数据。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.DeleteDataItem(ID)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.DeleteDataItem(ID)

datamanageModel.SetProjectPosition(longitude, latitude)​

  • 实例方法
  • longitude: Float 经度，范围为气象数据源的经度范围
  • latitude: Float 纬度，范围为气象数据源的纬度范围

设置项目的天气数据坐标，加载天气数据。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.SetProjectPosition(longitude, latitude)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.SetProjectPosition(longitude, latitude)

datamanageModel.GetAtmosData(startDate, endDate)​

  • 实例方法
  • startDate: String 开始时间，格式为'YYYY-MM-DD'
  • endDate: String 结束时间，格式为'YYYY-MM-DD'
  • Returns: List 返回当前项目位置对应时间范围内的气象数据序列，每个元素用字典进行表示，字典的 key 即区分不同的气象数据项（如风速、太阳辐照等）以及标识当前时间点

获取在 startDate 到 endDate 之间的气象数据。

# IESLabSimulation
ieslabSimulation = IESLabSimulation.fetch(id)
ieslabSimulation.datamanageModel.GetAtmosData(startDate, endDate)

# IESLabPlan
ieslabPlan = IESLabPlan.fetch(id)
ieslabPlan.datamanageModel.GetAtmosData(startDate, endDate)

Class: IESLabPlanModel​

CloudPSS IESLabPlanModel 方案优选模块类

ieslabPlanModel.simulationId​

算例 id。

ieslabPlanModel.optimizationInfo​

当前算例的优化目标设置信息。

ieslabPlanModel.SetOptimizationInfo(optType)​

  • 实例方法
  • optType: Enum 优化目标类型，经济性优化和环保性优化类型

设置当前算例的优化目标。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanModel = ieslabPlan.planModel
ieslabPlanModel.SetOptimizationInfo(optType)

ieslabPlanModel.GetOptimizationInfo()​

  • 实例方法
  • Returns: Enum 返回优化目标

获取当前算例的优化目标设置信息。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanModel = ieslabPlan.planModel
ieslabPlanModel.GetOptimizationInfo()

ieslabPlanModel.run()​

  • 实例方法
  • Returns: Runner 生成方案优选算例，成功返回运行任务实例，如果算例已经运行过方案优选，再次运行会抛异常

运行方案优选。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanModel = ieslabPlan.planModel
ieslabPlanModel.run()

ieslabPlanModel.GetRunner()​

  • 实例方法
  • Returns: Runner 返回运行实例

获得运行实例。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanModel = ieslabPlan.planModel
ieslabPlanModel.GetRunner()

ieslabPlanModel.kill()​

  • 实例方法

停止并删除当前运行的优化算例。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanModel = ieslabPlan.planModel
ieslabPlanModel.kill()

ieslabPlanModel.GetLastTaskResult()​

  • 实例方法
  • Returns: Boolean 返回任务运行状态

获取最后一次运行的 taskID 的任务运行状态

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanModel = ieslabPlan.planModel
ieslabPlanModel.GetLastTaskResult()

Class: IESLabEvaluationModel​

CloudPSS IESLab 方案评估类

ieslabEvaluationModel.GetFinancialParams(planID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: Dict 方案对应的财务评价基础参数信息（源数据的引用）

获取 planID 对应的优化方案下财务评估模块的基础信息

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationModel = ieslabPlan.evaluationModel
ieslabEvaluationModel.GetFinancialParams(0)

ieslabEvaluationModel.run(planID, type=None)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • type: String 任务类型：环保评价/能效评价
  • Returns: Runner 返回运行任务实例

运行方案评估。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationModel = ieslabPlan.evaluationModel
ieslabEvaluationModel.run(planID, type=None)

ieslabEvaluationModel.EnvironmentalEvaluationRun(planID)​

  • 实例方法
  • planID: Number 优化方案的ID，数值位于0~优化方案数量之间
  • Returns: Runner 返回运行任务实例

运行环保评价方案评估。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationModel = ieslabPlan.evaluationModel
ieslabEvaluationModel.EnvironmentalEvaluationRun(planID)

ieslabEvaluationModel.EnergyEvaluationRun(planID)​

  • 实例方法
  • planID: Number 优化方案的ID，数值位于0~优化方案数量之间
  • Returns: Runner 返回运行任务实例

运行能效评价方案评估。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationModel = ieslabPlan.evaluationModel
ieslabEvaluationModel.EnergyEvaluationRun(planID)

ieslabEvaluationModel.GetRunner(planID)​

  • 实例方法
  • planID: Number 优化方案的ID，数值位于0~优化方案数量之间
  • Returns: Runner 返回运行任务实例

获得运行实例。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationModel = ieslabPlan.evaluationModel
ieslabEvaluationModel.GetRunner(planID)

Class: IESLabEvaluationResult​

CloudPSS IESLab 评价结果类

IESLabEvaluationResult.status()​

  • 实例方法
  • Returns: Boolean 返回运行状态

获取运行状态。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationResult = ieslabPlan.currentEvaluationResult
ieslabEvaluationResult.status()

IESLabEvaluationResult.GetFinancialResult(resultType, planID)​

  • 实例方法
  • resultType: Enum 财务评价结果表格的类型：
    • 利润与利润分配: getEconomyResult
    • 财务计划现金: getFinancialPlanCashFlowResult
    • 资产负债: getLiabilityAssetsResult
    • 投资使用计划与资金筹措 : getInvestPlanDataResult
    • 借款还本付息计划: getLoanRepaymentPlanResult
    • 流动资金估算: getFlowCashEvaluteResult
    • 资产折旧与摊销估算: getFlowCashEvaluteResult
    • 总成本费用估算表: getSumCostResult
    • 项目总投资现金流量: getSumInvestFlowCashResult
    • 项目资本金现金流量: getProjectCashFlowResult
    • 营业收入、税金、附加和增值税估算: getIncomeTaxResult
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: Dict 方案对应的财务评价基础参数信息（源数据的引用）

获取 planID 对应的优化方案下 resultType 财务评估结果。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationResult = ieslabPlan.currentEvaluationResult
ieslabEvaluationResult.GetFinancialResult(resultType, planID)

IESLabEvaluationResult.GetOverviewResult(planID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: List 返回该方案对应的概览结果

获取当前结果类对应的优化方案下的概览结果。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationResult = ieslabPlan.currentEvaluationResult
ieslabEvaluationResult.GetOverviewResult(planID)

IESLabEvaluationResult.GetEnergyEvaluationResult(planID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: List 返回该方案对应的能效评价结果

获取当前结果类对应的优化方案下的能效评价。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationResult = ieslabPlan.currentEvaluationResult
ieslabEvaluationResult.GetEnergyEvaluationResult(planID)

IESLabEvaluationResult.GetEnvironmentalEvaluationResult(planID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: List 返回该方案对应的环保评价结果

获取当前结果类对应的优化方案下的环保评价。

ieslabPlan = IESLabPlan.fetch(id)
ieslabEvaluationResult = ieslabPlan.currentEvaluationResult
ieslabEvaluationResult.GetEnvironmentalEvaluationResult(planID)

Class: IESLabPlanResult​

CloudPSS IESLab 运行结果类

ieslabPlanResult.status()​

  • 实例方法
  • Returns: Boolean 返回运行状态

获取运行状态。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.status()

ieslabPlanResult.GetLogs()​

  • 实例方法
  • Returns: Dict 返回日志信息

获取运行日志。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.GetLogs()

ieslabPlanResult.GetPlanNum()​

  • 实例方法
  • Returns: Number 返回优化方案的数量

获取当前 result 实例对应的优化方案数量。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.GetPlanNum()

ieslabPlanResult.GetPlanInfo(planID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: Dict 返回方案的基础信息，包括投资、运行成本、负荷总量等信息

获取 planID 对应的优化方案的基础信息。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.GetPlanInfo(planID)

ieslabPlanResult.GetPlanConfiguration(planID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • Returns: Dict 返回方案的配置信息，包括每种设备的选型配置、容量配置、成本等相关信息

获取 planID 对应的优化方案的配置信息。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.GetPlanConfiguration(planID)

ieslabPlanResult.GetComponentResult(planID, componentID, typicalDayName='')​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • componentID: String 元件的标识符
  • typicalDayName: String 典型日的名称
  • Returns: Dict 返回元件在不同典型日下的运行信息

获取 planID 对应的优化方案下componentID对应元件的运行信息。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.GetComponentResult(planID, componentID, typicalDayName)

ieslabPlanResult.GetComponentTypiDays(planID, componentID)​

  • 实例方法
  • planID: Number 优化方案的 ID，数值位于 0 ~ 优化方案数量之间
  • componentID: String 元件的标识符
  • Returns: Number 返回优化方案的数量

获取当前 result 实例对应的优化方案数量。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.GetComponentResult(planID, componentID, typicalDayName)

ieslabPlanResult.getLastTaskResult()​

  • 实例方法
  • Returns: Dict 返回运行结果

获取最后一次运行的 taskID 的运行结果。

ieslabPlan = IESLabPlan.fetch(id)
ieslabPlanResult = ieslabPlan.currentPlanResult
ieslabPlanResult.getLastTaskResult()