cloudpss 3.5.0a1__tar.gz → 4.0.0__tar.gz

{cloudpss-3.5.0a1 → cloudpss-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudpss
-Version: 3.5.0a1
+Version: 4.0.0
 Summary: cloudpss sdk
 Home-page: https://www.cloudpss.net
 Author: cloudpss

{cloudpss-3.5.0a1 → cloudpss-4.0.0}/cloudpss/__init__.py

@@ -6,18 +6,18 @@ 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', 'IESLabSimulation', 'IESLabPlan'
+    'function', 'Project', 'currentJob', 'IESLabSimulation', 'IESLabPlan','__version__','Job'
 ]
-__version__ = '3.5.0-alpha.1'
 
 
 def currentJob():
     """
         获取当前的 currentExecution 实例
     """
-    return FunctionExecution.current()
+    return FunctionExecution.current()

{cloudpss-3.5.0a1 → cloudpss-4.0.0}/cloudpss/function/functionExecution.py

@@ -163,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-3.5.0a1 → cloudpss-4.0.0}/cloudpss/ieslab/DataManageModel.py

@@ -146,19 +146,19 @@ class DataManageModel(object):
         if r['timeid'] is not None:
             del r['timeid']
         try:
-            ret = self._saveItemData(self._kindUrlMap[kind], r)
+            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].append(dataList)
-                return dataList[len(dataList) - 1]['id']
+                self._kindItemDataMap[kind] = dataList
+                return dataList[-1]['id']
             else:
                 dataList = self._fetchItemData(self._kindUrlMap[kind], kind)
-                self._kindItemDataMap[kind].append(dataList)
-                return dataList[len(dataList) - 1]['id']
+                self._kindItemDataMap[kind] = dataList
+                return dataList[-1]['id']
         except Exception as e:
             raise Exception(str(e))
 

{cloudpss-3.5.0a1 → cloudpss-4.0.0}/cloudpss/ieslab/EvaluationModel.py

@@ -5,7 +5,6 @@ from ..utils import request
 import json
 from enum import IntEnum, unique
 
-
 class IESLabEvaluationModel(object):
     _baseUri = 'api/ieslab-plan/rest/'
     _taskUri = 'api/ieslab-plan/taskmanager/getSimuLastTasks'
@@ -58,6 +57,12 @@ class IESLabEvaluationModel(object):
         }
     }
 
+    # 评价基础参数接口默认值
+    _evaluationType = {
+        "环保评价": "environmentalEvaluation",
+        "能效评价": "energyEvaluation"
+    }
+
     def __init__(self, simulationId):
         '''
             初始化
@@ -91,7 +96,7 @@ class IESLabEvaluationModel(object):
         data = json.loads(r.text)
         return data
 
-    def GetFinancialParas(self, planID):
+    def GetFinancialParams(self, planID):
         '''
             获取planID对应的优化方案下财务评估模块的基础信息
             :param planID int类型，表示优化方案的ID，数值位于0~优化方案数量之间
@@ -128,6 +133,7 @@ class IESLabEvaluationModel(object):
             :return: Runner[IESLabEvaluationResult]
         '''
         url = 'api/ieslab-plan/taskmanager/saveDataToclickhouse'
+        CMD_TYPE = type if type is None else self._evaluationType[type]
         try:
             timeId = int(time.time() * 1000)
             r = request('GET',
@@ -135,20 +141,20 @@ class IESLabEvaluationModel(object):
                         params={
                             "simuid": self.simulationId,
                             "planId": planID,
-                            "CMD_TYPE": type
+                            "CMD_TYPE": CMD_TYPE
                         })
             data = json.loads(r.text)
             return HttpRunner({'rid': 'function/ieslab/evaluation'},
                 self.simulationId,
                 timeId=timeId,
                 planId=planID,
-                cmdType=type)
+                cmdType=CMD_TYPE)
         except:
             raise Exception('方案评估开始计算失败')
 
     def EnvironmentalEvaluationRun(self, planID):
         '''
-            运行方案评估
+            运行环保评价方案评估
 
             :param planID int类型，表示优化方案的ID，数值位于0~优化方案数量之间
 
@@ -158,7 +164,7 @@ class IESLabEvaluationModel(object):
 
     def EnergyEvaluationRun(self, planID):
         '''
-            运行方案评估
+            运行能效评价方案评估
 
             :param planID int类型，表示优化方案的ID，数值位于0~优化方案数量之间
 

{cloudpss-3.5.0a1 → cloudpss-4.0.0}/cloudpss/ieslab/IESLabPlan.py

@@ -7,6 +7,8 @@ from cloudpss.runner.IESLabTypicalDayResult import IESLabTypicalDayResult
 from ..utils import request
 from ..model.model import Model
 from cloudpss.runner.runner import  Runner
+from cloudpss.runner.IESLabPlanResult import IESLabPlanResult
+from cloudpss.runner.IESLabEvaluationResult import IESLabEvaluationResult
 
 class IESLabPlan(object):
     def __init__(self, project={}):
@@ -22,6 +24,8 @@ class IESLabPlan(object):
         self.dataManageModel = IESPlanDataManageModel(self.id)
         self.planModel = IESLabPlanModel(self.id)
         self.evaluationModel = IESLabEvaluationModel(self.id)
+        self.currentPlanResult = IESLabPlanResult(self.id)
+        self.currentEvaluationResult = IESLabEvaluationResult(self.id)
 
     @staticmethod
     def fetch(simulationId):
@@ -52,7 +56,6 @@ class IESLabPlan(object):
         if job is None:
             currentJob = self.model.context['currentJob']
             job = self.model.jobs[currentJob]
-
         job['args']['simulationId'] = self.id
         return self.model.run(job, name=name)
 
@@ -68,26 +71,28 @@ class IESLabPlan(object):
         if job is None:
             currentJob = self.model.context['currentJob']
             job = self.model.jobs[currentJob]
-            if job['rid'] != 'job-definition/ies/ies-gmm' or job['rid'] != 'job-definition/cloudpss/ieslab-gmm':
+            if job['rid'] != 'function/CloudPSS/ieslab-gmm':
                 for j in self.model.jobs:
-                    if j['rid'] == 'job-definition/ies/ies-gmm' or job['rid'] == 'job-definition/cloudpss/ieslab-gmm':
+                    if j['rid'] == 'job-definition/ies/ies-gmm' or j['rid'] == 'job-definition/cloudpss/ieslab-gmm':
+                        j['rid'] = 'function/CloudPSS/ieslab-gmm'
                         job = j
         if job is None:
             raise Exception("找不到默认的综合能源系统规划典型日生成算法的计算方案")
-        if job['rid'] != 'job-definition/ies/ies-gmm'or job['rid'] != 'job-definition/cloudpss/ieslab-gmm':
+        if job['rid'] != 'function/CloudPSS/ieslab-gmm':
             raise Exception("不是综合能源系统规划典型日生成算法的计算方案")
         return self.__run(job=job, name=name)
 
-    def iesLabEvaluationRun(self, planId):
+    def iesLabEvaluationRun(self, planId, type=None):
         '''
             运行方案评估
 
             :param planID int类型，表示优化方案的ID，数值位于0~优化方案数量之间
+            :param type string类型，表示评估类型，可选值为：能效评价、环保评价
 
             :return: 方案评估运行实例
 
         '''
-        return self.evaluationModel.run(planId)
+        return self.evaluationModel.run(planId, type)
 
     def iesLabEnergyEvaluationRun(self, planId):
         '''
@@ -117,3 +122,11 @@ class IESLabPlan(object):
             :return: 方案优选运行实例
         '''
         return self.planModel.run()
+    
+    def iesLabPlanKill(self):
+        '''
+            停止并删除方案优选算例
+
+            :return: Boolean
+        '''
+        return self.planModel.kill()

{cloudpss-3.5.0a1 → cloudpss-4.0.0}/cloudpss/ieslab/IESLabSimulation.py

@@ -30,6 +30,7 @@ class IESLabSimulation(object):
             r = request(
                 'GET', 'api/ieslab-simulation/rest/simu/{0}/'.format(simulationId))
             project = json.loads(r.text)
+            print(project)
             return IESLabSimulation(project)
         except:
             raise Exception('未查询到当前算例')
@@ -48,5 +49,6 @@ class IESLabSimulation(object):
             job = self.model.jobs[currentJob]
 
         job['args']['simulationId'] = self.id
+        print(job)
         return self.model.run(job, name=name)
 

cloudpss-4.0.0/cloudpss/ieslab/PlanModel.py

@@ -0,0 +1,143 @@
+from cloudpss.runner.IESLabPlanResult import IESLabPlanResult
+from cloudpss.runner.runner import HttpRunner, Runner
+from ..utils import request, fileLoad
+import json
+from enum import IntEnum, unique
+
+
+class IESLabPlanModel(object):
+    _baseUri = 'api/ieslab-plan/taskmanager/getSimuLastTasks'
+
+    def __init__(self, simulationId):
+        '''
+            初始化
+        '''
+        self.simulationId = simulationId
+        self.optimizationInfo = self.GetOptimizationInfo()
+        self.OptimizationMode = OptimizationMode
+
+    def _fetchItemData(self, url):
+        '''
+            获取当前算例的优化目标设置信息
+
+            :return: enum 类型，代表经济性优化和环保性优化的类型
+        '''
+        r = request('GET', url, params={"simuid": self.simulationId})
+        data = json.loads(r.text)
+        return data
+
+    def GetOptimizationInfo(self):
+        '''
+            获取当前算例的优化目标设置信息
+
+            :return: enum 类型，代表经济性优化和环保性优化的类型
+        '''
+        try:
+            data = self._fetchItemData(self._baseUri)
+            for e in OptimizationMode:
+                if (e.value == data['data']['optimizationpara']
+                    ['OptimizationMode']):
+                    return e
+        except:
+            return OptimizationMode['经济性']
+
+    def SetOptimizationInfo(self, optType):
+        '''
+            无对应接口
+            设置当前算例的优化目标
+
+            :param optType: enum 类型，代表经济性优化和环保性优化的类型
+        '''
+        self.optimizationInfo = optType
+        return True
+
+    def run(self) -> Runner[IESLabPlanResult]:
+        '''
+            生成方案优选算例
+
+            :return: Runner[IESLabPlanResult]
+        '''
+        isRunning = self.GetLastTaskResult()
+        if isRunning:
+            raise Exception('该算例正在运行！请从浏览器算例页面点击结束运行或者调用IESPlan对象的kill接口终止计算后重试！')
+        else:
+            url = 'api/ieslab-plan/taskmanager/runOptimization'
+            if self.optimizationInfo is None:
+                self.optimizationInfo = OptimizationMode['经济性']
+            optType = self.optimizationInfo.value or 0
+            try:
+                r = request('GET',
+                            url,
+                            params={
+                                "simuid":
+                                self.simulationId,
+                                "optPara":
+                                json.dumps({
+                                    "OptimizationMode": optType,
+                                    "ProjectPeriod": "20"
+                                })
+                            })
+                data = json.loads(r.text)
+                return HttpRunner({}, self.simulationId)
+            except:
+                raise Exception('生成方案优选算例失败')
+
+    def GetRunner(self) -> Runner[IESLabPlanResult]:
+        '''
+            获得运行实例
+
+            :return: Runner[IESLabPlanResult]
+        '''
+        return HttpRunner({}, self.simulationId)
+    
+    def kill(self) -> bool:
+        '''
+            停止并删除当前运行的优化算例
+        '''
+        res = IESLabPlanResult(self.simulationId).getLastTaskResult()
+        error = res.get('error', 0)
+        if error == 0:
+            data = res.get('data', {})
+            if data is not None:
+                taskID = data.get('task_id', '')
+        url = f'api/ieslab-plan/taskmanager/removeOptimizationTask'
+        try:
+            r = request('GET',
+                        url,
+                        params={
+                            "taskid": taskID,
+                            "stopFlag": '2'
+                        })
+            json.loads(r.text)
+            return True
+        except:
+            return False
+
+    def GetLastTaskResult(self)-> bool:
+        '''
+            获取最后一次运行的taskID的运行结果与日志
+
+            :return: boolean 类型
+        '''
+        isRunning = True
+        res = IESLabPlanResult(self.simulationId).getLastTaskResult()
+        error = res.get('error', 0)
+        if error == 0:
+            data = res.get('data', {})
+            if data is not None:
+                status = data.get('status', '')
+                if status == 'stop':
+                    isRunning = False
+        logs = IESLabPlanResult(self.simulationId).GetLogs()
+        if logs is not None:
+            for log in logs:
+                if(log.get('data', '') == 'run ends'):
+                    isRunning = False
+                    break
+        return isRunning
+
+
+# @unique
+class OptimizationMode(IntEnum):
+    经济性 = 0
+    环保性 = 1

cloudpss-4.0.0/cloudpss/ieslab/__init__.py

@@ -0,0 +1,4 @@
+from .IESLabSimulation import IESLabSimulation
+from .IESLabPlan import IESLabPlan
+from .PlanModel import OptimizationMode
+__all__ = ['IESLabSimulation','IESLabPlan', 'OptimizationMode']

cloudpss-4.0.0/cloudpss/job/__init__.py

@@ -0,0 +1,5 @@
+from .job import Job
+
+__all__ = [
+    'Job'
+]

cloudpss-4.0.0/cloudpss/job/job.py

@@ -0,0 +1,277 @@
+import random
+import re
+import time
+from .view import getViewClass
+
+from cloudpss.utils.IO import IO
+from .messageStreamReceiver import MessageStreamReceiver
+
+from cloudpss.utils.graphqlUtil import graphql_request
+from .jobPolicy import JobPolicy
+from .jobMachine import JobMachine
+from .messageStreamSender import MessageStreamSender
+
+
+
+class Job(object):
+    """docstring for Job"""
+
+    def __init__(self, id, args, createTime, startTime, endTime, status,
+                 context, user, priority, policy, machine, input, output,
+                 position):
+        super(Job, self).__init__()
+        self.id = id
+        self.args = args
+        self.createTime = createTime
+        self.startTime = startTime
+        self.endTime = endTime
+        self.status = status
+        self.context = context
+        self.user = user
+        self.priority = priority
+        self.policy = policy  # type: ignore
+        self.machine = JobMachine(**machine)  # type: ignore
+        self.input = input
+        self.output = output
+        self.position = position
+        self.__receiver = None
+        self.__sender = None
+
+    @staticmethod
+    def fetch(id):
+        """
+        获取job信息
+        """
+        if id is None:
+            raise Exception('id is None')
+        query = '''query($_a:JobInput!){
+            job(input:$_a){
+                id
+                args
+                createTime
+                startTime
+                endTime
+                status
+                context
+                user
+                priority
+                policy  { 
+                    name
+                    queue
+                    tres {
+                        cpu
+                        ecpu
+                        mem
+                    } 
+                    priority 
+                    maxDuration 
+                }
+                machine {
+                    id
+                    name
+                    tres {
+                        cpu
+                        ecpu
+                        mem
+                    }
+                }
+                input
+                output
+                position
+            }
+        }'''
+        variables = {"_a": {"id": id}}
+        r = graphql_request(query, variables)
+        if 'errors' in r:
+            raise Exception(r['errors'])
+        return Job(**r['data']['job'])
+
+    @staticmethod
+    def fetchMany(input):
+        """
+        批量获取任务信息
+        """
+        if input is None:
+            raise Exception('input is None')
+        query = '''query($_a:JobsInput!){
+            jobs(input:$_a){
+                item {
+                    id
+                    args
+                    createTime
+                    startTime
+                    endTime
+                    status
+                    context
+                    user
+                    priority
+                    policy  {
+                        id 
+                        name 
+                        users 
+                        functions 
+                        tres {
+                            cpu
+                            ecpu
+                            mem
+                        } 
+                        minPriority 
+                        maxPriority 
+                        maxDuration 
+                        createTime 
+                        updateTime 
+                        visibility 
+                        queue
+                    }
+                    machine {
+                        id
+                        name
+                        tres {
+                            cpu
+                            ecpu
+                            mem
+                        }
+                        valid
+                    }
+                    input
+                    output
+                    position
+                } 
+                cursor 
+                count 
+                total
+                }
+            }'''
+        variables = {"_a": input}
+        r = graphql_request(query, variables)
+        if 'errors' in r:
+            raise Exception(r['errors'])
+        jobs = []
+        for job in r['data']['jobs']['item']:
+            jobs.append(Job(**job))
+        return jobs
+
+    @staticmethod
+    def create(revisionHash,
+               job,
+               config,
+               name=None,
+               rid='',
+               policy=None,
+               **kwargs):
+        '''
+            创建一个运行任务
+
+            :params: revision 项目版本号
+            :params: job 调用仿真时使用的计算方案，为空时使用项目的第一个计算方案
+            :params: config 调用仿真时使用的参数方案，为空时使用项目的第一个参数方案
+            :params: name 任务名称，为空时使用项目的参数方案名称和计算方案名称
+            :params: rid 项目rid，可为空
+
+            :return: 返回一个运行实例
+
+            >>> runner = Runner.runRevision(revision,job,config,'')
+        '''
+
+        #处理policy字段
+        if policy is None:
+            policy = {}
+            if policy.get('tres', None) is None:
+                policy['tres'] = {}
+            policy['queue'] = job['args'].get('@queue', 1)
+            policy['priority'] = job['args'].get('@priority', 0)
+            tres = {'cpu': 1, 'ecpu': 0, 'mem': 0}
+            tresStr = job['args'].get('@tres', '')
+            for t in re.split('\s+', tresStr):
+                if t == '':
+                    continue
+                k, v = t.split('=')
+                tres[k] = float(v)  #type: ignore
+            policy['tres'] = tres
+
+        query = '''mutation($input:CreateJobInput!){job:createJob(input:$input){id input output status position}}'''
+        function = job['rid'].replace('job-definition/cloudpss/',
+                                      'function/CloudPSS/')
+        variables = {
+            'input': {
+                "args": {
+                    **job['args'], '_ModelRevision': revisionHash,
+                    '_ModelArgs': config['args']
+                },
+                "context": [
+                    function,
+                    rid,
+                    f"model/@sdk/{str(int(time.time() * random.random()))}"
+                ],
+                "policy":
+                policy,
+            }
+        }
+        r = graphql_request(query, variables)
+        if 'errors' in r:
+            raise Exception(r['errors'])
+        id = r['data']['job']['id']
+        return Job.fetch(id)
+
+    @staticmethod
+    def abort(id, timeout):
+        """
+        结束当前运行的算例
+
+        """
+        query = '''mutation ($input: AbortJobInput!) {
+            job: abortJob(input: $input) {
+                id
+                status
+            }
+        }
+        '''
+        variables = {'input': {'id': id, 'timeout': timeout}}
+        graphql_request(query, variables)
+
+    @staticmethod
+    def load(file, format='yaml'):
+        return IO.load(file, format)
+
+    @staticmethod
+    def dump(job, file, format='yaml', compress='gzip'):
+        return IO.dump(job, file, format, compress)
+
+    def read(self, receiver=None, dev=False, **kwargs):
+        """
+        使用接收器获取当前运行实例的输出
+        """
+        if receiver is not None:
+            self.__sender = receiver
+        if self.__receiver is None:
+            self.__receiver = MessageStreamReceiver(self, dev)
+        self.__receiver.connect(**kwargs)
+        return self.__receiver
+
+    def write(self,sender=None, dev=False, **kwargs)->MessageStreamSender:
+        """
+            使用发送器为当前运行实例输入
+        """
+        
+        if sender is not None:
+            self.__sender = sender
+        if self.__sender is None:
+            self.__sender =MessageStreamSender(self,dev)
+        self.__sender.connect(**kwargs)
+        return self.__sender
+    
+    @property
+    def result(self):
+        """
+        获取当前运行实例的输出
+        """
+        viewType = getViewClass(self.context[0])
+        return self.view(viewType)
+
+    def view(self, viewType):
+        """
+        获取当前运行实例的输出
+        """
+        receiver = self.read()
+        sender=self.write()
+        return viewType(receiver,sender)

cloudpss-4.0.0/cloudpss/job/jobMachine.py

@@ -0,0 +1,11 @@
+from cloudpss.job.jobTres import JobTres
+
+
+class JobMachine(object):
+    '''job machine'''
+
+    def __init__(self, id, name, tres, valid=None):
+        self.id = id
+        self.name = name
+        self.tres = JobTres(**tres)  # type: ignore
+        self.valid = valid