gridappsd-python 2024.1.4a0__tar.gz → 2024.4.0a0__tar.gz

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gridappsd-python
-Version: 2024.1.4a0
+Version: 2024.4.0a0
 Summary: A GridAPPS-D Python Adapter
 Home-page: https://gridappsd.readthedocs.io
 License: BSD-3-Clause
@@ -203,9 +203,9 @@ integration tests available to be run.  In order to execute these, you must have
 as above with dev-dependencies.
 
 During the testing phase the docker containers required for the tests are downloaded from
-dockerhub and started.  By default the `develop` tag is used to test the library using pytest.  
+dockerhub and started.  By default the `develop` tag is used to test the library using pytest.
 One can customize the docker image tag by setting the environmental
-variable `GRIDAPPSD_TAG_ENV` either by `export GRIDAPPSD_TAG_ENV=other_tag` or by executing 
+variable `GRIDAPPSD_TAG_ENV` either by `export GRIDAPPSD_TAG_ENV=other_tag` or by executing
 pytest with the following:
 
 ```shell script
@@ -215,7 +215,7 @@ pytest with the following:
 export GRIDAPPSD_TAG_ENV=other_tag
 pytest
 
-# Tests also require the username and password to be avaialable as environmental variables 
+# Tests also require the username and password to be avaialable as environmental variables
 # in order for them to properly run these tests
 export GRIDAPPSD_USER=user
 export GRIDAPPSD_PASSWORD=pass
@@ -225,18 +225,18 @@ pytest
 
  ***NOTE: the first running the tests will download all of the docker images associated with the
  [GOSS-GridAPPS-D](http://github.com/GRIDAPPSD/GOSS-GridAPPS-D) repository.  This process may take some time.***
- 
+
 ### Running tests created in a new project
 
 The `gridappsd-python` library exposes a testing environment through the `gridappsd.docker_handler` module.  Including the following
 `conftest.py` in the root of your base test directory allows tests to reference these.  Using these fixtures will start all of the
-base containers required for `gridappsd` to run.  
+base containers required for `gridappsd` to run.
 
 ```python
 
 # conftest.py
-# Create a conftest.py file in the root of the tests directory to enable usage throughout the tests directory and below. 
-# 
+# Create a conftest.py file in the root of the tests directory to enable usage throughout the tests directory and below.
+#
 # Tested project structure an layout
 #
 # project-folder\
@@ -328,7 +328,7 @@ Using the above fixtures from inside a test module and test function looks like
 
 ```python
 
-# Example test function using the gridappsd_client fixture 
+# Example test function using the gridappsd_client fixture
 
 @mock.patch.dict(os.environ, {"GRIDAPPSD_APPLICATION_ID": "helics_goss_bridge.py"})
 def test_gridappsd_status(gridappsd_client):
@@ -351,4 +351,3 @@ def test_gridappsd_status(gridappsd_client):
     assert gappsd.get_application_status() == ProcessStatusEnum.COMPLETE.value
 ```
 
-

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/README.md

@@ -178,9 +178,9 @@ integration tests available to be run.  In order to execute these, you must have
 as above with dev-dependencies.
 
 During the testing phase the docker containers required for the tests are downloaded from
-dockerhub and started.  By default the `develop` tag is used to test the library using pytest.  
+dockerhub and started.  By default the `develop` tag is used to test the library using pytest.
 One can customize the docker image tag by setting the environmental
-variable `GRIDAPPSD_TAG_ENV` either by `export GRIDAPPSD_TAG_ENV=other_tag` or by executing 
+variable `GRIDAPPSD_TAG_ENV` either by `export GRIDAPPSD_TAG_ENV=other_tag` or by executing
 pytest with the following:
 
 ```shell script
@@ -190,7 +190,7 @@ pytest with the following:
 export GRIDAPPSD_TAG_ENV=other_tag
 pytest
 
-# Tests also require the username and password to be avaialable as environmental variables 
+# Tests also require the username and password to be avaialable as environmental variables
 # in order for them to properly run these tests
 export GRIDAPPSD_USER=user
 export GRIDAPPSD_PASSWORD=pass
@@ -200,18 +200,18 @@ pytest
 
  ***NOTE: the first running the tests will download all of the docker images associated with the
  [GOSS-GridAPPS-D](http://github.com/GRIDAPPSD/GOSS-GridAPPS-D) repository.  This process may take some time.***
- 
+
 ### Running tests created in a new project
 
 The `gridappsd-python` library exposes a testing environment through the `gridappsd.docker_handler` module.  Including the following
 `conftest.py` in the root of your base test directory allows tests to reference these.  Using these fixtures will start all of the
-base containers required for `gridappsd` to run.  
+base containers required for `gridappsd` to run.
 
 ```python
 
 # conftest.py
-# Create a conftest.py file in the root of the tests directory to enable usage throughout the tests directory and below. 
-# 
+# Create a conftest.py file in the root of the tests directory to enable usage throughout the tests directory and below.
+#
 # Tested project structure an layout
 #
 # project-folder\
@@ -303,7 +303,7 @@ Using the above fixtures from inside a test module and test function looks like
 
 ```python
 
-# Example test function using the gridappsd_client fixture 
+# Example test function using the gridappsd_client fixture
 
 @mock.patch.dict(os.environ, {"GRIDAPPSD_APPLICATION_ID": "helics_goss_bridge.py"})
 def test_gridappsd_status(gridappsd_client):
@@ -325,4 +325,3 @@ def test_gridappsd_status(gridappsd_client):
     assert gappsd.get_service_status() == ProcessStatusEnum.COMPLETE.value
     assert gappsd.get_application_status() == ProcessStatusEnum.COMPLETE.value
 ```
-

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/__init__.py

@@ -54,5 +54,3 @@ from gridappsd.gridappsd import GridAPPSD
 from gridappsd.difference_builder import DifferenceBuilder
 from gridappsd.app_registration import ApplicationController
 import gridappsd.json_extension as json
-
-

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/__main__.py

@@ -49,19 +49,21 @@ from gridappsd import GridAPPSD
 
 assert sys.version_info >= (3, 6), "Minimum version is python 3.6"
 
-logging.basicConfig(stream=sys.stdout, level=logging.INFO,
+logging.basicConfig(stream=sys.stdout,
+                    level=logging.INFO,
                     format="'%(asctime)s: %(name)-20s - %(levelname)-6s - %(message)s")
 
 logging.getLogger('stomp.py').setLevel(logging.WARNING)
 _log = logging.getLogger("gridappsd.__main__")
 
-
 if __name__ == '__main__':
 
     parser = ArgumentParser()
 
     group = parser.add_mutually_exclusive_group(required=True)
-    group.add_argument("-s", "--run-simulation", type=argparse.FileType('r'),
+    group.add_argument("-s",
+                       "--run-simulation",
+                       type=argparse.FileType('r'),
                        help="Start running a simulation from a passed simulation file.")
 
     opts = parser.parse_args()

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/app_registration.py

@@ -13,8 +13,8 @@ import shlex
 import sys
 import os
 
-from . gridappsd import GridAPPSD
-from . topics import REQUEST_REGISTER_APP
+from .gridappsd import GridAPPSD
+from .topics import REQUEST_REGISTER_APP
 from . import utils, json_extension as json
 
 _log = logging.getLogger(__name__)
@@ -26,6 +26,7 @@ if os.name == 'posix':
 
 
 class Job(threading.Thread):
+
     def __init__(self, args, out=sys.stdout, err=sys.stderr):
         threading.Thread.__init__(self)
         _log.debug("Creating job")
@@ -42,10 +43,7 @@ class Job(threading.Thread):
             self.running = True
             os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'RUNNING'
 
-            p = subprocess.Popen(args=self._args,
-                                 shell=False,
-                                 stdout=self._out,
-                                 stderr=self._err)
+            p = subprocess.Popen(args=self._args, shell=False, stdout=self._out, stderr=self._err)
 
             # Loop while process is executing
             while p.poll() is None and self.running:
@@ -112,13 +110,10 @@ class ApplicationController(object):
         return self._heartbeat_thread is not None
 
     def register_app(self, end_callback):
-        print("Sending {}\n\tto {}".format(self._configDict,
-                                           REQUEST_REGISTER_APP))
+        print("Sending {}\n\tto {}".format(self._configDict, REQUEST_REGISTER_APP))
         self._gapd.get_logger().debug("Started App Registration")
 
-        response = self._gapd.get_response(REQUEST_REGISTER_APP,
-                                           self._configDict,
-                                           60)
+        response = self._gapd.get_response(REQUEST_REGISTER_APP, self._configDict, 60)
         if 'message' in response:
             _log.error("An error regisering the application occured")
             _log.error(response.get('message'))
@@ -156,7 +151,8 @@ class ApplicationController(object):
                 # print("Seanding heartbeat {} {}".format(self._heartbeat_topic, self._application_id))
                 # print("Heartbeat period: {}".format(self._heartbeat_period))
                 self._gapd.send(self._heartbeat_topic, self._application_id)
-                time.sleep(self._heartbeat_period - ((time.time() - starttime) % self._heartbeat_period))
+                time.sleep(self._heartbeat_period -
+                           ((time.time() - starttime) % self._heartbeat_period))
         except:
             error_callback()
 

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/difference_builder.py

@@ -70,7 +70,7 @@ class DifferenceBuilder(object):
         self._forward = []
         self._reverse = []
 
-    def get_message(self, epoch = None):
+    def get_message(self, epoch=None):
         if epoch is None:
             epoch = calendar.timegm(time.gmtime())
         msg = dict(command="update",

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/goss.py

@@ -37,7 +37,6 @@
 # PACIFIC NORTHWEST NATIONAL LABORATORY operated by BATTELLE for the
 # UNITED STATES DEPARTMENT OF ENERGY under Contract DE-AC05-76RL01830
 # -------------------------------------------------------------------------------
-
 """
 Created on March 1, 2018
 
@@ -81,10 +80,14 @@ class GOSS(object):
     """ Base class providing connections to a GOSS instance via stomp protocol
     """
 
-    def __init__(self, username=None, password=None,
-                 stomp_address='localhost', stomp_port='61613',
+    def __init__(self,
+                 username=None,
+                 password=None,
+                 stomp_address='localhost',
+                 stomp_port='61613',
                  attempt_connection=True,
-                 override_threading=None, stomp_log_level=logging.WARNING,
+                 override_threading=None,
+                 stomp_log_level=logging.WARNING,
                  goss_log_level=logging.INFO):
 
         logging.getLogger('stomp.py').setLevel(stomp_log_level)
@@ -146,27 +149,31 @@ class GOSS(object):
         if isinstance(message, list) or isinstance(message, dict):
             message = json.dumps(message)
         _log.debug("Sending topic: {} body: {}".format(topic, message))
-        self._conn.send(body=message, destination=topic,
-                        headers={'GOSS_HAS_SUBJECT': True,
-                                  'GOSS_SUBJECT': self.__token})
-                                 
+        self._conn.send(body=message,
+                        destination=topic,
+                        headers={
+                            'GOSS_HAS_SUBJECT': True,
+                            'GOSS_SUBJECT': self.__token
+                        })
+
     def get_response(self, topic, message, timeout=5):
-        id = datetime.now().strftime("%Y%m%d%h%M%S")
+        id = datetime.now().strftime("%Y%m%d%h%M%S%f")[:-3]
         reply_to = "/temp-queue/response.{}".format(id)
-        
+
         if isinstance(message, str):
             message = json.loads(message)
-        
+
         if 'resultFormat' in message:
-            self.result_format = message['resultFormat'] 
+            self.result_format = message['resultFormat']
 
         # Change message to string if we have a dictionary.
         if isinstance(message, dict):
             message = json.dumps(message)
         elif isinstance(message, list):
             message = json.dumps(message)
-            
+
         class ResponseListener(object):
+
             def __init__(self, topic, result_format):
                 self.response = None
                 self._topic = topic
@@ -181,7 +188,7 @@ class GOSS(object):
                             self.response = message
                         else:
                             self.response = json.loads(message)
-                    else:   
+                    else:
                         self.response = message
                 except ValueError:
                     self.response = dict(error="Invalid json returned",
@@ -198,9 +205,13 @@ class GOSS(object):
         listener = ResponseListener(reply_to, self.result_format)
         self.subscribe(reply_to, listener)
 
-        self._conn.send(body=message, destination=topic,
-                        headers={'reply-to': reply_to, 'GOSS_HAS_SUBJECT': True,
-                                 'GOSS_SUBJECT': self.__token})
+        self._conn.send(body=message,
+                        destination=topic,
+                        headers={
+                            'reply-to': reply_to,
+                            'GOSS_HAS_SUBJECT': True,
+                            'GOSS_SUBJECT': self.__token
+                        })
         count = 0
 
         while count < timeout:
@@ -282,7 +293,7 @@ class GOSS(object):
 
                 # get token
                 # get initial connection
-                dt=datetime.now()
+                dt = datetime.now()
                 replyDest = f"temp.token_resp.{self.__user__}-{dt}"
 
                 # create token request string
@@ -297,8 +308,9 @@ class GOSS(object):
                 if self._override_thread_fc is not None:
                     tmpConn.transport.override_threading(self._override_thread_fc)
                 tmpConn.connect(self.__user__, self.__pass__, wait=True)
-                
+
                 class TokenResponseListener():
+
                     def __init__(self):
                         self.__token = None
 
@@ -307,7 +319,7 @@ class GOSS(object):
 
                     def on_message(self, header, message):
                         _log.debug("Internal on message is: {} {}".format(header, message))
-                        
+
                         self.__token = str(message)
 
                     def on_error(self, headers, message):
@@ -322,9 +334,10 @@ class GOSS(object):
                 listener = TokenResponseListener()
 
                 # self.subscribe(replyDest, listener)
-                tmpConn.subscribe('/queue/'+replyDest, 123)
+                tmpConn.subscribe('/queue/' + replyDest, 123)
                 tmpConn.set_listener('token_resp', listener)
-                tmpConn.send(body=base64Str, destination=tokenTopic,
+                tmpConn.send(body=base64Str,
+                             destination=tokenTopic,
                              headers={'reply-to': replyDest})
                 # while token is null or for x iterations
                 iter = 0

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/gridappsd.py

@@ -65,9 +65,9 @@ class InvalidSimulationIdError(Exception):
 class GridAPPSD(GOSS):
     """ The main :class:`GridAPPSD` interface for connecting to a GridAPPSD instance
     """
+
     # TODO Get the caller from the traceback/inspect module.
-    def __init__(self, simulation_id=None,
-                 address=None, **kwargs):
+    def __init__(self, simulation_id=None, address=None, **kwargs):
 
         if address is None:
             address = utils.get_gridappsd_address()
@@ -78,10 +78,7 @@ class GridAPPSD(GOSS):
              'stomp_port' in kwargs and not 'stomp_address' in kwargs:
             raise ValueError("If stomp_address is specified the so should stomp_port")
 
-        super(GridAPPSD, self).__init__(
-            stomp_address=address[0],
-            stomp_port=address[1],
-            **kwargs)
+        super(GridAPPSD, self).__init__(stomp_address=address[0], stomp_port=address[1], **kwargs)
         self._houses = Houses(self)
         self._simulation_log_topic = None
         self._simulation_id = None
@@ -104,11 +101,11 @@ class GridAPPSD(GOSS):
 
     def get_houses(self) -> Houses:
         return self._houses
-    
+
     def get_simulation_id(self):
-        """ 
+        """
         Return the simulation_id given to the GridAPPSD instance
-        
+
         :return:
         """
         if not self._simulation_id:
@@ -116,7 +113,7 @@ class GridAPPSD(GOSS):
             if self._simulation_id:
                 self._simulation_log_topic = t.simulation_log_topic(self._simulation_id)
         return self._simulation_id
-    
+
     def set_application_status(self, status):
         """
         Set the application status.
@@ -125,8 +122,8 @@ class GridAPPSD(GOSS):
         try:
             self._process_status = ProcessStatusEnum(status)
         except ValueError:
-            self.get_logger().warning("Unsuccessful change of application status."
-                            + f"Valid statuses are {ProcessStatusEnum.__members__}.")
+            self.get_logger().warning("Unsuccessful change of application status." +
+                                      f"Valid statuses are {ProcessStatusEnum.__members__}.")
 
     def set_service_status(self, status):
         """
@@ -136,8 +133,8 @@ class GridAPPSD(GOSS):
         try:
             self._process_status = ProcessStatusEnum(status)
         except ValueError:
-            self.get_logger().warning("Unsuccessful change of service status."
-                                      + f"Valid statuses are {ProcessStatusEnum.__members__}.")
+            self.get_logger().warning("Unsuccessful change of service status." +
+                                      f"Valid statuses are {ProcessStatusEnum.__members__}.")
 
     def set_simulation_id(self, simulation_id):
         if simulation_id is None:
@@ -156,17 +153,17 @@ class GridAPPSD(GOSS):
 
     def get_application_id(self):
         return utils.get_gridappsd_application_id()
-    
+
     def get_service_status(self):
         """
         Return the service status
         :return:
         """
         return self._process_status.value
-    
+
     def query_object_types(self, model_id=None):
         """ Allows the caller to query the different object types.
-                
+
         :param model_id:
         :return:
         """
@@ -186,7 +183,7 @@ class GridAPPSD(GOSS):
     def query_model_info(self):
         payload = self._build_query_payload("QUERY_MODEL_INFO")
         return self.get_response(t.REQUEST_POWERGRID_DATA, payload, timeout=30)
-    
+
     def query_model(self, model_id=None, object_type=None, object_id=None, response_format='JSON'):
         args = {}
         if model_id is not None:
@@ -194,9 +191,9 @@ class GridAPPSD(GOSS):
         if object_type is not None:
             args["objectType"] = object_type
         if object_id is not None:
-            args["objectId"] = object_id   
+            args["objectId"] = object_id
         if response_format is not None:
-            args["resultFormat"] = response_format   
+            args["resultFormat"] = response_format
         payload = self._build_query_payload("QUERY_MODEL", **args)
         return self.get_response(t.REQUEST_POWERGRID_DATA, payload, timeout=30)
 
@@ -208,13 +205,13 @@ class GridAPPSD(GOSS):
             args["modelId"] = model_id
         payload = self._build_query_payload("QUERY_OBJECT", **args)
         return self.get_response(t.REQUEST_POWERGRID_DATA, payload, timeout=30)
-    
+
     def query_object_dictionary(self, model_id, object_type=None, object_id=None):
         if not model_id:
             raise ValueError("model_id is not specified.")
         if not object_id and not object_type:
             raise ValueError("No obejct_id or object_type specified.")
-        args={}
+        args = {}
         args["modelId"] = model_id
         if object_id is not None:
             args["objectId"] = object_id
@@ -235,9 +232,15 @@ class GridAPPSD(GOSS):
         request_topic = '.'.join((t.REQUEST_DATA, database_type))
         return self.get_response(request_topic, json.dumps(payload), timeout=timeout)
 
-    def get_platform_status(self, applications=True, services=True, appInstances=True, serviceInstances=True):
+    def get_platform_status(self,
+                            applications=True,
+                            services=True,
+                            appInstances=True,
+                            serviceInstances=True):
         _log.debug("Retrieving platform status from GridAPPSD")
-        msg = dict(appInstances=appInstances, applications=applications, services=services,
+        msg = dict(appInstances=appInstances,
+                   applications=applications,
+                   services=services,
                    serviceInstances=serviceInstances)
         return self.get_response(t.REQUEST_PLATFORM_STATUS, json.dumps(msg), timeout=30)
 
@@ -256,8 +259,7 @@ class GridAPPSD(GOSS):
 
     def send_status(self, status, topic, log_level=INFO):
         self.set_application_status(status)
-        status_message = self.build_message_json(self.get_application_status(),
-            "", log_level)
+        status_message = self.build_message_json(self.get_application_status(), "", log_level)
         self.send(topic, status_message)
 
     def build_message_json(self, status, message, log_level):
@@ -265,7 +267,7 @@ class GridAPPSD(GOSS):
         status_message = {
             "source": utils.get_gridappsd_application_id(),
             "processId": f"{self._simulation_id}",
-            "timestamp": int(time.mktime(t_now.timetuple()))*1000,
+            "timestamp": int(time.mktime(t_now.timetuple())) * 1000,
             "procesStatus": status,
             "logMessage": str(message),
             "logLevel": logging.getLevelName(log_level),
@@ -279,6 +281,3 @@ class GridAPPSD(GOSS):
         d = dict(requestType=request_type, resultFormat=response_format)
         d.update(**kwargs)
         return d
-
-
-

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/houses.py

@@ -1,18 +1,8 @@
 from collections import namedtuple
 
 house_keys = [
-    'name',
-    'parent',
-    'coolingSetpoint',
-    'coolingSystem',
-    'floorArea',
-    'heatingSetpoint',
-    'heatingSystem',
-    'hvacPowerFactor',
-    'numberOfStories',
-    'thermalIntegrity',
-    'id',
-    'fdrid'
+    'name', 'parent', 'coolingSetpoint', 'coolingSystem', 'floorArea', 'heatingSetpoint',
+    'heatingSystem', 'hvacPowerFactor', 'numberOfStories', 'thermalIntegrity', 'id', 'fdrid'
 ]
 House = namedtuple('House', house_keys)
 
@@ -21,7 +11,9 @@ House = namedtuple('House', house_keys)
 
 
 class Houses:
+
     class __SingltonHouses:
+
         def __init__(self, gappsd: 'GridAPPSD'):
             self._gappsd = gappsd
             self._houses = {}
@@ -38,8 +30,8 @@ class Houses:
             query = """# list houses - DistHouse
 PREFIX r:  <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
 PREFIX c:  <http://iec.ch/TC57/CIM100#>
-SELECT ?fdrname ?name ?parent ?coolingSetpoint ?coolingSystem ?floorArea ?heatingSetpoint ?heatingSystem ?hvacPowerFactor ?numberOfStories ?thermalIntegrity ?id ?fdrid 
-WHERE { 
+SELECT ?fdrname ?name ?parent ?coolingSetpoint ?coolingSystem ?floorArea ?heatingSetpoint ?heatingSystem ?hvacPowerFactor ?numberOfStories ?thermalIntegrity ?id ?fdrid
+WHERE {
 #	VALUES ?fdrid {"_9CE150A8-8CC5-A0F9-B67E-BBD8C79D3095"}  # R2 12.47 3
 #	VALUES ?fdrid {"_4F76A5F9-271D-9EB8-5E31-AA362D86F2C3"}  # 8500-node
 # VALUES ?fdrid {"_E407CBB6-8C8D-9BC9-589C-AB83FBF0826D"}  # 123 PV/Triplex
@@ -54,7 +46,7 @@ WHERE {
    OPTIONAL{?h c:House.heatingSetpoint ?heatingSetpoint.}
    OPTIONAL{?h c:House.hvacPowerFactor ?hvacPowerFactor.}
    ?h c:House.coolingSystem ?coolingSystemRaw.
-   	bind(strafter(str(?coolingSystemRaw),"HouseCooling.") as ?coolingSystem) 
+   	bind(strafter(str(?coolingSystemRaw),"HouseCooling.") as ?coolingSystem)
    ?h c:House.heatingSystem ?heatingSystemRaw.
    	bind(strafter(str(?heatingSystemRaw),"HouseHeating.") as ?heatingSystem)
    ?h c:House.thermalIntegrity ?thermalIntegrityRaw.
@@ -83,7 +75,6 @@ WHERE {
 
             self._houses[feeder] = houses
 
-
     instance = None
 
     def __init__(self, gappsd):
@@ -94,4 +85,3 @@ WHERE {
 
     def __getattr__(self, name):
         return getattr(self.instance, name)
-

gridappsd_python-2024.4.0a0/gridappsd/json_extension.py

@@ -0,0 +1,123 @@
+import dataclasses
+import json as _json
+from typing import Any, TextIO
+
+
+@dataclasses.dataclass
+class JsonComplex:
+    real: float
+    imag: float
+
+
+def jsonDecoderExtension(obj: Any):
+    rv = obj
+    if isinstance(obj, dict):
+        try:
+            complexInstance = JsonComplex(**obj)
+            rv = complex(complexInstance.real, complexInstance.imag)
+        except:
+            rv = obj
+    return rv
+
+
+class JsonEncoderExtension(_json.JSONEncoder):
+
+    def default(self, obj: Any) -> Any:
+        rv = None
+        if isinstance(obj, complex):
+            jsonComplexInstance = JsonComplex(real=obj.real, imag=obj.imag)
+            rv = dataclasses.asdict(jsonComplexInstance)
+        elif dataclasses.is_dataclass(obj):
+            rv = dataclasses.asdict(obj)
+        else:
+            rv = super().default(obj)
+        return rv
+
+
+def dump(data: Any,
+         fo: TextIO,
+         *,
+         skipkeys=False,
+         ensure_ascii=True,
+         check_circular=True,
+         allow_nan=True,
+         indent=None,
+         separators=None,
+         default=None,
+         sort_keys=False,
+         **kw):
+    rv = _json.dump(data,
+                    fo,
+                    skipkeys=skipkeys,
+                    ensure_ascii=ensure_ascii,
+                    check_circular=check_circular,
+                    allow_nan=allow_nan,
+                    cls=JsonEncoderExtension,
+                    indent=indent,
+                    separators=separators,
+                    default=default,
+                    sort_keys=sort_keys,
+                    **kw)
+
+
+def dumps(data: Any,
+          *,
+          skipkeys=False,
+          ensure_ascii=True,
+          check_circular=True,
+          allow_nan=True,
+          indent=None,
+          separators=None,
+          default=None,
+          sort_keys=False,
+          **kw) -> str:
+    rv = _json.dumps(data,
+                     skipkeys=skipkeys,
+                     ensure_ascii=ensure_ascii,
+                     check_circular=check_circular,
+                     allow_nan=allow_nan,
+                     cls=JsonEncoderExtension,
+                     indent=indent,
+                     separators=separators,
+                     default=default,
+                     sort_keys=sort_keys,
+                     **kw)
+    return rv
+
+
+def load(fo: TextIO,
+         *,
+         cls=None,
+         parse_float=None,
+         parse_int=None,
+         parse_constant=None,
+         object_pairs_hook=None,
+         **kw) -> Any:
+    rv = _json.load(fo,
+                    cls=cls,
+                    object_hook=jsonDecoderExtension,
+                    parse_float=parse_float,
+                    parse_int=parse_int,
+                    parse_constant=parse_constant,
+                    object_pairs_hook=object_pairs_hook,
+                    **kw)
+    return rv
+
+
+def loads(data: str,
+          *,
+          cls=None,
+          parse_float=None,
+          parse_int=None,
+          parse_constant=None,
+          object_pairs_hook=None,
+          **kw) -> Any:
+    rv = _json.loads(data,
+                     cls=cls,
+                     object_hook=jsonDecoderExtension,
+                     parse_float=parse_float,
+                     parse_int=parse_int,
+                     parse_constant=parse_constant,
+                     object_pairs_hook=object_pairs_hook,
+                     **kw)
+    return rv

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/loghandler.py

@@ -35,6 +35,7 @@ class Logger:
     """
     The `Logger` class handles logging to the main gridappsd server.
     """
+
     def __init__(self, gaps, level=INFO):
         self._gaps = gaps
         self._level = level
@@ -71,8 +72,9 @@ class Logger:
             raise AttributeError(f"Log level must be one of {[x for x in _levelToName.values()]}")
 
         if not process_identifier:
-            raise AttributeError(f"Must have GRIDAPPSD_APPLICATION_ID or GRIDAPPSD_SERVICE_ID or GRIDAPPSD_PROCESS_ID "
-                                 "set in os environments.")
+            raise AttributeError(
+                f"Must have GRIDAPPSD_APPLICATION_ID or GRIDAPPSD_SERVICE_ID or GRIDAPPSD_PROCESS_ID "
+                "set in os environments.")
         status = self._gaps.get_application_status()
         sim_id = self._gaps.get_simulation_id()
 
@@ -89,13 +91,12 @@ class Logger:
             "logLevel": _levelToName[level],
             "storeToDb": True
         }
-        
+
         gridappsd_log_level = os.getenv('GRIDAPPSD_LOG_LEVEL')
         if gridappsd_log_level == None:
             gridappsd_log_level = level
         else:
             gridappsd_log_level = _nameToLevel[gridappsd_log_level]
-            
+
         if level >= gridappsd_log_level:
             self._gaps.send(topic, status_message)
-

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/register_app.py

@@ -5,9 +5,11 @@ import time
 import stomp
 from gridappsd import ApplicationController, GridAPPSD, utils, json_extension as json
 
+
 def main():
     loglevel = logging.INFO
-    logging.basicConfig(stream=sys.stdout, level=loglevel,
+    logging.basicConfig(stream=sys.stdout,
+                        level=loglevel,
                         format="%(asctime)s - %(name)s;%(levelname)s|%(message)s",
                         datefmt="%Y-%m-%d %H:%M:%S")
     logging.getLogger('stomp.py').setLevel(logging.ERROR)
@@ -43,7 +45,7 @@ def main():
             if gap is None:
                 gap = GridAPPSD()
 
-        except ConnectionRefusedError:  # Python 3 specific error code
+        except ConnectionRefusedError:    # Python 3 specific error code
             _log.debug("Retry in 10 seconds")
             gap = appreg = None
             time.sleep(10)
@@ -57,6 +59,7 @@ def main():
             break
         else:
             if appreg is None:
+
                 def end_app():
                     sys.exit(0)
 
@@ -78,5 +81,3 @@ def main():
                     gap = None
 
             time.sleep(2)
-
-

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/simulation.py

@@ -56,6 +56,7 @@ class SimulationArgs(ConfigBase):
     timestep_frequency: str = "1000"
     timestep_increment: str = "1000"
     run_realtime: bool = True
+    pause_after_measurements: bool = False
     simulation_name: str = "ieee13nodeckt"
     power_flow_solver_method: str = "NR"
     model_creation_config: ModelCreationConfig = __default_model_creation_config__
@@ -120,12 +121,14 @@ class Simulation:
     add_onmeasurement_callback, add_oncomplete_callback or add_onstart_callback method respectively.
     """
 
-    def __init__(self, gapps: 'GridAPPSD',
-                 run_config: Union[Dict, SimulationConfig]):
-        assert type(
-            gapps).__name__ == 'GridAPPSD', "Must be an instance of GridAPPSD"
-
-        self._run_config = run_config
+    def __init__(self, gapps: 'GridAPPSD', run_config: Union[Dict, SimulationConfig]):
+        assert type(gapps).__name__ == 'GridAPPSD', "Must be an instance of GridAPPSD"
+        if isinstance(run_config, SimulationConfig):
+            self._run_config = run_config.asdict()
+        elif isinstance(run_config, dict):
+            self._run_config = run_config
+        else:
+            raise TypeError("run_config must be a dictionary or a SimulationConfig")
         # if isinstance(run_config, SimulationConfig):
         #     self._run_config = run_config
         # else:
@@ -157,8 +160,7 @@ class Simulation:
         self._log_count = 0
         self._platform_log_count = 0
 
-        self._num_timesteps = round(
-            float(self._run_config["simulation_config"]["duration"]))
+        self._num_timesteps = round(float(self._run_config["simulation_config"]["duration"]))
 
         # self._num_timesteps = round(
         #     float(self._run_config.simulation_config.duration))
@@ -171,9 +173,7 @@ class Simulation:
     def start_simulation(self, timeout=30):
         """ Start the configured simulation by calling the REQUEST_SIMULATION endpoint.
         """
-        resp = self._gapps.get_response(t.REQUEST_SIMULATION,
-                                        self._run_config,
-                                        timeout=timeout)
+        resp = self._gapps.get_response(t.REQUEST_SIMULATION, self._run_config, timeout=timeout)
 
         if 'simulationId' not in resp:
             message = "Simulation was not able to run\n" + str(resp)
@@ -184,10 +184,8 @@ class Simulation:
 
         # Subscribe to the different components necessary to run and receive
         # simulated measurements and messages.
-        self._gapps.subscribe(t.simulation_log_topic(self.simulation_id),
-                              self.__on_simulation_log)
-        self._gapps.subscribe(t.simulation_output_topic(self.simulation_id),
-                              self.__onmeasurement)
+        self._gapps.subscribe(t.simulation_log_topic(self.simulation_id), self.__on_simulation_log)
+        self._gapps.subscribe(t.simulation_output_topic(self.simulation_id), self.__onmeasurement)
         self._gapps.subscribe(t.platform_log_topic(), self.__on_platformlog)
 
         for p in self.__on_start:
@@ -197,24 +195,21 @@ class Simulation:
         """ Pause simulation"""
         _log.debug("Pausing simulation")
         command = dict(command="pause")
-        self._gapps.send(t.simulation_input_topic(self.simulation_id),
-                         json.dumps(command))
+        self._gapps.send(t.simulation_input_topic(self.simulation_id), json.dumps(command))
         self._running_or_paused = True
 
     def stop(self):
         """ Stop the simulation"""
         _log.debug("Stopping simulation")
         command = dict(command="stop")
-        self._gapps.send(t.simulation_input_topic(self.simulation_id),
-                         json.dumps(command))
+        self._gapps.send(t.simulation_input_topic(self.simulation_id), json.dumps(command))
         self._running_or_paused = True
 
     def resume(self):
         """ Resume the simulation"""
         _log.debug("Resuming simulation")
         command = dict(command="resume")
-        self._gapps.send(t.simulation_input_topic(self.simulation_id),
-                         json.dumps(command))
+        self._gapps.send(t.simulation_input_topic(self.simulation_id), json.dumps(command))
         self._running_or_paused = True
 
     def run_loop(self):
@@ -242,14 +237,12 @@ class Simulation:
 
     def resume_pause_at(self, pause_in):
         """ Resume the simulation and have it automatically pause after specified amount of seconds later.
-        
+
         :param pause_in: number of seconds to run before pausing the simulation
         """
-        _log.debug("Resuming simulation. Will pause after {} seconds".format(
-            pause_in))
+        _log.debug("Resuming simulation. Will pause after {} seconds".format(pause_in))
         command = dict(command="resumePauseAt", input=dict(pauseIn=pause_in))
-        self._gapps.send(t.simulation_input_topic(self.simulation_id),
-                         json.dumps(command))
+        self._gapps.send(t.simulation_input_topic(self.simulation_id), json.dumps(command))
         self._running_or_paused = True
 
     def add_onmeasurement_callback(self, callback, device_filter=()):
@@ -271,8 +264,7 @@ class Simulation:
         :param device_filter: Future filter of measurements
         :return:
         """
-        self.__filterable_measurement_callback_set.add(
-            (callback, device_filter))
+        self.__filterable_measurement_callback_set.add((callback, device_filter))
 
     def add_onstart_callback(self, callback):
         """ registers a start callback that is called when the simulation is started
@@ -361,4 +353,4 @@ if __name__ == '__main__':
 
     print(psc.asjson())
     print(sim.asjson())
-    pprint(json.loads(sim.asjson()), indent=2)
+    pprint(json.loads(sim.asjson()), indent=2)

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/timeseries.py

@@ -3,11 +3,10 @@ from gridappsd import topics, json_extension as json
 from typing import Optional
 
 
-
 class Query:
     """ Class to create and execute request to query timeseries data
     """
-    
+
     def __init__(self, measurement):
         self.queryMeasurement = measurement
         self.queryFilter = []
@@ -16,11 +15,11 @@ class Query:
 
     def select(self, *keys):
         """ Defines what fields should be returned from the query.
-        
-        If this function is not called or is called without argument then 
+
+        If this function is not called or is called without argument then
         all the fields are returned.
-        
-        :param keys: list of fields to be returned 
+
+        :param keys: list of fields to be returned
         """
         for key in keys:
             self.selectCriteria.append(key)
@@ -28,78 +27,79 @@ class Query:
 
     def first(self, n=Optional[int]):
         """ Method to add request to return first or oldest data to the query.
-        
+
         When n is specified, query will return first or oldest 'n' rows.
-        
-        :param n:  
+
+        :param n:
         """
         if n is not None:
-            self.first = n;
+            self.first = n
         return self
 
     def last(self, n=Optional[int]):
         """ Method to add request to return last or latest data to the query.
-        
+
         When n is specified, query will return last or latest 'n' rows.
-        
-        :param n:  
+
+        :param n:
         """
         if n is not None:
-            self.last = n;
+            self.last = n
         return self
-    
+
     def ge(self, value):
         """ Method to add 'value greater than or equal to' filter to a key.
-        
-        :param value:  
+
+        :param value:
         """
         if self.key is None:
             raise ValueError("Key is not specified. Call where_key first.")
-        obj = {"key":self.key,"ge":value}
+        obj = {"key": self.key, "ge": value}
         self.queryFilter.append(obj)
         return self
-    
+
     def le(self, value):
         """ Method to add 'value less than or equal to' filter to a key.
-        
-        :param value:  
+
+        :param value:
         """
         if self.key is None:
             raise ValueError("Key is not specified. Call where_key first.")
-        obj = {"key":self.key,"le":value}
+        obj = {"key": self.key, "le": value}
         self.queryFilter.append(obj)
         return self
-    
+
     def eq(self, value):
         """ Method to add 'value equal to' filter to a key.
-        
-        :param value:  
+
+        :param value:
         """
         if self.key is None:
             raise ValueError("Key is not specified. Call where_key first.")
-        obj = {"key":self.key,"eq":value}
+        obj = {"key": self.key, "eq": value}
         self.queryFilter.append(obj)
         return self
-    
+
     def between(self, value1, value2):
         """ Method to add 'value between' value1 and value2 filter to a key.
-        
+
         :param value1: defines 'greater than equal to' filter for key's value
         :param value2: defines 'less than equal to' filter for key's value
         """
         if self.key is None:
             raise ValueError("Key is not specified. Call where_key first.")
-        obj = {"key":self.key,"ge":value1}
+        obj = {"key": self.key, "ge": value1}
         self.queryFilter.append(obj)
-        obj = {"key":self.key,"le":value2}
+        obj = {"key": self.key, "le": value2}
         self.queryFilter.append(obj)
         return self
-    
+
     def where_key(self, key):
         self.key = key
         return self
 
     def execute(self, gridappsd_obj):
-        del self.key 
-        response = gridappsd_obj.get_response(topics.REQUEST_TIMESERIES_DATA, json.dumps(self.__dict__))
-        return response
+        del self.key
+        response = gridappsd_obj.get_response(topics.REQUEST_TIMESERIES_DATA,
+                                              json.dumps(self.__dict__))
+        return response

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/topics.py

@@ -73,6 +73,7 @@ REQUEST_REGISTER_APP = ".".join((PROCESS_PREFIX, "request.app.remote.register"))
 REQUEST_APP_START = ".".join((PROCESS_PREFIX, "request.app.start"))
 BASE_APPLICATION_HEARTBEAT = ".".join((BASE_TOPIC_PREFIX, "heartbeat"))
 
+
 def platform_log_topic():
     """ Utility method for getting the platform.log base topic
     """
@@ -175,7 +176,8 @@ def simulation_log_topic(simulation_id):
     """
     return "{}.{}".format(BASE_SIMULATION_LOG_TOPIC, simulation_id)
 
-def field_message_bus_topic(message_bus_id:str, app_id: str=None, agent_id: str=None):
+
+def field_message_bus_topic(message_bus_id: str, app_id: str = None, agent_id: str = None):
     """ Utility method for getting the publish/subscribe topic for a specific message bus.
 
     :param message_bus_id:
@@ -185,7 +187,7 @@ def field_message_bus_topic(message_bus_id:str, app_id: str=None, agent_id: str=
     """
     assert message_bus_id, "message_bus_id cannot be empty"
 
-    return f"{BASE_FIELD_TOPIC}.{message_bus_id}" 
+    return f"{BASE_FIELD_TOPIC}.{message_bus_id}"
 
 
 def field_message_bus_app_topic(message_bus_id, app_id=None):
@@ -198,6 +200,7 @@ def field_message_bus_app_topic(message_bus_id, app_id=None):
     assert message_bus_id, "message_bus_id cannot be empty"
     return "{}.{}.{}".format(BASE_FIELD_TOPIC, message_bus_id, app_id)
 
+
 def field_message_bus_agent_topic(message_bus_id, agent_id=None):
     """ Utility method for getting the publish/subscribe topic for a specific message bus.
 
@@ -208,6 +211,7 @@ def field_message_bus_agent_topic(message_bus_id, agent_id=None):
     assert message_bus_id, "message_bus_id cannot be empty"
     return "{}.{}.{}".format(BASE_FIELD_TOPIC, message_bus_id, agent_id)
 
+
 def field_agent_request_queue(message_bus_id, agent_id):
     """ Utility method for getting the request topic for a specific distributed agent
 
@@ -218,6 +222,7 @@ def field_agent_request_queue(message_bus_id, agent_id):
     assert message_bus_id, "message_bus_id cannot be empty"
     return "{}.request.{}.{}".format(BASE_FIELD_QUEUE, message_bus_id, agent_id)
 
+
 def context_request_queue(message_bus_id):
     """ Utility method for getting the request topic for context manager
 
@@ -225,35 +230,40 @@ def context_request_queue(message_bus_id):
     :return:
     """
     assert message_bus_id, "message_bus_id cannot be empty"
-    
-    return "{}.request.{}.{}".format(BASE_FIELD_QUEUE, message_bus_id, message_bus_id+'.context_manager')
+
+    return "{}.request.{}.{}".format(BASE_FIELD_QUEUE, message_bus_id,
+                                     message_bus_id + '.context_manager')
+
 
 def field_output_topic(message_bus_id=None, simulation_id=None):
     """ Utility method for getting the field output topic.
     If message_bus_id is None, it returns topic used by centralized device interfaces to publish measurements.
-    If message_bus_id is not None, it returns topic used by distributed devices interfaces to publish measurements which is then subscribed by distributed agents. 
-    
+    If message_bus_id is not None, it returns topic used by distributed devices interfaces to publish measurements which is then subscribed by distributed agents.
+
     :param message_bus_id:
     :param simulation_id
-    :return: str: Topic to receive field measurements 
+    :return: str: Topic to receive field measurements
     """
-    
+
     if simulation_id is None:
         return "{}.{}".format(BASE_FIELD_TOPIC, "output")
     else:
-        return "{}.{}.{}.{}".format(BASE_FIELD_TOPIC,"simulation.output",simulation_id,message_bus_id)
-    
+        return "{}.{}.{}.{}".format(BASE_FIELD_TOPIC, "simulation.output", simulation_id,
+                                    message_bus_id)
+
+
 def field_input_topic(message_bus_id=None, simulation_id=None):
     """ Utility method for getting the field input topic.
     If message_bus_id is None, it returns topic used by centralized device interfaces to subscribe to control commands.
-    If message_bus_id is not None, it returns topic used by distributed devices interfaces to subscribe to control commands. 
-    
+    If message_bus_id is not None, it returns topic used by distributed devices interfaces to subscribe to control commands.
+
     :param message_bus_id:
     :param simulation_id
-    :return: str: Topic to receive input control commands 
+    :return: str: Topic to receive input control commands
     """
-    
+
     if simulation_id is None:
         return "{}.{}".format(BASE_FIELD_TOPIC, "input")
     else:
-        return "{}.{}.{}.{}".format(BASE_FIELD_TOPIC,"simulation.input",simulation_id,message_bus_id)
+        return "{}.{}.{}.{}".format(BASE_FIELD_TOPIC, "simulation.input", simulation_id,
+                                    message_bus_id)

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/gridappsd/utils.py

@@ -4,12 +4,11 @@ from typing import Optional
 
 from dateutil import parser
 import os
-try: # python2.7
+try:    # python2.7
     from urlparse import urlparse
 except ImportError:
     from urllib.parse import urlparse
 
-
 __GRIDAPPSD_URI__ = os.environ.get("GRIDAPPSD_URI", "localhost:61613")
 
 if not __GRIDAPPSD_URI__.startswith("tcp://"):
@@ -68,8 +67,7 @@ def get_gridappsd_address():
 
         return address, port
 
-    return (__GRIDAPPSD_URI_PARSED__.hostname,
-            __GRIDAPPSD_URI_PARSED__.port)
+    return (__GRIDAPPSD_URI_PARSED__.hostname, __GRIDAPPSD_URI_PARSED__.port)
 
 
 def get_gridappsd_application_id():

{gridappsd_python-2024.1.4a0 → gridappsd_python-2024.4.0a0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gridappsd-python"
-version = "2024.1.4a0"
+version = "2024.4.0a0"
 description = "A GridAPPS-D Python Adapter"
 authors = [
     "C. Allwardt <3979063+craig8@users.noreply.github.com>",
@@ -56,7 +56,7 @@ ignore_patterns = [
     "dist/**",
     "docs/**"
 ]
- 
+
 [tool.yapf]
 based_on_style = "pep8"
 spaces_before_comment = 4

gridappsd_python-2024.1.4a0/gridappsd/json_extension.py

@@ -1,55 +0,0 @@
-import dataclasses
-import json as _json
-from typing import Any, TextIO
-
-
-@dataclasses.dataclass
-class JsonComplex:
-    real: float
-    imag: float
-
-
-def jsonDecoderExtension(obj: Any):
-    rv = obj
-    if isinstance(obj, dict):
-        try:
-            complexInstance = JsonComplex(**obj)
-            rv = complex(complexInstance.real, complexInstance.imag)
-        except:
-            rv = obj
-    return rv
-
-
-class JsonEncoderExtension(_json.JSONEncoder):
-    def default(self, obj: Any) -> Any:
-        rv = None
-        if isinstance(obj, complex):
-            jsonComplexInstance = JsonComplex(
-                real = obj.real,
-                imag = obj.imag
-            )
-            rv = dataclasses.asdict(jsonComplexInstance)
-        elif dataclasses.is_dataclass(obj):
-            rv = dataclasses.asdict(obj)
-        else:
-            rv = super().default(obj)
-        return rv
-
-
-def dump(data: Any, fo: TextIO):
-    rv = _json.dump(data, fo, cls=JsonEncoderExtension)
-
-
-def dumps(data: Any) -> str:
-    rv = _json.dumps(data, cls=JsonEncoderExtension)
-    return rv
-
-
-def load(fo: TextIO) -> Any:
-    rv = _json.load(fo, object_hook=jsonDecoderExtension)
-    return rv
-
-
-def loads(data: str) -> Any:
-    rv = _json.loads(data, object_hook=jsonDecoderExtension)
-    return rv