cloudpss 4.0.0a7__py3-none-any.whl → 4.0.2__py3-none-any.whl

cloudpss/job/messageStreamReceiver.py

@@ -0,0 +1,120 @@
+import logging
+from .jobReceiver import JobReceiver
+import os
+from urllib.parse import urlparse
+import websocket
+import pytz
+import threading
+import time
+utc_tz = pytz.timezone('UTC')
+
+from ..utils.IO import IO
+
+
+class Message(object):
+
+    def __init__(self, id, token):
+        self.id = id
+        self.token = token
+        
+
+
+class MessageStreamReceiver(JobReceiver):
+
+    def __init__(self, job, dev=False):
+        super().__init__()
+        self.job = job
+        self.dev = dev
+        self.origin = os.environ.get('CLOUDPSS_API_URL',
+                                     'https://cloudpss.net/')
+        self.__hasOpen=False
+
+    def receive(self, id, fr0m, on_open, on_message, on_error, on_close):
+        """
+        读取消息流中的数据
+        id: 消息流id
+        fr0m: 从哪个位置开始读取，如果为0则从头开始读取
+        on_open: 连接建立时的回调函数
+        on_message: 收到消息时的回调函数
+        on_error: 发生错误时的回调函数
+        on_close: 连接关闭时的回调函数
+        """
+        if id is None:
+            raise Exception('id is None')
+        u = list(urlparse(self.origin))
+        head = 'wss' if u[0] == 'https' else 'ws'
+
+        path = head + '://' + str(u[1]) + '/api/streams/id/' + id
+        if fr0m is not None:
+            path = path + '&from=' + str(fr0m)
+        logging.info(f"receive data from websocket: {path}")
+        ws = websocket.WebSocketApp(path,
+                                    on_open=on_open,
+                                    on_message=on_message,
+                                    on_error=on_error,
+                                    on_close=on_close)
+        
+        return ws
+    
+    ###下面是兼容Receiver部分功能实现
+
+    def on_message(self, ws, message):
+        data = IO.deserialize(message, 'ubjson')
+        msg = IO.deserialize(data['data'], 'ubjson')
+        if msg.get('type', None) == 'log' and self.dev:
+            print(msg)
+        self.messages.append(msg)
+        # if msg and type(msg) is dict and msg.get('type', None) == 'terminate':
+        #     self.close(ws)
+
+    def on_error(self, ws, error):
+        logging.info("MessageStreamReceiver error")
+        msg = {
+            'type': 'log',
+            'verb': 'create',
+            'version': 1,
+            'data': {
+                'level': 'error',
+                'content': "websocket error",
+            },
+        }
+        self.messages.append(msg)
+
+    def on_close(self, *args, **kwargs):
+        logging.info("MessageStreamReceiver close")
+        self._status = 0
+        msg = {
+            'type': 'log',
+            'verb': 'create',
+            'version': 1,
+            'data': {
+                'level': 'error',
+                'content': "websocket closed",
+            },
+        }
+        self.messages.append(msg)
+
+    def on_open(self, ws):
+        self._status = 1
+        self.__hasOpen=True
+        pass
+
+    def close(self, ws):
+        self._status = 0
+        ws.close()
+
+    @property
+    def end(self):
+        return  not self._status
+
+    def connect(self):
+        self._status = 0
+        self.ws = self.receive(self.job.output, None, self.on_open,
+                               self.on_message, self.on_error, self.on_close)
+        
+        
+        thread = threading.Thread(target=self.ws.run_forever, args=(None , None , 6, 3))
+        thread.setDaemon(True)
+        thread.start()
+        while not self.__hasOpen:
+            time.sleep(0.2)

cloudpss/job/messageStreamSender.py

@@ -0,0 +1,74 @@
+import sys,os
+import threading
+from urllib.parse import urlparse
+sys.path.append(os.path.join(os.path.dirname(__file__), '../'))
+
+import websocket
+
+from cloudpss.utils.IO import IO
+import time
+import logging
+
+class MessageStreamSender():
+
+    def __init__(self, job, dev=False):
+        super().__init__()
+        self.job = job
+        self.dev = dev
+        self.origin = os.environ.get('CLOUDPSS_API_URL',
+                                     'https://cloudpss.net/')
+
+    ###下面是兼容Receiver部分功能实现
+
+    def on_message(self, ws, message):
+        logging.info('on_message',message)
+
+    def on_error(self, ws, error):
+        logging.info('on_error')
+
+    def on_close(self, *args, **kwargs):
+        time.sleep(0.5)
+        self._status = 0
+        
+        logging.info('on_close')
+
+    def on_open(self, ws):
+        self._status = 1
+        logging.info('on_open')
+        pass
+
+    def close(self):
+        
+        self._status = 0
+        self.ws.close()
+
+    @property
+    def status(self):
+        return self._status
+
+    def write(self, message):
+        data = IO.serialize(message, 'ubjson',None)
+        self.ws.send(data, websocket.ABNF.OPCODE_BINARY)
+        
+    def connect(self):
+        logging.info('connect')
+        self._status = 0
+        if self.job.input is None:
+            raise Exception('id is None')
+        u = list(urlparse(self.origin))
+        head = 'wss' if u[0] == 'https' else 'ws'
+
+        path = head + '://' + str(u[1]) + '/api/streams/token/' + self.job.input
+        logging.info(f"receive data from websocket: {path}")
+        
+        self.ws = websocket.WebSocketApp(path,
+                                    on_open=self.on_open,
+                                    on_message=self.on_message,
+                                    on_error=self.on_error,
+                                    on_close=self.on_close)
+        
+        thread = threading.Thread(target=self.ws.run_forever, args=(None , None , 6, 3))
+        thread.setDaemon(True)
+        thread.start()
+        while self.status != 1:
+            time.sleep(0.2)

cloudpss/job/view/EMTView.py

@@ -0,0 +1,216 @@
+import copy
+import uuid
+
+from .view import View
+class EMTView(View):
+    """
+        电磁暂态结果视图， 
+
+        提供快捷 plot 数据的接口函数，获取到的 plot 数据为合并后的数据格式，不在是接收时分段的数据
+
+        该类只提供 EMT 仿真使用
+
+    """
+
+    def getPlots(self):
+        '''
+            获取所有的 plots 数据
+
+            >>> result.getPlots()
+            {...}
+        '''
+        for val in self._receiver:
+            if val['type'] == 'plot':
+                key = val['key']
+                if self.result.get(key, None) is None:
+                    self.result[key] = copy.deepcopy(val)
+                else:
+                    traces = val['data']['traces']
+                    for i in range(len(traces)):
+                        v = traces[i]
+                        self.result[key]['data']['traces'][i]['x'].extend(
+                            v['x'])
+                        self.result[key]['data']['traces'][i]['y'].extend(
+                            v['y'])
+        return self.result.values()
+    
+    def getPlot(self, index: int):
+        '''
+            获取指定序号的数据分组
+
+            :params: index 图表位置
+
+            >>> result.getPlot(0)
+            {...}
+        '''
+        self.getPlots()
+        if self.result is not None:
+            return self.result.get('plot-{0}'.format(int(index)), None)
+        
+    def getPlotChannelNames(self, index):
+        '''
+            获取一组输出分组下的所有通道名称
+
+            :params: index 输出通道位置
+
+            :return: 通道名称数组
+
+            >>>names= result.getPlotChannelNames(0)
+            []
+        '''
+        plot = self.getPlot(int(index))
+        if plot is None:
+            return None
+
+        return [val['name'] for val in plot['data']['traces']]
+    
+    def getPlotChannelData(self, index, channelName):
+        '''
+            获取一组输出分组下指定通道名称的数据
+
+            :params: index 输出通道位置
+            :params: channelName 输出通道名称
+
+            :return: 通道数据, 一个 trace 数据
+
+            >>>channel= result.getPlotChannelData(0，'')
+            {...}
+        '''
+        plot = self.getPlot(int(index))
+        if plot is None:
+            return None
+        for val in plot['data']['traces']:
+            if val['name'] == channelName:
+                return val
+        return val
+    
+    def next(self):
+        """
+            前进一个时步
+        """
+        
+        self.goto(-1)
+        
+    def goto(self,step):
+        """
+            前进到指定时步
+        """
+        if self._sender is not None:
+            self._sender .write({'type': 'debug', 'step': step})
+        else:
+            raise Exception('sender is None')
+    
+    def writeShm(self,path,buffer,offset):
+        """
+            写内存接口
+        """
+        if self._sender is not None:
+            self._sender.write({'type': 'memory', 'path': path,'value':buffer,'offset':offset})
+        else:
+            raise Exception('transmitter is None')
+    
+    def _writeEvent(self,eventType,eventTime,eventTimeType,defaultApp):
+        if self._sender is  None:
+            raise Exception('transmitter is None')
+        event = {
+            'eventType': eventType,
+            'eventTime': eventTime,
+            'eventTimeType':eventTimeType,
+            "defaultApp": defaultApp
+        }
+        self._sender.write({'type': 'eventchain', 'event': [event]})
+    
+    def stopSimulation(self):
+        """
+            停止仿真
+        """
+        param = {
+            "ctrl_type": "0",
+            "uuid": str(uuid.uuid1()),
+            'message': {
+                'log': '停止任务 ',
+            }
+        }
+        eventData = {}
+        eventData = {'SimuCtrl': param}
+
+        self._writeEvent('time','-1','1',{'SimuCtrl': eventData})
+            
+        
+    def _snapshotControl(self,ctrlType,snapshotNumber,log):
+        """
+            断面控制
+        """
+        param = {
+            "ctrl_type": ctrlType,
+            "snapshot_number": snapshotNumber,
+            "uuid": str(uuid.uuid1()),
+            'message': {
+                'log': log
+            },
+        }
+        eventData = {}
+        eventData = {'SnapshotCtrl': param}
+        self._writeEvent('time','-1','1',{'SnapshotCtrl': eventData})
+        
+    def saveSnapshot(self,snapshotNumber,log='保存断面成功'):
+        """
+            通过事件链保存断面
+        """
+        self._snapshotControl('0',snapshotNumber,log)
+    def loadSnapshot(self,snapshotNumber,log='加载断面成功'):
+        """
+            通过事件链加载断面
+        """
+        self._snapshotControl('1',snapshotNumber,log)
+        
+
+    def control(self,controlParam,eventTime='-1',eventTimeType='1'):
+        """
+            控制仿真
+        """    
+
+        if type(controlParam) is not list:
+            controlParam=[controlParam]
+        para={}
+        
+        for param in controlParam:
+            para[param['key']]={
+                'Value': {
+                    'value': param['value'],
+                    'uuid': param['uuid'] if param.get('uuid',None) is not None else str(uuid.uuid1()),
+                    'cmd': 'add',
+                    'message': param.get('message')  if param.get('message',None) is not None else{
+                        'log': param.get('log')  if param.get('log',None) is not None else '值变化到 '+str(param['value']),
+                    },
+                }
+            }
+        self._writeEvent('time',eventTime,eventTimeType,{'para': para})
+        pass
+    
+    def monitor(self,monitorParam,eventTime='-1',eventTimeType='1'):
+        
+        if type(controlParam) is not list:
+            controlParam=[controlParam]
+        para={}
+        for param in controlParam:
+            para[param['key']]={
+                'a': {
+                    'uuid':param['uuid'] if param.get('uuid',None) is not None else str(uuid.uuid1()),
+                    'function':param['function'],
+                    'cmd':'add',
+                    'period':param['period'],
+                    'value':param['value'],
+                    'key':param['key'],
+                    'freq':param['freq'],
+                    'condition':param['condition'],
+                    'cycle':param['cycle'],
+                    'nCount':param['nCount'],
+                    'message': param.get('message')  if param.get('message',None) is not None else{
+                        'log': param.get('log')  if param.get('log',None) is not None else '消息达到阈值 '+str(param['value']),
+                    },
+                }
+            }
+        self._writeEvent('time',eventTime,eventTimeType,{'para': para})
+        
+        pass

cloudpss/job/view/IESLabSimulationView.py

@@ -0,0 +1,5 @@
+from .IESView import IESView
+
+
+class IESLabSimulationView(IESView):
+    pass

cloudpss/job/view/IESLabTypicalDayView.py

@@ -0,0 +1,27 @@
+from .IESView import IESView
+
+class IESLabTypicalDayView(IESView):
+    def GetTypicalDayNum():
+        '''
+            获取当前result的典型日数量
+            
+            :return: int类型，代表典型日数量
+        '''
+    def GetTypicalDayInfo(dayID):
+        '''
+            获取dayID对应典型日的基础信息
+            
+            :params: dayID int类型，表示典型日的ID，数值位于 0~典型日数量 之间
+            
+            :return: dict类型，代表典型日的基础信息，包括典型日所代表的日期范围、典型日的名称等
+        '''
+    def GetTypicalDayCurve(dayID, dataType):
+        '''
+            获取dayID对应典型日下dataType参数的时序曲线
+            
+            :params: dayID int类型，表示典型日的ID，数值位于 0~典型日数量 之间
+            :params: dataType enum类型，标识辐照强度、环境温度、土壤温度、建筑物高度风速、风机高度风速、电负荷、热负荷、冷负荷的参数类型
+            
+            :return: list<float>类型，代表以1h为时间间隔的该参数的日内时序曲线
+        '''
+    pass

cloudpss/job/view/IESView.py

@@ -0,0 +1,103 @@
+import copy
+import collections
+
+class IESView(object):
+    """
+        综合能源结果视图， 
+
+        提供快捷 plot 数据的接口函数，获取到的 plot 数据为合并后的数据格式，不在是接收时分段的数据
+
+        该类只提供 IES 仿真使用
+
+    """
+     
+
+    def __init__(self,receiver) -> None:
+
+        self.result =  {'Sankey': []}
+        self.__receiver = receiver
+
+
+    def __readPlotResult(self):
+        for val in self.__receiver:
+            if val['type'] == 'plot':
+                key = val['key']
+                if key == 'Sankey':
+                    self.result['Sankey'].append(copy.deepcopy(val))
+                else:
+                    if self.result.get(key, None) is None:
+                        self.result[key] = copy.deepcopy(val)
+                    else:
+                        traces = val['data']['traces']
+                        for i in range(len(traces)):
+                            v = traces[i]
+                            self.result[key]['data']['traces'][i][
+                                'x'].extend(v['x'])
+                            self.result[key]['data']['traces'][i][
+                                'y'].extend(v['y'])
+
+    def getPlotData(self, compID, labelName, traceName='all', index=-1):
+        '''
+            获取元件ID为compID的元件，对应标签为labelName、图例名称为traceName的plot 数据的第index项
+
+            :params: compID string类型，代表元件的标识符
+            :params: labelName string类型，代表plot曲线的分组标签
+            :params: traceName string类型，代表Plot曲线对应分组下的图例名称，当为'all'时，返回所有图例的数据
+            :params: index int类型，代表对应图例时序数据中的第index项，当小于0时，返回该图例所有的时序数据
+            
+            :return: dict类型
+        '''
+        self.__readPlotResult()
+        key = compID + '_' + labelName
+        if key not in self.result.keys():
+            raise Exception('未找到元件标志为{0},对应label为{1}的plot数据'.format(
+                compID, labelName))
+
+        traceData = self.result[key]['data']['traces']
+        if traceName != 'all':
+            traceNameList = [traceName]
+        else:
+            traceNameList = [
+                traceData[i]['name'] for i in range(len(traceData))
+            ]
+
+        startIndex = 0
+        endIndex = len(traceData[0]['x'])
+        if index >= 0:
+            startIndex = index
+            endIndex = index + 1
+
+        plotData = collections.defaultdict(lambda: {})
+        for tName in traceNameList:
+            for i in range(len(traceData)):
+                dataLen = len(traceData[i]['x'])
+                if traceData[i]['name'] == tName:
+                    if endIndex > dataLen:
+                        raise Exception('请求的index超过了plot数据序列的长度')
+                    plotData[tName]['x'] = traceData[i]['x'][
+                        startIndex:endIndex]
+                    plotData[tName]['y'] = traceData[i]['y'][
+                        startIndex:endIndex]
+
+        return plotData
+    
+
+    def getSankey(self, index):
+        '''
+            获取第index个桑基图数据
+
+            >>> result.getSankey(index)
+            {...}
+        '''
+        self.__readPlotResult()
+        if index >= len(self.result['Sankey']):
+            raise Exception('index超过了桑基图数据序列的长度')
+        return self.result['Sankey'][index]
+    def getSankeyNum(self):
+        '''
+            获取桑基图数据序列的长度
+
+            >>> result.getSankeyNum()
+        '''
+        self.__readPlotResult()
+        return len(self.result['Sankey'])

cloudpss/job/view/PowerFlowView.py

@@ -0,0 +1,80 @@
+import copy
+import re
+
+from .view import View
+
+
+class PowerFlowView(View):
+    """
+        潮流结果视图， 
+
+        提供快速获取 buses 和 branches 的接口，并提供潮流写入项目的接口
+
+        该类只提供潮流仿真时使用
+
+    """
+
+    def getBuses(self):
+        """
+            获取所有的 buses 数据
+
+            >>> view.getBuses()
+            [...]
+        """
+        result = []
+        pattern = re.compile("value=\"(.*)\"")
+        data = self.getMessagesByKey('buses-table')
+        if len(data) == 0:
+            return []
+        table = copy.deepcopy(data[0])
+        columns = table['data']['columns']
+        for column in columns:
+            if column['type'] == 'html':
+                data = column['data']
+                for i in range(len(data)):
+                    if data[i] != '':
+                        s = pattern.findall(data[i])
+                        data[i] = s[0].replace('/', '')
+
+        result.append(table)
+        return result
+
+
+    def getBranches(self):
+        """
+            获取潮流结果 branches 数据
+
+            >>> view.getBranches()
+            [...]
+        """
+
+        result = []
+        pattern = re.compile("value=\"(.*)\"")
+        data = self.getMessagesByKey('branches-table')
+        if len(data) == 0:
+            return []
+        table = copy.deepcopy(data[0])
+
+        columns = table['data']['columns']
+        for column in columns:
+            if column['type'] == 'html':
+                data = column['data']
+                for i in range(len(data)):
+                    if data[i] != '':
+                        s = pattern.findall(data[i])
+                        data[i] = s[0].replace('/', '')
+
+        result.append(table)
+        return result
+    
+    def powerFlowModify(self, model):
+        """
+            潮流数据写入 model
+
+            >>> view.powerFlowModify(model)
+        """
+
+        data = self.getMessagesByKey('power-flow-modify')
+        if len(data) == 0:
+            raise Exception('未找到到数据')
+        self.modify(data[0], model)

cloudpss/job/view/__init__.py

@@ -0,0 +1,42 @@
+from .IESView import IESView
+from .view import View
+from .EMTView import EMTView
+from .PowerFlowView import PowerFlowView
+from .IESLabSimulationView import IESLabSimulationView
+from .IESLabTypicalDayView import IESLabTypicalDayView
+from ..messageStreamReceiver import MessageStreamReceiver
+from ..messageStreamSender import MessageStreamSender
+__all__ = [
+    'View','EMTView','PowerFlowView','IESLabSimulationView','IESView','IESLabTypicalDayView'
+]
+
+VIEW = {
+    'function/CloudPSS/emtp': EMTView,
+    'function/CloudPSS/emtps': EMTView,
+    'function/CloudPSS/sfemt': EMTView,
+    'function/CloudPSS/power-flow': PowerFlowView,
+    'function/CloudPSS/ies-simulation': IESView,
+    'function/CloudPSS/ies-optimization': IESView,
+    'function/ies/ies-optimization': IESView,
+    'function/CloudPSS/three-phase-powerFlow': PowerFlowView,
+    'function/ies/ies-simulation': IESLabSimulationView,
+    'function/ies/ies-gmm':IESLabTypicalDayView,
+    'function/CloudPSS/ieslab-simulation': IESLabSimulationView,
+    'function/CloudPSS/ieslab-gmm':IESLabTypicalDayView,
+    'function/CloudPSS/ieslab-optimization': IESView,
+}
+
+
+def getViewClass(rid: str) -> View:
+    """
+    获取仿真结果视图
+
+    :param rid: 仿真任务的 rid
+    :param db: 仿真任务的数据库
+
+    :return: 仿真结果视图
+
+    >>> view = get_view('function/CloudPSS/emtp', db)
+    >>> view.getPlots()
+    """
+    return VIEW.get(rid, View)