redesign the architecture

separate model from simulation job.

Author: weilixu

BuildSimHubAPI/__pycache__/buildsimhub.cpython-36.pyc

@@ -1,6 +1,8 @@
 from BuildSimHubAPI.helpers import bldgsim_info
 from BuildSimHubAPI.helpers import simulationJob
 from BuildSimHubAPI.helpers import simulationType
+from BuildSimHubAPI.helpers import energyModel
+from BuildSimHubAPI.helpers import htmlResults
 
 class BuildSimHubAPIClient():
     """
@@ -33,3 +35,11 @@ def new_simulation_job(self, model_key):
     def get_simulation_type(self):
         st = simulationType.SimulationType()
         return st
+
+    def get_model(self, simulationJob):
+        modelKey = vars(simulationJob)['_trackToken']
+        model = energyModel.Model(self._userAPI,modelKey)
+        return model
+
+    def get_html(self, simulationJob):
+        html = htmlResults.HTMLResults(self._userAPI,simulaitonJob)

BuildSimHubAPI/buildsimhub.py

@@ -1,6 +1,6 @@
 import requests
 import json
-
+from .simulationJob import SimulationJob
 #This is a class that contains all the model information for user
 #to read
 
@@ -13,8 +13,8 @@ class Model():
 
     def __init__(self, userKey, modelKey):
         self._userKey = userKey
-        self._modelKey = modelKey
         self._lastParameterUnit = ""
+        self._modelKey = modelKey
 
     @property
     def lastParameterUnit(self):

BuildSimHubAPI/helpers/__pycache__/energyModel.cpython-36.pyc

@@ -0,0 +1,46 @@
+import requests
+import json
+from .simulationJob import SimulationJob
+
+#This is a class that contains all the model information for user
+#to read
+
+
+#potentially in the future, to write
+
+class HTMLResults():
+    #every call will connect to this base URL
+    BASE_URL = 'https://develop.buildsimhub.net/'
+
+    def __init__(self, userKey, simulationJob):
+        self._userKey = userKey
+        self._modelKey = simulationJob.modelKey
+        self._lastParameterUnit = ''
+
+    @property
+    def lastParameterUnit(self):
+        return self._lastParameterUnit
+
+    def request_numeric_value(self, report, table, column_name, row_name):
+        url = HTMLResults.BASE_URL + 'GetNumericValueFromHTML_API'
+        payload = {
+            'user_api_key': self._userKey,
+            'track_token': self._modelKey,
+            'report': report,
+            'table': table,
+            'column_name': column_name,
+            'row_name': row_name
+        }
+
+        r = request.get(url, params = payload)
+        resp_json = r.json()
+        if(resp_json['status']=='success'):
+            data = resp_json['data']
+            value = data['value']
+            if('unit' in data):
+                self._lastParameterUnit = data['unit']
+            else:
+                self._lastParameterUnit = ''
+            return value
+        else:
+            return -1

BuildSimHubAPI/helpers/__pycache__/htmlResults.cpython-36.pyc

@@ -1,17 +1,15 @@
 import requests
 import json
-from .energyModel import Model
 
 class SimulationJob():
     #every call will connect to this base URL
     BASE_URL = 'https://develop.buildsimhub.net/'
 
-    def __init__(self, userKey, folderkey):
+    def __init__(self, userKey, mk):
         self._userKey = userKey
-        self._folderKey = folderkey
+        self._modelKey = mk
         self._trackToken = ""
         self._trackStatus = "No simulation is running or completed in this Job - please start simulation using createModel method."
-        self._model = None
 
     @property
     def trackStatus(self):
@@ -21,14 +19,14 @@ def trackStatus(self):
     def trackToken(self):
         return self._trackToken
 
+    @property
+    def modelKey(self):
+        return self._modelKey
+
     @trackToken.setter
     def trackToken(self, value):
         self._trackToken = value
 
-    @property
-    def model(self):
-        return self._model
-
     def get_simulation_results(self, resultType="html"):
         if(self._trackToken == ""):
             return self._trackStatus
@@ -96,7 +94,7 @@ def create_model(self, file_dir, comment = "Upload through Python API", simulati
         url = SimulationJob.BASE_URL + 'CreateModel_API'
         payload = {
             'user_api_key': self._userKey,
-            'folder_api_key': self._folderKey,
+            'folder_api_key': self._modelKey,
             'comment': comment,
             'simulation_type': simulationType,
             'agents' : agent
@@ -105,15 +103,13 @@ def create_model(self, file_dir, comment = "Upload through Python API", simulati
         files={
             'file': open(file_dir, 'rb')
         }
-
+        
         r = requests.post(url, data=payload, files= files)
-
+        
         resp_json = r.json()
 
         if(resp_json['status'] == 'success'):
             self._trackToken = resp_json['tracking']
-            self._model = Model(self._userKey, self._trackToken)
-
             return resp_json['status']
         else:
             return resp_json['error_msg']