gridappsd-python 2025.3.2a13__tar.gz → 2025.3.2a17__tar.gz

gridappsd_python-2025.3.2a17/.gitignore

@@ -0,0 +1,123 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+poetry.lock
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# idea project
+.idea/
+
+# visual studio code
+.vscode/
+
+# pytest cache
+.pytest_cache
+/gridappsd-python.code-workspace
+.qodo
+
+# pixi
+.pixi/
+pixi.lock
+
+# uv
+uv.lock
+
+# ruff
+.ruff_cache/

{gridappsd_python-2025.3.2a13 → gridappsd_python-2025.3.2a17}/PKG-INFO

@@ -1,27 +1,20 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: gridappsd-python
-Version: 2025.3.2a13
+Version: 2025.3.2a17
 Summary: A GridAPPS-D Python Adapter
-License: BSD-3-Clause
-Keywords: gridappsd,grid,activemq,powergrid,simulation,library
-Author: C. Allwardt
-Author-email: 3979063+craig8@users.noreply.github.com
-Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: PyYAML (>=6.0,<7.0)
-Requires-Dist: dateutils (>=0.6.7,<0.7.0)
-Requires-Dist: dotenv (>=0.9.9,<0.10.0)
-Requires-Dist: loguru (>=0.7.3,<0.8.0)
-Requires-Dist: pytz (>=2022.7,<2023.0)
-Requires-Dist: requests (==2.28.2)
-Requires-Dist: stomp-py (==6.0.0)
-Project-URL: Homepage, https://gridappsd.readthedocs.io
 Project-URL: Repository, https://github.com/GRIDAPPSD/gridappsd-python
+Project-URL: Homepage, https://gridappsd.readthedocs.io
+Author-email: "C. Allwardt" <3979063+craig8@users.noreply.github.com>, "P. Sharma" <poorva.sharma@pnnl.gov>, "A. Fisher" <andrew.fisher@pnnl.gov>
+License-Expression: BSD-3-Clause
+Keywords: activemq,grid,gridappsd,library,powergrid,simulation
+Requires-Python: <4.0,>=3.10
+Requires-Dist: dateutils>=0.6.7
+Requires-Dist: loguru>=0.7
+Requires-Dist: python-dotenv>=0.9
+Requires-Dist: pytz>=2022.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.28
+Requires-Dist: stomp-py>=6.0.0
 Description-Content-Type: text/markdown
 
 [![Run All Pytests](https://github.com/GRIDAPPSD/gridappsd-python/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/GRIDAPPSD/gridappsd-python/actions/workflows/run-pytest.yml)
@@ -351,4 +344,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-2025.3.2a17/conf/entrypoint.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -eux
+
+# Install application python requirements
+for reqfile in `ls /gridappsd/services/*/requirements.txt 2>/dev/null`; do
+  echo "[Entrypoint] Installing requirements $reqfile"
+  sudo pip install -q --disable-pip-version-check -r $reqfile
+done
+for reqfile in `ls /gridappsd/applications/*/requirements.txt 2>/dev/null`; do
+  echo "[Entrypoint] Installing requirements $reqfile"
+  sudo pip install -q --disable-pip-version-check -r $reqfile
+done
+
+echo "[Entrypoint] Starting the platform"
+/startup/conf/run-gridappsd.sh
+
+tail -f /dev/null

gridappsd_python-2025.3.2a17/conf/run-gridappsd.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -eux
+
+# Setup the path for running the gridappsd framework
+export PATH=/gridappsd/services/fncsgossbridge/service:$PATH
+export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/usr/local/lib64
+
+cd /gridappsd
+
+# clean up log files
+if [ -d /gridappsd/log ]; then
+  /bin/rm -rf /gridappsd/log/* 2 > /dev/null
+fi
+cd /gridappsd
+java -Dgosh.args=--nointeractive -agentlib:jdwp=transport=dt_socket,server=y,suspend=n -jar lib/run.bnd.jar

gridappsd_python-2025.3.2a17/example.env

@@ -0,0 +1,4 @@
+GRIDAPPSD_USER=
+GRIDAPPSD_PASSWORD=
+GRIDAPPSD_ADDRESS = tcp://127.0.0.1:61613
+DATABASE = powergridmodel

{gridappsd_python-2025.3.2a13 → gridappsd_python-2025.3.2a17}/gridappsd/__init__.py

@@ -37,20 +37,21 @@
 # PACIFIC NORTHWEST NATIONAL LABORATORY operated by BATTELLE for the
 # UNITED STATES DEPARTMENT OF ENERGY under Contract DE-AC05-76RL01830
 # -------------------------------------------------------------------------------
-""" GridAPPSD Python Connection Library
+"""GridAPPSD Python Connection Library
 
 The :mod:`gridappsd` contains a connection class :class:`gridappsd.GridAPPSD` for connecting with the
 main GridAPPSD executable.
 
 """
+
 import pathlib
 import typing
 
 StrPath = typing.Union[str, pathlib.Path]
 
-from gridappsd.goss import GOSS
-from gridappsd.utils import ProcessStatusEnum
-from gridappsd.gridappsd import GridAPPSD
-from gridappsd.difference_builder import DifferenceBuilder
-from gridappsd.app_registration import ApplicationController
-import gridappsd.json_extension as json
+from gridappsd.goss import GOSS as GOSS
+from gridappsd.utils import ProcessStatusEnum as ProcessStatusEnum
+from gridappsd.gridappsd import GridAPPSD as GridAPPSD
+from gridappsd.difference_builder import DifferenceBuilder as DifferenceBuilder
+from gridappsd.app_registration import ApplicationController as ApplicationController
+from gridappsd import json_extension as json

{gridappsd_python-2025.3.2a13 → gridappsd_python-2025.3.2a17}/gridappsd/__main__.py

@@ -48,28 +48,30 @@ from dotenv import load_dotenv
 from pathlib import Path
 
 from gridappsd import GridAPPSD
+from gridappsd.simulation import Simulation
 
 assert sys.version_info >= (3, 10), "Minimum version is python 3.10"
 
-logging.basicConfig(stream=sys.stdout,
-                    level=logging.INFO,
-                    format="'%(asctime)s: %(name)-20s - %(levelname)-6s - %(message)s")
+logging.basicConfig(
+    stream=sys.stdout, level=logging.INFO, format="'%(asctime)s: %(name)-20s - %(levelname)-6s - %(message)s"
+)
 
-logging.getLogger('stomp.py').setLevel(logging.WARNING)
+logging.getLogger("stomp.py").setLevel(logging.WARNING)
 _log = logging.getLogger("gridappsd.__main__")
 
-if __name__ == '__main__':
-
+if __name__ == "__main__":
     parser = ArgumentParser()
 
     group = parser.add_mutually_exclusive_group(required=True)
-    group.add_argument("-s",
-                       "--run-simulation",
-                       type=argparse.FileType('r'),
-                       help="Start running a simulation from a passed simulation file.")
-    group.add_argument("--env", required=False, type=str,
-                       default=".env",
-                       help="Load environment variables from a .env file.")
+    group.add_argument(
+        "-s",
+        "--run-simulation",
+        type=argparse.FileType("r"),
+        help="Start running a simulation from a passed simulation file.",
+    )
+    group.add_argument(
+        "--env", required=False, type=str, default=".env", help="Load environment variables from a .env file."
+    )
     opts = parser.parse_args()
 
     if opts.run_simulation:
@@ -91,8 +93,6 @@ if __name__ == '__main__':
         gappsd = GridAPPSD()
         run_args = yaml.safe_load(opts.run_simulation)
 
-        # if wanting to use the above next_timestep function use this
-        # instead of the one below.
-        # simulation = gappsd.run_simulation(run_args, next_timestep)
-        simulation = gappsd.run_simulation(run_args)
-        simulation.simulation_main_loop()
+        # Create and start the simulation
+        simulation = Simulation(gappsd, run_args)
+        simulation.start_simulation()

{gridappsd_python-2025.3.2a13 → gridappsd_python-2025.3.2a17}/gridappsd/app_registration.py

@@ -1,17 +1,12 @@
-#import json
+# import json
 import logging
 import os
-try:
-    from queue import Queue
-except ImportError:
-    from Queue import Queue
+from queue import Queue
 import time
-import select
 import subprocess
 import threading
 import shlex
 import sys
-import os
 
 from .gridappsd import GridAPPSD
 from .topics import REQUEST_REGISTER_APP
@@ -21,12 +16,11 @@ _log = logging.getLogger(__name__)
 
 # determine OS type
 posix = False
-if os.name == 'posix':
+if os.name == "posix":
     posix = True
 
 
 class Job(threading.Thread):
-
     def __init__(self, args, out=sys.stdout, err=sys.stderr):
         threading.Thread.__init__(self)
         _log.debug("Creating job")
@@ -41,31 +35,30 @@ class Job(threading.Thread):
     def run(self):
         try:
             self.running = True
-            os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'RUNNING'
+            os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "RUNNING"
 
             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:
-                os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'RUNNING'
+                os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "RUNNING"
                 time.sleep(1)
 
         except Exception as e:
-            os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'ERROR'
+            os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "ERROR"
             _log.error(repr(e))
         else:
-            os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STOPPED'
+            os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STOPPED"
 
 
 class ApplicationController(object):
-
     def __init__(self, config, gridappsd=None, heatbeat_period=10):
         if not isinstance(config, dict):
             raise ValueError("Config should be dictionary")
         if not isinstance(gridappsd, GridAPPSD):
             raise ValueError("Invalid gridappsd instance passed.")
 
-        os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STOPPED'
+        os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STOPPED"
         self._configDict = config.copy()
         self._validate_config()
         self._gapd = gridappsd
@@ -87,15 +80,16 @@ class ApplicationController(object):
         self._end_callback = None
         self._print_queue = Queue()
         self._heartbeat_thread = None
-        os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STOPPED'
+        os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STOPPED"
 
-        if "type" not in self._configDict or self._configDict['type'] != 'REMOTE':
-            _log.warning('Setting type to REMOTE you can remove this error by putting '
-                         '"type": "REMOTE" in the app config file.')
-            self._configDict['type'] = 'REMOTE'
+        if "type" not in self._configDict or self._configDict["type"] != "REMOTE":
+            _log.warning(
+                'Setting type to REMOTE you can remove this error by putting "type": "REMOTE" in the app config file.'
+            )
+            self._configDict["type"] = "REMOTE"
 
     def _validate_config(self):
-        required = ['id', 'execution_path']
+        required = ["id", "execution_path"]
         missing = [x for x in required if x not in self._configDict]
 
         if missing:
@@ -114,30 +108,30 @@ class ApplicationController(object):
         self._gapd.get_logger().debug("Started App Registration")
 
         response = self._gapd.get_response(REQUEST_REGISTER_APP, self._configDict, 60)
-        if 'message' in response:
+        if "message" in response:
             _log.error("An error regisering the application occured")
-            _log.error(response.get('message'))
-            raise ValueError(response.get('message'))
-        self._application_id = response.get('applicationId')
-        self._heartbeat_topic = response.get('heartbeatTopic')
-        self._heartbeat_period = response.get('heartbeatPeriod', 10)
-        self._start_control_topic = response.get('startControlTopic')
-        self._stop_control_topic = response.get('stopControlTopic')
+            _log.error(response.get("message"))
+            raise ValueError(response.get("message"))
+        self._application_id = response.get("applicationId")
+        self._heartbeat_topic = response.get("heartbeatTopic")
+        self._heartbeat_period = response.get("heartbeatPeriod", 10)
+        self._start_control_topic = response.get("startControlTopic")
+        self._stop_control_topic = response.get("stopControlTopic")
 
         os.environ["GRIDAPPSD_APPLICATION_ID"] = self._application_id
-        os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STOPPED'
+        os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STOPPED"
 
         self._gapd.subscribe(self._stop_control_topic, self.__handle_stop)
         self._gapd.subscribe(self._start_control_topic, self.__handle_start)
         self._end_callback = end_callback
 
         # TODO assuming good response start the heartbeat
-        self._heartbeat_thread = threading.Thread(target=self.__start_heartbeat,
-                                                  args=[self.__heartbeat_error])
+        self._heartbeat_thread = threading.Thread(target=self.__start_heartbeat, args=[self.__heartbeat_error])
         self._heartbeat_thread.daemon = True
         self._heartbeat_thread.start()
-        self._gapd.get_logger().debug("Heartbeat registereed for application {}".format(
-            utils.get_gridappsd_application_id()))
+        self._gapd.get_logger().debug(
+            "Heartbeat registereed for application {}".format(utils.get_gridappsd_application_id())
+        )
 
     def __heartbeat_error(self):
         self._heartbeat_thread = None
@@ -151,8 +145,7 @@ 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()
 
@@ -167,15 +160,15 @@ class ApplicationController(object):
             obj = json.loads(message)
         else:
             obj = message
-        os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STARTING'
+        os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STARTING"
         self._gapd.get_logger().debug("Handling Start: {}\ndict:\n{}".format(headers, obj))
 
-        if 'command' not in obj:
+        if "command" not in obj:
             # Send log to gridappsd
             _log.error("Invalid message sent on start app.")
         else:
             _log.debug("CWD IS: {}".format(os.getcwd()))
-            args = shlex.split(obj['command'])
+            args = shlex.split(obj["command"])
             job = Job(args)
             job.daemon = True
             job.start()
@@ -183,12 +176,12 @@ class ApplicationController(object):
 
     def __handle_stop(self, headers, message):
         print("Handling Stop: {} {}".format(headers, message))
-        os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STOPPING'
+        os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STOPPING"
         if self._thread:
             self._thread.join()
         if self._end_callback is not None:
             self._end_callback()
-        os.environ['GRIDAPPSD_APPLICATION_STATUS'] = 'STOPPED'
+        os.environ["GRIDAPPSD_APPLICATION_STATUS"] = "STOPPED"
 
     def shutdown(self):
         self._shutting_down = True

{gridappsd_python-2025.3.2a13 → gridappsd_python-2025.3.2a17}/gridappsd/difference_builder.py

@@ -44,43 +44,46 @@ import time
 
 
 class DifferenceBuilder(object):
-    """ Automates the building of forward and reverse cim differences
-
-    """
+    """Automates the building of forward and reverse cim differences"""
 
     def __init__(self, simulation_id: str | int | None = None):
-
         self._simulation_id = simulation_id
         self._forward: list[dict] = []
         self._reverse: list[dict] = []
 
     def add_difference(self, object_id, attribute, forward_value, reverse_value):
-        """ Add forward and reverse unit for an object attribute.
+        """Add forward and reverse unit for an object attribute.
 
-         All of the parameters must be serializable for sending the GOSS message bus.
-         """
+        All of the parameters must be serializable for sending the GOSS message bus.
+        """
         forward = dict(object=object_id, attribute=attribute, value=forward_value)
         reverse = dict(object=object_id, attribute=attribute, value=reverse_value)
         self._forward.append(forward)
         self._reverse.append(reverse)
 
     def clear(self):
-        """ Clear the forward and reverse differences """
+        """Clear the forward and reverse differences"""
         self._forward = []
         self._reverse = []
 
     def get_message(self, epoch=None):
-        """ Get the message to send to the GOSS message bus
+        """Get the message to send to the GOSS message bus
 
         :param epoch: The epoch time to use for the message timestamp.  If None, the current time (GMT) is used.
         """
         if epoch is None:
             epoch = calendar.timegm(time.gmtime())
-        msg = dict(command="update",
-                   input=dict(message=dict(timestamp=epoch,
-                                           difference_mrid=str(uuid4()),
-                                           reverse_differences=self._reverse,
-                                           forward_differences=self._forward)))
+        msg = dict(
+            command="update",
+            input=dict(
+                message=dict(
+                    timestamp=epoch,
+                    difference_mrid=str(uuid4()),
+                    reverse_differences=self._reverse,
+                    forward_differences=self._forward,
+                )
+            ),
+        )
         if self._simulation_id is not None:
-            msg['input']['simulation_id'] = self._simulation_id
+            msg["input"]["simulation_id"] = self._simulation_id
         return msg.copy()

gridappsd_python-2025.3.2a17/gridappsd/field_interface/__init__.py

@@ -0,0 +1,52 @@
+import logging
+import sys
+import warnings
+
+_log = logging.getLogger(__name__)
+
+# These will be populated if gridappsd-field-bus is installed
+context = None
+context_managers = None
+agents = None
+field_proxy_forwarder = None
+gridappsd_field_bus = None
+interfaces = None
+
+try:
+    import gridappsd_field_bus.field_interface.context as _context
+    import gridappsd_field_bus.field_interface.context_managers as _context_managers
+    import gridappsd_field_bus.field_interface as _field_interface
+    import gridappsd_field_bus.field_interface.agents as _agents
+    import gridappsd_field_bus.field_interface.gridappsd_field_bus as _gridappsd_field_bus
+    import gridappsd_field_bus.field_interface.interfaces as _interfaces
+
+    # Expose as module attributes for `from gridappsd.field_interface import X` syntax
+    context = _context
+    context_managers = _context_managers
+    agents = _agents
+    gridappsd_field_bus = _gridappsd_field_bus
+    interfaces = _interfaces
+
+    # Also register in sys.modules for backwards compatibility
+    sys.modules["gridappsd.field_interface.interfaces"] = _interfaces
+    sys.modules["gridappsd.field_interface.context"] = _context
+    sys.modules["gridappsd.field_interface.context_managers"] = _context_managers
+    sys.modules["gridappsd.field_interface.agents"] = _agents
+    sys.modules["gridappsd.field_interface.gridappsd_field_bus"] = _gridappsd_field_bus
+
+    # field_proxy_forwarder has optional dependencies that may not be available
+    try:
+        import gridappsd_field_bus.field_interface.field_proxy_forwarder as _field_proxy_forwarder
+
+        field_proxy_forwarder = _field_proxy_forwarder
+        sys.modules["gridappsd.field_interface.field_proxy_forwarder"] = _field_proxy_forwarder
+    except ImportError:
+        _log.debug("field_proxy_forwarder not available (missing optional dependencies)")
+
+    warnings.warn(
+        message="gridappsd.field_interface is deprecated and will be removed in a future release. "
+        "Use gridappsd_field_bus.field_interface instead.",
+        category=DeprecationWarning,
+    )
+except ImportError as e:
+    _log.error(f"Could not import field_interface: {e}. Install gridappsd-field-bus to get those functions.")