add function allow PyCADI can be set in settings.json

Author: Qinghao Shi

fm_agent/fm_config.py

@@ -41,20 +41,28 @@ def get_all_configs (self):
         """ search every config for all the models in SETTINGS_FILE
             @return a dictionary for configs and models combination
         """
-
         all_config_dict={}
         for model in self.json_configs.keys():
             if model != "GLOBAL":
                 all_config_dict[model]=self.get_configs(model)
 
         return all_config_dict
-        
+
+    def get_PyCADI_path(self):
+        """ get the PyCADI path from the config file
+            @return PyCADI path if setting exist 
+            @return None if not exist
+        """
+        if "PyCADI_path" in self.json_configs["GLOBAL"][self.os]:
+            return self.json_configs["GLOBAL"][self.os]["PyCADI_path"]
+        else:
+            return None
+
     def get_model_lib(self,model_name):
         """ get the model lib path and name from the config file
-            @retrun full name and path to the model_lib
+            @return full name and path to the model_lib
             @return None if not exist
         """
-
         if model_name not in self.json_configs:
             return None
 
@@ -75,7 +83,6 @@ def get_configs (self,model_name):
             @return a dictionary of config_name:config_file for give model_name
             @return None if no config found
         """
-
         if model_name not in self.json_configs:
             return None
 
@@ -99,7 +106,6 @@ def parse_params_file (self, config_file , in_module=True):
             @return if config_file format is wrong, function will throw SimulatorError
             @return if config_file been parsed successfully, will return a dictionary of parameters 
         """
-
         if in_module:
             filepath = os.path.join( os.path.dirname(__file__) ,"configs" , config_file )
         else:

fm_agent/settings.json

@@ -1,6 +1,7 @@
 {
     "GLOBAL": {
         "Windows":{
+            "PyCADI_path": "C:\\Program Files\\ARM\\FastModelsPortfolio_11.4\\lib\\python27",
             "model_lib_path": "C:\\work\\model_libs",
             "configs": {
                 "DEFAULT": "DEFAULT.conf",
@@ -9,6 +10,7 @@
             }
         },
         "Linux":{
+            "PyCADI_path": "/home/user/ARM/FastModelsPortfolio_11.4/lib/python2.7/",
             "model_lib_path": "/home/user/model_libs",
             "configs": {
                 "DEFAULT": "DEFAULT.conf",

fm_agent/utils.py

@@ -52,8 +52,31 @@ def __prn_log(self, logger_level, text, timestamp=None):
         self.prn_txd = partial(__prn_log, self, 'TXD')
         self.prn_rxd = partial(__prn_log, self, 'RXD')    
 
+def get_PyCADI_path(self):
+    """ get the PyCADI path from the config file
+        @return PyCADI path if setting exist 
+        @return None if not exist
+    """
+    if "PyCADI_path" in self.json_configs["GLOBAL"]:
+        return self.json_configs["GLOBAL"][self.os]["PyCADI_path"]
+    else:
+        return None
+        
 def check_import():
     """ Append PVLIB_HOME to PATH, so import PyCADI fm.debug can be imported """
+    warning_msgs = []
+    from .fm_config import FastmodelConfig
+    config = FastmodelConfig()
+
+    fm_pycadi_path = config.get_PyCADI_path()
+    if fm_pycadi_path:
+        if os.path.exists(fm_pycadi_path):
+            sys.path.append(fm_pycadi_path)
+        else:
+            warning_msgs.append("Warning: Could not locate PyCADI_path '%s'" % fm_pycadi_path)
+    else:
+        warning_msgs.append("Warning: PyCADI_path not set in settings.json")
+    
     if 'PVLIB_HOME' in os.environ:
         #FastModels PyCADI have different folder on different host OS
         fm_pycadi_path1 = os.path.join(os.environ['PVLIB_HOME'], 'lib', 'python27')
@@ -63,13 +86,15 @@ def check_import():
         elif os.path.exists(fm_pycadi_path2):
             sys.path.append(fm_pycadi_path2)
         else:
-            print "Warning: Could not locate PyCADI in PVLIB_HOME/lib/python27"
+            warning_msgs.append("Warning: Could not locate PyCADI in PVLIB_HOME/lib/python27")
     else:
-        print "Warning: PVLIB_HOME not exist, check your fastmodel installation!"
+        warning_msgs.append("Warning: 'PVLIB_HOME' environment variable not been set.")
 
     try:
         import fm.debug
     except ImportError as e:
+        for warning in warning_msgs:
+            print warning
         print "Error: Failed to import fast models PyCADI!!!"
         return False
     else: