nost-tools 2.1.1__tar.gz → 2.2.0__tar.gz

{nost_tools-2.1.1 → nost_tools-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nost_tools
-Version: 2.1.1
+Version: 2.2.0
 Summary: Tools for Novel Observing Strategies Testbed (NOS-T) Applications
 Author-email: "Paul T. Grogan" <paul.grogan@asu.edu>, "Emmanuel M. Gonzalez" <emmanuelgonzalez@asu.edu>
 License-Expression: BSD-3-Clause

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.1.1"
+__version__ = "2.2.0"
 
 from .application import Application
 from .application_utils import ConnectionConfig, ModeStatusObserver, TimeStatusPublisher

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools/application.py

@@ -239,7 +239,7 @@ class Application:
             self.config = config
             parameters = getattr(
                 self.config.rc.simulation_configuration.execution_parameters,
-                self.app_name,
+                "application",
                 None,
             )
             self.set_offset = parameters.set_offset

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools/application_utils.py

@@ -253,10 +253,9 @@ class ModeStatusObserver(Observer):
             if not isinstance(self.app.prefix, str):
                 raise ValueError(f"Exchange ({self.app.prefix}) must be a string")
 
-            # Declare the topic exchange
-            if self.app.channel.is_open and self.app.connection.is_open:
-                self.app.send_message(
-                    app_name=self.app.app_name,
-                    app_topics="status.mode",
-                    payload=status.model_dump_json(by_alias=True, exclude_none=True),
-                )
+            # if self.app.channel.is_open and self.app.connection.is_open:
+            self.app.send_message(
+                app_name=self.app.app_name,
+                app_topics="status.mode",
+                payload=status.model_dump_json(by_alias=True, exclude_none=True),
+            )

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools/configuration.py

@@ -25,6 +25,7 @@ from .schemas import (
 
 logger = logging.getLogger(__name__)
 
+
 class ConnectionConfig:
     """Connection configuration.
 
@@ -59,6 +60,7 @@ class ConnectionConfig:
         virtual_host: str = None,
         is_tls: bool = True,
         yaml_file: str = None,
+        app_name: str = None,
     ):
         """
         Initializes a new connection configuration.
@@ -75,6 +77,7 @@ class ConnectionConfig:
             virtual_host (str): RabbitMQ virtual host
             is_tls (bool): True, if the connection uses TLS
             yaml_file (str): Path to the YAML configuration file
+            app_name (str): Name of the application to get specific configuration for
         """
         self.username = username
         self.password = password
@@ -93,6 +96,8 @@ class ConnectionConfig:
         self.yaml_file = yaml_file
         self.unique_exchanges = {}
         self.channel_configs = []
+        self.app_name = app_name
+        self.app_specific = None
 
         self.create_connection_config()
 
@@ -208,6 +213,29 @@ class ConnectionConfig:
         except ValidationError as err:
             raise EnvironmentVariableError(f"Invalid environment variables: {err}")
 
+    def get_app_specific_config(self, app_name):
+        """
+        Get application-specific configuration from execution.managed_applications if available.
+
+        Args:
+            app_name (str): Name of the application
+
+        Returns:
+            dict: Application-specific configuration parameters if available, otherwise None.
+        """
+        if not os.path.exists(self.yaml_file):
+            raise ConfigurationError("Couldn't load config file (not found)")
+
+        with open(self.yaml_file, "r", encoding="utf-8") as f:
+            yaml_data = yaml.safe_load(f)
+
+            try:
+                return yaml_data["execution"]["managed_applications"][app_name][
+                    "configuration_parameters"
+                ]
+            except:
+                return None
+
     def load_yaml_config_file(self):
         """
         Loads a YAML configuration file and returns the parsed data.
@@ -243,6 +271,9 @@ class ConnectionConfig:
                 ), "Application names do not match the channels defined in the configuration file."
             except ConfigAssertionError as e:
                 raise ValueError(f"Assertion error: {e}")
+            # Load app-specific configuration if app_name is provided
+            if self.app_name:
+                self.app_specific = self.get_app_specific_config(self.app_name)
         else:
             try:
                 self.yaml_config = Config(
@@ -301,4 +332,5 @@ class ConnectionConfig:
             credentials=self.credentials_config,
             server_configuration=server_config,
             simulation_configuration=self.simulation_config,
+            application_configuration=self.app_specific,
         )

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools/manager.py

@@ -13,6 +13,7 @@ from typing import List
 from pydantic import ValidationError
 
 from .application import Application
+from .application_utils import ConnectionConfig
 from .schemas import (
     InitCommand,
     ReadyStatus,
@@ -128,6 +129,69 @@ class Manager(Application):
                     f"Heartbeat check: {remaining:.2f} seconds remaining in sleep"
                 )
 
+    def start_up(
+        self,
+        prefix: str,
+        config: ConnectionConfig,
+        set_offset: bool = None,
+        time_status_step: timedelta = None,
+        time_status_init: datetime = None,
+        shut_down_when_terminated: bool = None,
+        time_step: timedelta = None,
+        manager_app_name: str = None,
+    ) -> None:
+        """
+        Starts up the application by connecting to message broker, starting a background event loop,
+        subscribing to manager events, and registering callback functions.
+
+        Args:
+            prefix (str): execution namespace (prefix)
+            config (:obj:`ConnectionConfig`): connection configuration
+            set_offset (bool): True, if the system clock offset shall be set using a NTP request prior to execution
+            time_status_step (:obj:`timedelta`): scenario duration between time status messages
+            time_status_init (:obj:`datetime`): scenario time for first time status message
+            shut_down_when_terminated (bool): True, if the application should shut down when the simulation is terminated
+            time_step (:obj:`timedelta`): scenario time step used in execution (Default: 1 second)
+            manager_app_name (str): manager application name (Default: manager)
+        """
+        if (
+            set_offset is not None
+            and time_status_step is not None
+            and time_status_init is not None
+            and shut_down_when_terminated is not None
+            and time_step is not None
+            and manager_app_name is not None
+        ):
+            self.set_offset = set_offset
+            self.time_status_step = time_status_step
+            self.time_status_init = time_status_init
+            self.shut_down_when_terminated = shut_down_when_terminated
+            self.time_step = time_step
+            self.manager_app_name = manager_app_name
+        else:
+            self.config = config
+            parameters = (
+                self.config.rc.simulation_configuration.execution_parameters.manager
+            )
+            self.set_offset = parameters.set_offset
+            self.time_status_step = parameters.time_status_step
+            self.time_status_init = parameters.time_status_init
+            self.shut_down_when_terminated = parameters.shut_down_when_terminated
+            self.time_step = parameters.time_step
+
+        # start up base application
+        super().start_up(
+            prefix,
+            config,
+            self.set_offset,
+            self.time_status_step,
+            self.time_status_init,
+            self.shut_down_when_terminated,
+        )
+
+        # Establish the exchange
+        self.establish_exchange()
+
     def execute_test_plan(self, *args, **kwargs) -> None:
         """
         Starts the test plan execution in a background thread.
@@ -218,7 +282,16 @@ class Manager(Application):
                     "No configuration runtime. Please provide simulation start and stop times."
                 )
 
-        self.establish_exchange()
+        # Convert TimeScaleUpdateSchema objects to TimeScaleUpdate objects
+        converted_updates = []
+        for update_schema in parameters.time_scale_updates:
+            converted_updates.append(
+                TimeScaleUpdate(
+                    time_scale_factor=update_schema.time_scale_factor,
+                    sim_update_time=update_schema.sim_update_time,
+                )
+            )
+        self.time_scale_updates = converted_updates
 
         # Set up tracking of required applications
         self.required_apps_status = dict(

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools/schemas.py

@@ -311,6 +311,19 @@ class GeneralConfig(BaseModel):
     prefix: str = Field("nost", description="Execution prefix.")
 
 
+class TimeScaleUpdateSchema(BaseModel):
+    """
+    Provides a scheduled update to the simulation time scale factor.
+    """
+
+    time_scale_factor: float = Field(
+        ..., description="Scenario seconds per wallclock second"
+    )
+    sim_update_time: datetime = Field(
+        ..., description="Scenario time that the update will occur"
+    )
+
+
 class ManagerConfig(BaseModel):
     sim_start_time: Optional[datetime] = Field(
         None, description="Simulation start time."
@@ -322,7 +335,7 @@ class ManagerConfig(BaseModel):
         description="Time step for the simulation.",
     )
     time_scale_factor: float = Field(1.0, description="Time scale factor.")
-    time_scale_updates: List[str] = Field(
+    time_scale_updates: List[TimeScaleUpdateSchema] = Field(
         default_factory=list, description="List of time scale updates."
     )
     time_status_step: Optional[timedelta] = Field(None, description="Time status step.")
@@ -437,6 +450,26 @@ class LoggerApplicationConfig(BaseModel):
     )
 
 
+class ApplicationConfig(BaseModel):
+    set_offset: Optional[bool] = Field(True, description="Set offset.")
+    time_scale_factor: Optional[float] = Field(1.0, description="Time scale factor.")
+    time_step: Optional[timedelta] = Field(
+        timedelta(seconds=1), description="Time step for swe_change."
+    )
+    time_status_step: Optional[timedelta] = Field(
+        timedelta(seconds=10), description="Time status step."
+    )
+    time_status_init: Optional[datetime] = Field(
+        datetime.now(), description="Time status init."
+    )
+    shut_down_when_terminated: Optional[bool] = Field(
+        False, description="Shut down when terminated."
+    )
+    manager_app_name: Optional[str] = Field(
+        "manager", description="Manager application name."
+    )
+
+
 class ExecConfig(BaseModel):
     general: GeneralConfig
     manager: Optional[ManagerConfig] = Field(None, description="Manager configuration.")
@@ -447,6 +480,9 @@ class ExecConfig(BaseModel):
     logger_application: Optional[LoggerApplicationConfig] = Field(
         None, description="Logger application configuration."
     )
+    application: Optional[ApplicationConfig] = Field(
+        None, description="Application configuration."
+    )
 
 
 class Config(BaseModel):
@@ -500,3 +536,6 @@ class RuntimeConfig(BaseModel):
     simulation_configuration: SimulationConfig = Field(
         ..., description="Simulation configuration."
     )
+    application_configuration: Optional[Dict] = Field(
+        None, description="Application-specific, user-provided configuration."
+    )

{nost_tools-2.1.1 → nost_tools-2.2.0}/nost_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nost_tools
-Version: 2.1.1
+Version: 2.2.0
 Summary: Tools for Novel Observing Strategies Testbed (NOS-T) Applications
 Author-email: "Paul T. Grogan" <paul.grogan@asu.edu>, "Emmanuel M. Gonzalez" <emmanuelgonzalez@asu.edu>
 License-Expression: BSD-3-Clause