cloudpss 4.5.0__tar.gz → 4.5.1a1__tar.gz

{cloudpss-4.5.0 → cloudpss-4.5.1a1}/PKG-INFO

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

{cloudpss-4.5.0 → cloudpss-4.5.1a1}/cloudpss/__init__.py

@@ -9,10 +9,11 @@ from . import function
 from .job import Job
 from .function import FunctionExecution
 from .version import __version__
+from .dslab import DSLab
 __all__ = [
     'setToken', 'Model', 'ModelRevision', 'ModelTopology', 'Runner', 'Result',
     'PowerFlowResult', 'EMTResult', 'MatlabDataEncoder', 'DateTimeEncode',
-    'function', 'Project', 'currentJob', 'IESLabSimulation', 'IESLabPlan','IESLabOpt','__version__','Job'
+    'function', 'Project', 'currentJob', 'IESLabSimulation', 'IESLabPlan','IESLabOpt','__version__','Job','DSLab'
 ]
 
 

cloudpss-4.5.1a1/cloudpss/dslab/__init__.py

@@ -0,0 +1,2 @@
+from .dslab import DSLab
+__all__ = ['DSLab']

cloudpss-4.5.1a1/cloudpss/dslab/dataManageModel.py

@@ -0,0 +1,275 @@
+from ..utils import request, fileLoad, graphql_request
+import json
+import time, datetime
+import copy
+import os 
+from cloudpss.dslab.files import getCurveData
+
+class DataManageModel(object):
+    _weatherUrl = ''
+    _baseUri = ''
+    _kindUrlMap = {}
+    _itemDataMap={}
+    _kindItemDataMap={}
+    _kindIdMap={}
+
+    def __init__(self, resourceId):
+        self.resourceId = resourceId
+        self._fetchTypes()
+    def _status(self):
+        '''
+            获取运行状态
+
+            :return: boolean 类型
+        '''
+        pass
+    def _fetchTypes(self):
+        '''
+            获取所有数据项的类型
+
+            :return: list 类型，返回所有数据项的类型
+        '''
+        url = f"{self._baseUri}rest/types"
+        r = request('GET',url)
+        types = json.loads(r.text)
+        self._kindUrlMap = {kind['name']: f"api/dslab/rest/{kind['name']}" for kind in types}
+    def _fetchItemData(self, url):
+        '''
+            私有方法，获取simu对应所有数据项的列表
+            :params: url string类型，request请求对应的url链接
+            
+            :return: list类型，返回该种类下所有数据项的的列表
+        '''
+        r = request('GET',
+                    url,
+                    params={
+                        "simu": self.resourceId,
+                    })
+        return json.loads(r.text)
+    
+    def _saveItemData(self, url, data):
+        '''
+            私有方法，保存url链接对应的data数据
+            :params: url string类型，request请求对应的url链接
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+            
+            :return: 无
+        '''
+        r = request('POST', url, data=json.dumps(data))
+        
+
+    def _updateItemData(self, url, data):
+        '''
+            私有方法，更新url链接对应的data数据
+            :params: url string类型，request请求对应的url链接
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+            
+            :return: 无
+        '''
+        r = request('PUT', url, data=json.dumps(data))
+    
+    def _deleteItemData(self, url):
+        '''
+            私有方法，删除url链接对应的数据
+            :params: url string类型，request请求对应的url链接
+            
+            :return: 无
+        '''
+        r = request('DELETE',url)
+
+    def LocationGet(self):
+        '''
+            获取气象定位点数据
+
+            :return: list<dict>类型，为源数据的引用，包含id，经度坐标，纬度坐标，定位点名称
+        '''
+        url = f"{self._baseUri}rest/location"
+        r = request('GET',
+            url,
+            params={"simu": self.resourceId})
+        return json.loads(r.text)
+
+    def LocationCreate(self, name=None, longitude=None, latitude=None):
+        '''
+            创建气象定位点
+            :param: name 定位点名称，可选
+            :params: longitude float类型，可选，表示经度，范围为气象数据源的经度范围
+            :params: latitude float类型，可选，表示纬度，范围为气象数据源的纬度范围
+    
+            :return: 无
+        '''
+        url = f"{self._baseUri}rest/location"
+        r = request('POST',
+            url,
+            data=json.dumps({
+                "lat": latitude  if latitude is not None else '34.734492',
+                "lng": longitude if longitude is not None else '113.648906',
+                "simu": self.resourceId,
+                "name": name if name is not None else '定位点'
+            }))
+        d = json.loads(r.text)
+        
+    def LocationUpdate(self, id, name, longitude, latitude):
+        '''
+            修改气象定位点
+            :param id: 定位点id
+            :param: name 定位点名称，可选
+            :params: longitude float类型，可选，表示经度，范围为气象数据源的经度范围
+            :params: latitude float类型，可选，表示纬度，范围为气象数据源的纬度范围
+    
+            :return: 无
+        '''
+        if (float(longitude) > 180 or float(longitude) < -180
+            or float(latitude) > 90 or float(latitude) < -90):
+            raise Exception('经纬度坐标不存在')
+        else:
+            url = f"{self._baseUri}rest/location"
+            r = request('PUT',
+                url,
+                data=json.dumps({
+                    "lat": latitude,
+                    "lng": longitude,
+                    "simu": self.resourceId,
+                    "name": name,
+                    "id": id
+                }))
+            
+    def LocationDelete(self, id):
+        '''
+            删除气象定位点
+            :param id: 定位点id
+
+            :return: 无
+        '''
+        url = f"{self._baseUri}rest/location/{str(id)}"
+        r = request('DELETE',
+                url)
+
+    def LoadWeather(self):
+        '''
+            加载气象数据
+
+            :return: 无
+        '''
+        url = f"{self._baseUri}rest/load_weather"
+        r = request('GET',
+            url,
+            params = {
+                "simu": self.resourceId,
+            })
+        
+    def GetAtmosData(self, locationId, date):
+        '''
+            获取日期在date的气象数据
+            :params: locationId str类型，表示定位点id
+            :params: date dateTime类型，表示时间
+            
+            :return: list<dict>类型，为源数据的引用，返回当前项目位置对应时间范围内的气象数据序列，每个元素用字典进行表示，字典的key即区分不同的气象数据项（如风速、太阳辐照等）以及标识当前时间点
+        '''
+        rDate = datetime.date(*map(int, date.split('-')))
+        r = request('GET',
+                    self._weatherUrl, 
+                    params={
+                        "locationId": str(locationId),
+                        "date": rDate,
+                    })
+        return json.loads(r.text)
+    
+    def AddDataItem(self, kind, data, extra=None):
+        '''
+            向kind类型的数据库中添加内容为data的数据项
+            :params: kind str类型，数据的种类标识，包含：光伏、光伏曲线、风机、风机曲线、燃气、燃气曲线、水电、水电曲线、火电、火电曲线、生物质发电、生物质发电曲线、垃圾电厂、垃圾电厂曲线、传输线、变压器、开关、负荷分类、负荷用户、储能设备、储能运行策略、上网电价、输配电价、常数电价、阶梯电价、分时电价、分时阶梯电价
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+            :params extra list类型，表示添加的基准出力曲线、负荷曲线、策略曲线数据
+    
+            :return: list<dict>类型，返回该种类下所有数据项的列表
+        '''
+        if extra is None or not extra:
+            curveData = getCurveData(kind)
+            if len(curveData) > 0:
+                r = {
+                    'simu': self.resourceId,
+                    'name': data.get('name', ''),
+                    'extra': curveData,
+                    'data': data.get('data', {}),
+                }
+                url = f"{self._baseUri}rest/{kind}"
+                self._saveItemData(url, r)
+                return self._fetchItemData(url)
+            else:
+                r = {
+                    'simu': self.resourceId,
+                    'name': data.get('name', ''),
+                    'data': data.get('data', {}),
+                }
+                url = f"{self._baseUri}rest/{kind}"
+                self._saveItemData(url, r)
+                return self._fetchItemData(url)
+        else:
+            r = {
+                'simu': self.resourceId,
+                'name': data.get('name', ''),
+                'extra': extra,
+                'data': data.get('data', {}),
+            }
+            url = f"{self._baseUri}rest/{kind}"
+            self._saveItemData(url, r)
+            return self._fetchItemData(url)
+
+    def DeleteDataItem(self, id, kind):
+        '''
+            获取kind类型对应所有数据项的列表
+            :params: id int类型，数据的id
+            :params: kind str类型，数据的种类标识，包含：光伏、光伏曲线、风机、风机曲线、燃气、燃气曲线、水电、水电曲线、火电、火电曲线、生物质发电、生物质发电曲线、垃圾电厂、垃圾电厂曲线、传输线、变压器、开关、负荷分类、负荷用户、储能设备、储能运行策略、上网电价、输配电价、常数电价、阶梯电价、分时电价、分时阶梯电价
+    
+            :return: list<dict>类型，返回该种类下所有数据项的列表
+        '''
+        url = f"{self._baseUri}rest/id/{str(id)}"
+        self._deleteItemData(url)
+        return self._fetchItemData(f"{self._baseUri}rest/{kind}")
+
+
+    def UpdateDataItem(self, kind, data):
+        '''
+            更新kind类型对应数据项
+            :params: kind str类型，数据的种类标识，包含：光伏、光伏曲线、风机、风机曲线、燃气、燃气曲线、水电、水电曲线、火电、火电曲线、生物质发电、生物质发电曲线、垃圾电厂、垃圾电厂曲线、传输线、变压器、开关、负荷分类、负荷用户、储能设备、储能运行策略、上网电价、输配电价、常数电价、阶梯电价、分时电价、分时阶梯电价
+            :params: data dict类型，表示添加的数据内容，其数据结构应满足对应数据项的结构要求
+    
+            :return: list<dict>类型，返回该种类下所有数据项的列表
+        '''
+        url = f"{self._baseUri}rest/{kind}"
+        r = {
+            'id': data.get('id', ''),
+            'name': data.get('name', ''),
+            'data': data.get('data', {}),
+        }
+        self._updateItemData(url, r)
+        return self._fetchItemData(url)
+
+        
+    def GetItemList(self, kind):
+        '''
+            获取kind类型对应所有数据项的列表
+            :params: kind str类型，数据的种类标识，包含：光伏、光伏曲线、风机、风机曲线、燃气、燃气曲线、水电、水电曲线、火电、火电曲线、生物质发电、生物质发电曲线、垃圾电厂、垃圾电厂曲线、传输线、变压器、开关、负荷分类、负荷用户、储能设备、储能运行策略、上网电价、输配电价、常数电价、阶梯电价、分时电价、分时阶梯电价
+    
+            :return: list<dict>类型，返回该种类下所有数据项的列表
+        '''
+        url = f"{self._baseUri}rest/{kind}"
+        return self._fetchItemData(url)
+    
+    def GetItemExtra(self, kind, uuid):
+        '''
+            获取kind类型对应数据项的基准出力曲线、负荷曲线、策略曲线数据
+            :params: kind str类型，数据的类型
+            :params: uuid str类型，数据的unique id
+        '''
+        url = f"{self._baseUri}rest/id/{uuid}"
+        data = self._fetchItemData(url)
+        if data.get('extra', None) is None:
+            return None
+        return data.get('extra', None).get('data', None)
+
+class DSLabDataManageModel(DataManageModel):
+    _baseUri = 'api/dslab/'
+    _weatherUrl = 'api/dslab/rest/weather'
+

cloudpss-4.5.1a1/cloudpss/dslab/dslab.py

@@ -0,0 +1,213 @@
+import json
+from ..utils import request
+from ..model.model import Model
+from .dataManageModel import DSLabDataManageModel
+from .financialAnalysisModel import DSLabFinancialAnalysisModel
+from cloudpss.runner.DSLabResult import DSLabResult
+from cloudpss.runner.runner import Runner
+from cloudpss.runner.result import IESResult, EMTResult
+
+class DSLab(object):
+    def __init__(self, project={}):
+        '''
+            初始化
+        '''
+        self.id = project.get('id', None)
+        self.resource = project.get('resource', None)
+        self.name = project.get('name', None)
+        self.__modelRid = project.get('model', None)
+        if self.__modelRid is not None:
+            self.model = Model.fetch(self.__modelRid)
+        self.dataManageModel = DSLabDataManageModel(self.resource)
+        self.financialAnalysisModel = DSLabFinancialAnalysisModel(self.resource)
+        self.currentEvaluationResult = DSLabResult(self.resource)
+
+    @staticmethod
+    def fetch(simulationId):
+        '''
+            获取算例信息
+
+            :params: simulationId string类型，代表数据项的算例id
+
+            :return: DSLab
+        '''
+        try:
+            r = request(
+                'GET', 'api/dslab/rest/simulation/{0}'.format(simulationId))
+            project = json.loads(r.text)
+            return DSLab(project)
+        except Exception as e:
+            if 'Unauthorized' in str(e): 
+                raise Exception('token 无效')
+            else:
+                raise Exception('未查询到当前算例')
+
+    def run(self, job=None, name=None):
+        '''
+            调用仿真 
+
+            :params job:  调用仿真时使用的计算方案，不指定将使用算例保存时选中的计算方案
+            :params name:  任务名称，为空时使用项目的参数方案名称和计算方案名称
+
+            :return: 返回一个运行实例
+        '''
+        if job is None:
+            currentJob = self.model.context['currentJob']
+            job = self.model.jobs[currentJob]
+
+        job['args']['simulationId'] = self.resource
+        return self.model.run(job, name=name)
+    
+    def dsLabRun(self):
+        '''
+            生成方案优选算例
+
+            :return: 方案优选运行实例
+        '''
+    pass
+
+    def dsLabFinancialRun(self, planID):
+        '''
+            运行技术经济分析
+            :param planID int 类型，表示优化方案的ID，数值位于0~优化方案数量之间
+
+            :return: 技术经济分析实例
+
+        '''
+        return self.financialAnalysisModel.run(planID)
+    
+
+    def runIESLoadPrediction(self,job=None,name=None, **kwargs)->Runner[IESResult]:
+        '''
+            运行 负荷预测方案 内核，如果当前 model 没有创建  Job 时报错，默认使用第一个计算方案，进行仿真。
+            
+            :param: job 计算方案名称，可选，字符串类型或者字典类型,默认使用第一个计算方案，如果同名使用最靠前一个
+            :params name:  任务名称，为空时使用项目的参数方案名称和计算方案名称
+
+            :return: runner Runner[IESResult]
+        '''
+        rid = 'function/CloudPSS/ieslab-load-prediction'
+        if job is None:
+            currentJob = self.model.context['currentJob']
+            job = self.model.jobs[currentJob]
+            if job['rid'] != rid:
+                for j in self.model.jobs:
+                    if j['rid'] == rid:
+                        job = j
+        if job is None:
+            raise Exception("找不到负荷预测方案内核运行的计算方案")
+        if job['rid'] != rid:
+            raise Exception("不是负荷预测方案内核运行生成算法的计算方案")
+        return self.run(job=job, name=name)
+    
+    def runIESPowerFlow(self,job=None,name=None, **kwargs)->Runner[IESResult]:
+        '''
+            运行 时序潮流方案 内核，如果当前 model 没有创建  Job 时报错，默认使用第一个计算方案，进行仿真。
+            
+            :param: job 计算方案名称，可选，字符串类型或者字典类型,默认使用第一个计算方案，如果同名使用最靠前一个
+            :params name:  任务名称，为空时使用项目的参数方案名称和计算方案名称
+
+            :return: runner Runner[IESResult]
+        '''
+        rid = 'function/CloudPSS/ieslab-power-flow'
+        if job is None:
+            currentJob = self.model.context['currentJob']
+            job = self.model.jobs[currentJob]
+            if job['rid'] != rid:
+                for j in self.model.jobs:
+                    if j['rid'] == rid:
+                        job = j
+        if job is None:
+            raise Exception("找不到时序潮流方案内核运行的计算方案")
+        if job['rid'] != rid:
+            raise Exception("不是时序潮流方案内核运行生成算法的计算方案")
+        return self.run(job=job, name=name)
+
+    def runIESEnergyStoragePlan(self,job=None,name=None, **kwargs)->Runner[IESResult]:
+        '''
+            运行 储能规划方案 内核，如果当前 model 没有创建  Job 时报错，默认使用第一个计算方案，进行仿真。
+            
+            :param: job 计算方案名称，可选，字符串类型或者字典类型,默认使用第一个计算方案，如果同名使用最靠前一个
+            :params name:  任务名称，为空时使用项目的参数方案名称和计算方案名称
+
+            :return: runner Runner[IESResult]
+        '''
+        rid = 'function/CloudPSS/ieslab-energy-storage-plan'
+        if job is None:
+            currentJob = self.model.context['currentJob']
+            job = self.model.jobs[currentJob]
+            if job['rid'] != rid:
+                for j in self.model.jobs:
+                    if j['rid'] == rid:
+                        job = j
+        if job is None:
+            raise Exception("找不到储能规划方案内核运行的计算方案")
+        if job['rid'] != rid:
+            raise Exception("不是储能规划方案内核运行生成算法的计算方案")
+        return self.run(job=job, name=name)
+
+    @staticmethod
+    def createProjectGroup(name, description=None, createById=None):
+        '''
+            创建项目组
+
+            :params name: String 项目组名称 
+            :params description: String 项目组描述 可选参数
+            :params createById Int 父项目组id  可选参数，如果是从已有项目组导入的项目组，必填此项
+
+            :return: Int 返回创建的项目组id
+        '''
+        try:
+            if createById is None: 
+                isImport = 0
+            else:
+                isImport = 1
+            payload = {
+                'name': name,
+                'description': description,
+                'isImport': isImport,
+                'createById': createById,
+            }
+            r = request(
+                'POST', 'api/dslab/rest/group', data=json.dumps(payload))
+            if r.ok:
+                r = request('GET', 'api/dslab/rest/group')
+                groupList = json.loads(r.text)
+                id = groupList[len(groupList) -1].get('id', None)
+                return id
+        except Exception as e:
+            raise Exception('创建项目组失败')
+        
+    @staticmethod
+    def createProject(name, gid, description=None, initialTerm=None, build=None, operate=None, yearsInOperation=None):
+        '''
+            创建项目
+
+            :params name: String 项目名称 
+            :params gid: Int 父项目组id,
+            :params description: String 项目描述, 可选参数
+            :params initialTerm: String 项目起始年限，可选参数
+            :params build: String 项目建设期（年），可选参数
+            :params operate: String 项目生命周期（年），可选参数
+            :params yearsInOperation: String 已投运年限，可选参数
+
+            :return: Int 返回创建的项目id
+        '''
+        try:
+            payload = {
+                'name': name,
+                'gid': gid,
+                'description': description,
+                'config': {
+                    'initialTerm': initialTerm,
+                    'build': build,
+                    'operate': operate,
+                    'yearsInOperation': yearsInOperation,
+                }
+            }
+            r = request(
+                'POST', 'api/dslab/rest/simulation', data=json.dumps(payload))
+            project = json.loads(r.text)
+            return project.get('resource', None)
+        except Exception as e:
+            raise Exception('创建项目失败')

cloudpss-4.5.1a1/cloudpss/dslab/files/__init__.py

@@ -0,0 +1,2 @@
+from .files import getCurveData
+__all__ = ['getCurveData']