cloudpss 3.2.0a2__tar.gz → 4.0.0__tar.gz

cloudpss-4.0.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: cloudpss
+Version: 4.0.0
+Summary: cloudpss sdk
+Home-page: https://www.cloudpss.net
+Author: cloudpss
+Author-email: zhangdaming@cloudpss.net
+License: MIT Licence
+Keywords: cloudpss,cloudpss-sdk
+Platform: any
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+
+CloudPSS SDK
+----------------------------------------------------------------
+CloudPSS SDK是基于CloudPSS-API封装的模型及软件开发套件。用户可通过编写Python、Matlab等脚本构建自定义模型，或是调用CloudPSS平台中的模型修改、仿真计算功能，实现诸如自动修改模型、批量仿真计算、自动化生成报告等复杂且繁琐的功能。用户也可在其自己的应用程序中调用CloudPSS仿真引擎，实现仿真驱动的高级分析应用。
+
+CloudPSS SDK包含模型层、算法层和应用层三种开发套件，其中：
+
+1. `模型层开发套件`帮助用户在CloudPSS SimStudio官方潮流计算、电磁暂态仿真、移频电磁暂态仿真、综合能源能量流计算等内核中开发第三方模型或用户自定义模型。目前，模型层SDK已开放基于Matlab函数的自定义控制元件接入，后续将进一步开放Python、C/C++的标准元件开发套件。
+2. `算法层开发套件`帮助用户在CloudPSS FuncStudio中集成自己的算法内核，从而借助CloudPSS XStudio平台快速开发并部署自己的计算应用。该部分内容将在年内发布，敬请期待。
+3. `应用层开发套件`帮助用户在利用脚本的形式快速调用CloudPSS官方计算内核和第三方接入的计算内核，从而方便用户开发高级计算分析应用。其中，SimStudio-SDK现已支持SimStudio中的模型修改和`潮流计算`和`电磁暂态仿真`两种计算内核。
+
+
+---
+### 下载与安装
+
+```[pyhton]
+pip install cloudpss
+```
+需要`升级`的话，执行下面的命令:
+```[pyhton]
+pip install --upgrade cloudpss
+```
+### 完全卸载
+
+执行下面的命令进行`完全卸载`:
+```[pyhton]
+pip uninstall cloudpss
+```
+
+          
+

{cloudpss-3.2.0a2 → cloudpss-4.0.0}/cloudpss/__init__.py

@@ -1,22 +1,23 @@
 # coding=UTF-8
+from cloudpss.ieslab import IESLabSimulation, IESLabPlan
 from .verify import setToken
 from .runner import Runner, Result, EMTResult, PowerFlowResult
 from .model import Model, ModelRevision, ModelTopology
 from .project import Project
 from .utils import MatlabDataEncoder, DateTimeEncode
 from . import function
+from .job import Job
 from .function import FunctionExecution
-
+from .version import __version__
 __all__ = [
     'setToken', 'Model', 'ModelRevision', 'ModelTopology', 'Runner', 'Result',
     'PowerFlowResult', 'EMTResult', 'MatlabDataEncoder', 'DateTimeEncode',
-    'function', 'Project', 'currentJob'
+    'function', 'Project', 'currentJob', 'IESLabSimulation', 'IESLabPlan','__version__','Job'
 ]
-__version__ = '3.2.0.alpha.2'
 
 
 def currentJob():
     """
         获取当前的 currentExecution 实例
     """
-    return FunctionExecution.current()
+    return FunctionExecution.current()

{cloudpss-3.2.0a2 → cloudpss-4.0.0}/cloudpss/function/functionExecution.py

@@ -50,8 +50,6 @@ class FunctionExecution(object):
         """
         获取表示当前执行的 FunctionExecution 单例
         """
-        if FunctionExecution._current is not None:
-            return FunctionExecution._current
         jobId = os.environ.get('CLOUDPSS_JOB_ID', None)
         functionId = os.environ.get('CLOUDPSS_FUNCTION_ID', None)
         executorId = os.environ.get('CLOUDPSS_EXECUTOR_ID', None)
@@ -165,7 +163,7 @@ class FunctionExecution(object):
         sys.exit(code)
 
     def print(self, data):
-        print(json.dumps(data, cls=MatlabDataEncoder), flush=True)
+        print(json.dumps(data, cls=MatlabDataEncoder)+'\n', flush=True)
 
     def log(self, content, level='info', html=False, key=None):
         '''

cloudpss-4.0.0/cloudpss/ieslab/DataManageModel.py

@@ -0,0 +1,415 @@
+from ..utils import request, fileLoad, graphql_request
+import json
+import time, datetime
+import copy
+
+
+class DataManageModel(object):
+    _kindUrlMap = {}
+    _kindNameMap = {}
+    _weatherUrl = ''
+    _baseUri = ''
+    _itemDataMap={}
+    _kindItemDataMap={}
+    _kindIdMap={}
+    def __init__(self, simulationId):
+        self.simulationId = simulationId
+        self._getAllData()
+    def _fetchItemData(self, url, kind):
+        '''
+            私有方法，获取kind类型对应所有数据项的列表
+
+            :params: url string类型，request请求对应的url链接
+            
+            :params: kind string类型，数据的种类标识，比如PhotovoltaicSys, WindPowerGenerator, GasTurbine等等
+            
+            :return: list类型，返回该种类下所有数据项的的列表
+        '''
+        r = request('GET',
+                    url,
+                    params={
+                        "simu_id": self.simulationId,
+                        "kind": kind
+                    })
+        str = url.split('/')[-2]
+        if(str in ['typhoon', 'rainfall', 'earthquake', 'extremeCold'] and r.status_code == 404):
+            return {}
+        else :
+            data = json.loads(r.text)
+            return data['results']
+
+    def _deleteItemData(self, url):
+        '''
+            私有方法，删除url链接对应的数据
+            
+            :params: url string类型，request请求对应的url链接
+            
+            :return: 无
+        '''
+        r = request('DELETE',
+                    url)
+        return r.text
+    def _saveItemData(self, url, data):
+        '''
+            私有方法，保存url链接对应的data数据
+            
+            :params: url string类型，request请求对应的url链接
+
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+            
+            :return: dict类型，表示成功添加的数据内容
+        '''
+        r = request('POST', url, data=json.dumps(data))
+        dataList = json.loads(r.text)
+        return dataList
+
+    def _updateItemData(self, url, data):
+        '''
+            私有方法，更新url链接对应的data数据
+            
+            :params: url string类型，request请求对应的url链接
+
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+            
+            :return: dict类型，表示成功更新的数据内容
+        '''
+        r = request('PATCH', url, data=json.dumps(data))
+        dataList = json.loads(r.text)
+        return dataList
+    
+    def _getAllData(self):
+        '''
+            私有方法，获取数据管理模块全部数据，函数初始化时调用
+            
+            :return: 无
+        '''
+        list = ['thermalLoads', 'electricLoads', 'fuels', 'typhoon', 'rainfall', 'earthquake', 'extremeCold']
+        for kind,value in self._kindUrlMap.items():
+            try:
+            
+                if kind in list:
+                    dataList = self._fetchItemData(self._kindUrlMap[kind], None)
+                else:
+                    dataList = self._fetchItemData(self._kindUrlMap[kind], kind)
+            except Exception as e:
+                pass
+            self._kindItemDataMap[kind]=dataList
+            for val in dataList:
+                self._itemDataMap[str(val['timeid'])]=val
+                self._itemDataMap[str(val['id'])]=val
+                self._kindIdMap[str(val['timeid'])]=kind
+                self._kindIdMap[str(val['id'])]=kind
+
+    def GetDataItem(self, ID: str):
+        '''
+            获取ID对应的元素信息
+            
+            :params: ID string类型，代表数据项的标识符，可以在所有类型的数据项中实现唯一标识
+            
+            :return: dict类型，为源数据的引用，返回该数据项的信息
+        '''
+        data = self._itemDataMap.get(str(ID),None)
+        
+        assert (data is not None), "找不到数据"
+
+        return copy.deepcopy(data)
+
+    def GetItemList(self, dataType):
+        '''
+            获取dataType类型对应所有数据项的列表
+    
+            :params: dataType enum类型，数据的种类标识，包含："光伏": "PhotovoltaicSys","风机": "WindPowerGenerator","燃气轮机": "GasTurbine","热泵": "HeatPump","燃气锅炉": "GasBoiler","热管式太阳能集热器": "HPSolarCollector","电压缩制冷机": "CompRefrg","吸收式制冷机": "AbsorptionChiller","蓄电池": "Battery","储水罐": "WaterTank","变压器": "Transformer","传输线": "TransferLine","模块化多电平变流器": "MMC","离心泵": "CentrifugalPump","管道": "Pipe","采暖制冷负荷": "thermalLoads","电负荷": "electricLoads","燃料": "fuels","热": "HVACHeating","冷": "HVACCooling","常数电价": "常数电价","分时电价": "分时电价","阶梯电价": "阶梯电价","分时阶梯电价": "分时阶梯电价"
+    
+            :return: list类型，返回该种类下所有数据项的列表
+        '''
+        assert (dataType in self._kindNameMap
+                or dataType in self._kindUrlMap), "数据类型不存在"
+        kind = self._kindNameMap.get(dataType, dataType)
+        return copy.deepcopy(self._kindItemDataMap[kind])
+
+    def AddDataItem(self, dataType, data):
+        '''
+            向dataType类型的数据库中添加内容为data的数据项
+    
+            :params: dataType enum类型，数据的种类标识，包含："光伏"、"风机"、"燃气轮机"、"热泵"、"燃气锅炉"、"热管式太阳能集热器"、"电压缩制冷机"、"吸收式制冷机"、"蓄电池"、"储水罐"、"变压器"、"传输线"、"模块化多电平变流器"、"离心泵"、"管道"、"采暖制冷负荷"、"电负荷"、"燃料"、"热"、"冷"、"常数电价"、"分时电价"、"阶梯电价"、"分时阶梯电价"
+    
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+    
+            :return: string类型，返回新添加数据项的ID，如果数据结构不满足要求，应当抛出异常
+        '''
+        assert (dataType in self._kindNameMap
+                or dataType in self._kindUrlMap), "数据类型不存在"
+        kind = self._kindNameMap.get(dataType, dataType)
+        r = copy.deepcopy(data)
+        if r['id'] is not None:
+            del r['id']
+        if r['timeid'] is not None:
+            del r['timeid']
+        try:
+            self._saveItemData(self._kindUrlMap[kind], r)
+            self._kindIdMap[str(data['timeid'])]=kind
+            self._kindIdMap[str(data['id'])]=kind
+            self._itemDataMap[str(data['timeid'])]=data
+            self._itemDataMap[str(data['id'])]=data
+            if kind in ['thermalLoads', 'electricLoads', 'fuels']:
+                dataList = self._fetchItemData(self._kindUrlMap[kind], None)
+                self._kindItemDataMap[kind] = dataList
+                return dataList[-1]['id']
+            else:
+                dataList = self._fetchItemData(self._kindUrlMap[kind], kind)
+                self._kindItemDataMap[kind] = dataList
+                return dataList[-1]['id']
+        except Exception as e:
+            raise Exception(str(e))
+
+    def UpdateDataItem(self, ID: str, data):
+        '''
+            更新数据库ID对应数据项"光伏"、"风机"、"燃气轮机"、"热泵"、"燃气锅炉"、"热管式太阳能集热器"、"电压缩制冷机"、"吸收式制冷机"、"蓄电池"、"储水罐"、"变压器"、"传输线"、"模块化多电平变流器"、"离心泵"、"管道"、"采暖制冷负荷"、"电负荷"、"燃料"、"热"、"冷"、"常数电价"、"分时电价"、"阶梯电价"、"分时阶梯电价"数据
+            
+            :params: id string类型，代表数据项的标识符，可以在所有类型的数据项中实现唯一标识
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+            
+            :return: bool 类型，返回True 更新成功
+        '''
+        try:
+            kind = self._kindNameMap.get(data['kind'], data['kind'])
+            if kind is not None:
+                url=self._kindUrlMap[kind] + '/' + str(ID) + '/'
+                ret = self._updateItemData(url, data)
+                for i in range(len(self._kindItemDataMap[kind])):
+                    if str(self._kindItemDataMap[kind][i]['id']) == str(ID):
+                        self._kindItemDataMap[kind][i] = data
+                        break
+                    else:
+                        pass
+                return True
+            else:
+                raise Exception('传入的数据缺乏kind类型')
+        except Exception as e:
+            raise Exception(str(e))
+
+    def DeleteDataItem(self, ID: str):
+        '''
+            向数据库中删除ID对应数据项"光伏"、"风机"、"燃气轮机"、"热泵"、"燃气锅炉"、"热管式太阳能集热器"、"电压缩制冷机"、"吸收式制冷机"、"蓄电池"、"储水罐"、"变压器"、"传输线"、"模块化多电平变流器"、"离心泵"、"管道"、"采暖制冷负荷"、"电负荷"、"燃料"、"热"、"冷"、"常数电价"、"分时电价"、"阶梯电价"、"分时阶梯电价"数据
+    
+            :params: ID string类型，代表数据项的标识符，可以在所有类型的数据项中实现唯一标识
+            
+            :return: bool 类型，删除是否成功，如果ID错误，抛出异常
+        '''
+        data = self._itemDataMap.get(str(ID),None)
+        kind = self._kindIdMap.get(str(ID))
+        if data is None or kind is None:
+            raise Exception('id错误，未找到该id资源')
+        else:
+            url=self._kindUrlMap[kind]
+            self._deleteItemData(url+str(data['id'])+'/')
+            del self._itemDataMap[str(data['timeid'])]
+            del self._itemDataMap[str(data['id'])]
+            dataList=self._kindItemDataMap[kind]
+            for i in range(len(dataList)):
+                if dataList[i]['id'] == data['id']:
+                    del dataList[i]
+                    break
+            return True
+
+    def SetProjectPosition(self, longitude, latitude):
+        '''
+            将项目的经纬度位置坐标设置为(longitude, latitude)
+            
+            :params: longitude float类型，表示经度，范围为气象数据源的经度范围
+            :params: latitude float类型，表示纬度，范围为气象数据源的纬度范围
+        '''
+        if (float(longitude) > 180 or float(longitude) < -180
+                or float(latitude) > 90 or float(latitude) < -90):
+            raise Exception('经纬度坐标不存在')
+        else:
+            r = request('GET',
+                        self._baseUri + 'rest/weather_param/',
+                        params={"simu": self.simulationId})
+            param = json.loads(r.text)
+            if (len(param["results"]) == 0):
+                r = request('POST',
+                            self._baseUri + 'rest/weather_param/',
+                            data=json.dumps({
+                                "lat": latitude,
+                                "lng": longitude,
+                                "simu": self.simulationId,
+                                "simu_id": self.simulationId,
+                            }))
+            else:
+                id = param['results'][0]['id']
+                r = request('PUT',
+                            self._baseUri + 'rest/weather_param/' + str(id) +
+                            '/',
+                            data=json.dumps({
+                                "id": id,
+                                "lat": latitude,
+                                "lng": longitude,
+                                "simu": self.simulationId,
+                                "simu_id": self.simulationId,
+                            }))
+                r = request('GET',
+                            self._baseUri + 'load_weather/',
+                            params={
+                                "lat": latitude,
+                                "lng": longitude,
+                                "simu": self.simulationId,
+                                "simu_id": self.simulationId,
+                            })
+
+    def GetAtmosData(self, startDate, endDate):
+        '''
+            获取在startDate到endDate之间的气象数据
+            
+            :params: startDate dateTime类型，表示开始时间
+            :params: endDate dateTime类型，表示结束时间
+            
+            :return: list<dict>类型，为源数据的引用，返回当前项目位置对应时间范围内的气象数据序列，每个元素用字典进行表示，字典的key即区分不同的气象数据项（如风速、太阳辐照等）以及标识当前时间点
+        '''
+        sDate = datetime.date(*map(int, startDate.split('-')))
+        eDate = datetime.date(*map(int, endDate.split('-')))
+        res = (eDate - sDate).days * 86400 + (eDate - sDate).seconds
+        if res < 0:
+            raise Exception('超出有效时间范围')
+        else:
+            r = request('GET',
+                        self._weatherUrl,
+                        params={
+                            "time_after": startDate,
+                            "time_before": endDate,
+                            "sid": self.simulationId,
+                        })
+            weatherData = json.loads(r.text)
+            return weatherData['results']
+
+
+class IESSimulationDataManageModel(DataManageModel):
+    _baseUri = 'api/ieslab-simulation/'
+    _weatherUrl = 'api/ieslab-simulation/rest/weather_data/'
+    _kindNameMap = {
+        "光伏": "PhotovoltaicSys",
+        "风机": "WindPowerGenerator",
+        "燃气轮机": "GasTurbine",
+        "热泵": "HeatPump",
+        "燃气锅炉": "GasBoiler",
+        "热管式太阳能集热器": "HPSolarCollector",
+        "电压缩制冷机": "CompRefrg",
+        "吸收式制冷机": "AbsorptionChiller",
+        "蓄电池": "Battery",
+        "储水罐": "WaterTank",
+        "变压器": "Transformer",
+        "传输线": "TransferLine",
+        "模块化多电平变流器": "MMC",
+        "离心泵": "CentrifugalPump",
+        "管道": "Pipe",
+        "采暖制冷负荷": "thermalLoads",
+        "电负荷": "electricLoads",
+        "燃料": "fuels",
+        "热": "HVACHeating",
+        "冷": "HVACCooling",
+        "常数电价": "常数电价",
+        "分时电价": "分时电价",
+        "阶梯电价": "阶梯电价",
+        "分时阶梯电价": "分时阶梯电价",
+        "台风灾害": "typhoon",
+        "降雨灾害": "rainfall",
+        "地震灾害": "earthquake",
+        "极寒灾害": "extremeCold"
+    }
+    _kindUrlMap = {
+        "PhotovoltaicSys": "api/ieslab-simulation/rest/dpcs/",
+        "WindPowerGenerator": "api/ieslab-simulation/rest/dpcs/",
+        "GasTurbine": "api/ieslab-simulation/rest/dpcs/",
+        "HeatPump": "api/ieslab-simulation/rest/dhscs/",
+        "GasBoiler": "api/ieslab-simulation/rest/dhscs/",
+        "HPSolarCollector": "api/ieslab-simulation/rest/dhscs/",
+        "CompRefrg": "api/ieslab-simulation/rest/dhscs/",
+        "AbsorptionChiller": "api/ieslab-simulation/rest/dhscs/",
+        "Battery": "api/ieslab-simulation/rest/escs/",
+        "WaterTank": "api/ieslab-simulation/rest/escs/",
+        "Transformer": "api/ieslab-simulation/rest/dstcs/",
+        "TransferLine": "api/ieslab-simulation/rest/dstcs/",
+        "MMC": "api/ieslab-simulation/rest/dstcs/",
+        "CentrifugalPump": "api/ieslab-simulation/rest/hstcs/",
+        "Pipe": "api/ieslab-simulation/rest/hstcs/",
+        "thermalLoads": "api/ieslab-simulation/rest/thermalLoads/",
+        "electricLoads": "api/ieslab-simulation/rest/electricLoads/",
+        "fuels": "api/ieslab-simulation/rest/fuels/",
+        "HVACHeating": "api/ieslab-simulation/rest/hots/",
+        "HVACCooling": "api/ieslab-simulation/rest/colds/",
+        "常数电价": "api/ieslab-simulation/rest/elects/",
+        "分时电价": "api/ieslab-simulation/rest/elects/",
+        "阶梯电价": "api/ieslab-simulation/rest/elects/",
+        "分时阶梯电价": "api/ieslab-simulation/rest/elects/",
+        "typhoon":  "api/ieslab-simulation/rest/typhoon/",
+        "rainfall": "api/ieslab-simulation/rest/rainfall/",
+        "earthquake": "api/ieslab-simulation/rest/earthquake/",
+        "extremeCold": "api/ieslab-simulation/rest/extremeCold/"
+    }
+    pass
+
+
+class IESPlanDataManageModel(DataManageModel):
+    _baseUri = 'api/ieslab-plan/'
+    _weatherUrl = 'api/ieslab-plan/rest/weather_data/'
+    _kindNameMap = {
+        "光伏": "PhotovoltaicSys",
+        "风机": "WindPowerGenerator",
+        "燃气轮机": "GasTurbine",
+        "热泵": "HeatPump",
+        "燃气锅炉": "GasBoiler",
+        "热管式太阳能集热器": "HPSolarCollector",
+        "电压缩制冷机": "CompRefrg",
+        "吸收式制冷机": "AbsorptionChiller",
+        "蓄电池": "Battery",
+        "储水罐": "WaterTank",
+        "变压器": "Transformer",
+        "传输线": "TransferLine",
+        "模块化多电平变流器": "MMC",
+        "离心泵": "CentrifugalPump",
+        "管道": "Pipe",
+        "采暖制冷负荷": "thermalLoads",
+        "电负荷": "electricLoads",
+        "燃料": "fuels",
+        "热": "HVACHeating",
+        "冷": "HVACCooling",
+        "常数电价": "常数电价",
+        "分时电价": "分时电价",
+        "阶梯电价": "阶梯电价",
+        "分时阶梯电价": "分时阶梯电价",
+        "台风灾害": "typhoon",
+        "降雨灾害": "rainfall",
+        "地震灾害": "earthquake",
+        "极寒灾害": "extremeCold"
+    }
+    _kindUrlMap = {
+        "PhotovoltaicSys": "api/ieslab-plan/rest/dpcs/",
+        "WindPowerGenerator": "api/ieslab-plan/rest/dpcs/",
+        "GasTurbine": "api/ieslab-plan/rest/dpcs/",
+        "HeatPump": "api/ieslab-plan/rest/dhscs/",
+        "GasBoiler": "api/ieslab-plan/rest/dhscs/",
+        "HPSolarCollector": "api/ieslab-plan/rest/dhscs/",
+        "CompRefrg": "api/ieslab-plan/rest/dhscs/",
+        "AbsorptionChiller": "api/ieslab-plan/rest/dhscs/",
+        "Battery": "api/ieslab-plan/rest/escs/",
+        "WaterTank": "api/ieslab-plan/rest/escs/",
+        "Transformer": "api/ieslab-plan/rest/dstcs/",
+        "TransferLine": "api/ieslab-plan/rest/dstcs/",
+        "MMC": "api/ieslab-plan/rest/dstcs/",
+        "CentrifugalPump": "api/ieslab-plan/rest/hstcs/",
+        "Pipe": "api/ieslab-plan/rest/hstcs/",
+        "thermalLoads": "api/ieslab-plan/rest/thermalLoads/",
+        "electricLoads": "api/ieslab-plan/rest/electricLoads/",
+        "fuels": "api/ieslab-plan/rest/fuels/",
+        "HVACHeating": "api/ieslab-plan/rest/hots/",
+        "HVACCooling": "api/ieslab-plan/rest/colds/",
+        "常数电价": "api/ieslab-plan/rest/elects/",
+        "分时电价": "api/ieslab-plan/rest/elects/",
+        "阶梯电价": "api/ieslab-plan/rest/elects/",
+        "分时阶梯电价": "api/ieslab-plan/rest/elects/",
+        "typhoon":  "api/ieslab-plan/rest/typhoon/",
+        "rainfall": "api/ieslab-plan/rest/rainfall/",
+        "earthquake": "api/ieslab-plan/rest/earthquake/",
+        "extremeCold": "api/ieslab-plan/rest/extremeCold/"
+    }
+    pass