Merge pull request #4 from NACLab/configUpdates

Config updates

Author: ago109

ngcsimlib/__init__.py

@@ -1,44 +1,32 @@
-
 from . import utils
 from . import controller
 from . import commands
 from . import logger
 
-import argparse, os, warnings, json, logging
+import argparse, os, warnings, json
 from types import SimpleNamespace
 from pathlib import Path
 from sys import argv
 from importlib import import_module
-from ngcsimlib.configManager import GlobalConfig
+from ngcsimlib.configManager import init_config, get_config
 
 from pkg_resources import get_distribution
 
 __version__ = get_distribution('ngcsimlib').version  ## set software version
 
 
 ###### Preload Modules
-def preload():
-    parser = argparse.ArgumentParser(description='Build and run a model using ngclearn')
-    parser.add_argument("--modules", type=str, help='location of modules.json file')
-
-    ## ngc-sim-lib only cares about --modules argument
-    args, unknown = parser.parse_known_args()  # args = parser.parse_args()
-    try:
-        module_path = args.modules
-    except:
-        module_path = None
-
-    if module_path is None:
-        module_config = GlobalConfig.get_config("modules")
-        if module_config is None:
-            module_path = "json_files/modules.json"
-        else:
-            module_path = module_config.get("module_path", "json_files/modules.json")
+def preload_modules():
+    module_config = get_config("modules")
+    if module_config is None:
+        module_path = "json_files/modules.json"
+    else:
+        module_path = module_config.get("module_path", "json_files/modules.json")
 
     if not os.path.isfile(module_path):
         warnings.warn("\nMissing file to preload modules from. Attempted to locate file at \"" + str(module_path) +
                       "\". No modules will be preloaded. "
-    "\nSee https://ngc-learn.readthedocs.io/en/latest/tutorials/model_basics/json_modules.html for additional information")
+                      "\nSee https://ngc-learn.readthedocs.io/en/latest/tutorials/model_basics/json_modules.html for additional information")
         return
 
     with open(module_path, 'r') as file:
@@ -76,18 +64,16 @@ def configure():
     if not os.path.isfile(config_path):
         warnings.warn("\nMissing configuration file. Attempted to locate file at \"" + str(config_path) +
                       "\". Default Config will be used. "
-                      "\nSee PUT LINK HERE for additional information")
+                      "\nSee https://ngc-learn.readthedocs.io/en/latest/tutorials/model_basics/configuration.html for "
+                      "additional information")
         return
 
-    GlobalConfig.init_config(config_path)
-
 
+    init_config(config_path)
 
 
 if not Path(argv[0]).name == "sphinx-build" or Path(argv[0]).name == "build.py":
     if "readthedocs" not in argv[0]:  ## prevent readthedocs execution of preload
         configure()
         logger.init_logging()
-
-        preload()
-
+        preload_modules()

ngcsimlib/configManager.py

@@ -1,11 +1,12 @@
 """
 ngc libraries have a need for global level configuration which will all be
 handled here. It will also be possible to add custom configuration sections to
-this file with no issues or additional setup. However the main purpose of these
+this file with no issues or additional setup. However, the main purpose of these
 configurations are not control specific parts of the model but control ngc
 libraries at a high level.
 """
 import json
+from types import SimpleNamespace
 
 
 class ConfigManager:
@@ -25,5 +26,24 @@ def get_config(self, name):
 
         return self.loadedConfig.get(name, None)
 
+    def provide_namespace(self, configName):
+        config = self.get_config(configName)
+        if config is None:
+            return None
+        else:
+            return SimpleNamespace(**config)
+
+
+_GlobalConfig = ConfigManager()
+
+
+def init_config(path):
+    _GlobalConfig.init_config(path)
+
+
+def get_config(configName):
+    return _GlobalConfig.get_config(configName)
+
 
-GlobalConfig = ConfigManager()
+def provide_namespace(configName):
+    return _GlobalConfig.provide_namespace(configName)

ngcsimlib/logger.py

@@ -1,6 +1,6 @@
 import logging
 import sys
-from ngcsimlib.configManager import GlobalConfig
+from ngcsimlib.configManager import get_config
 
 def _concatArgs(*args, **kwargs):
     """Internal Decorator for concatenating arguments into a single string"""
@@ -19,7 +19,7 @@ def wrapped(*wargs, sep=" ", end="", **kwargs):
 
 
 def init_logging():
-    loggingConfig = GlobalConfig.get_config("logging")
+    loggingConfig = get_config("logging")
     if loggingConfig is None:
         loggingConfig = {"logging_file": None,
                          "logging_level": logging.WARNING,