phyelds 2.2.0__tar.gz → 2.3.0__tar.gz

{phyelds-2.2.0 → phyelds-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phyelds
-Version: 2.2.0
+Version: 2.3.0
 Summary: A lightweight Python library to support aggregate computing!
 Home-page: https://github.com/phyelds/phyelds
 License: Apache-2.0
@@ -12,6 +12,8 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: matplotlib (>=3.10.1,<3.11.0)
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: pre-commit (>=4.2.0,<5.0.0)
 Requires-Dist: wrapt (>=1.17.2,<1.18.0)
 Project-URL: Changelog, https://github.com/phyelds/phyelds/blob/master/CHANGELOG.md
 Project-URL: Repository, https://github.com/phyelds/phyelds

{phyelds-2.2.0 → phyelds-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "phyelds"
-version = "2.2.0"
+version = "2.3.0"
 description = "A lightweight Python library to support aggregate computing!"
 license = "Apache-2.0"
 authors = [
@@ -39,6 +39,8 @@ build-backend = "poetry.core.masonry.api"
 python = "^3.13"
 wrapt = ">=1.17.2,<1.18.0"
 matplotlib = ">=3.10.1,<3.11.0"
+pre-commit = "^4.2.0"
+pandas = "^2.2.3"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.0"
@@ -46,4 +48,3 @@ pylint = "^3.0.0"
 pytest-cov = "^3.0.0"
 ruff = "^0.3.0"
 flake8 = "^7.0.0"
-

{phyelds-2.2.0 → phyelds-2.3.0}/src/phyelds/libraries/device.py

@@ -30,11 +30,11 @@ def local_position():
     return engine.get().node_context.position()
 
 
-def store(sensor: str, value: any):
+def store(output: str, value: any):
     """
-    Store the value of the sensor.
-    :param sensor: The name of the sensor.
-    :param value: The value of the sensor.
+    Store the value in the context.
+    :param output: The name of the stored value.
+    :param value: The value to be stored.
     :return:
     """
-    engine.get().node_context.store(sensor, value)
+    engine.get().node_context.store(output, value)

phyelds-2.3.0/src/phyelds/simulator/exporter.py

@@ -0,0 +1,75 @@
+"""Exporter module for saving simulation metrics to CSV during simulation."""
+
+import os
+import itertools
+from pathlib import Path
+from dataclasses import dataclass, replace
+import pandas as pd
+from phyelds.simulator import Simulator
+
+
+__all__ = ["csv_exporter", "ExporterConfig"]
+
+
+@dataclass
+class ExporterConfig:
+    """Configuration for CSV exporting of simulation metrics."""
+    output_directory: str
+    experiment_name: str
+    metrics: list[str]
+    aggregators: list[str]
+    precision: int
+    initial: bool = True
+
+
+def csv_exporter(
+    simulator: Simulator, time_delta: float, config: ExporterConfig, **kwargs
+):
+    """Exporter module for saving simulation metrics to CSV."""
+    file_path = f'{config.output_directory}{config.experiment_name}.csv'
+    if not os.path.exists(file_path) or config.initial:
+        Path(config.output_directory).mkdir(parents=True, exist_ok=True)
+        df = init_dataframe(config, file_path)
+    else:
+        df = pd.read_csv(file_path)
+    new_data = {}
+    nodes = simulator.environment.nodes.values()
+    for metric in config.metrics:
+        nodes_data = [node.data['outputs'][metric] for node in nodes]
+        for aggregator in config.aggregators:
+            column = f'{metric}_{aggregator}'
+            new_data[column] = aggregate_values(nodes_data, config.precision, aggregator)
+    print(new_data)
+    df = pd.concat([df, pd.DataFrame([new_data])], ignore_index=True)
+    df.to_csv(file_path, mode='w', index=False)
+    config = replace(config, initial=False)
+    simulator.schedule_event(
+        time_delta, csv_exporter, simulator, time_delta, config, **kwargs
+    )
+
+
+def aggregate_values(values: list[float], precision, aggregator: str):
+    """Aggregates a list of values using the given method and rounds to the specified precision."""
+    if aggregator == "mean":
+        value = sum(values) / len(values)
+    elif aggregator == "std":
+        mean = sum(values) / len(values)
+        value = sum((v - mean) ** 2 for v in values) / len(values)
+    elif aggregator == "min":
+        value = min(values)
+    elif aggregator == "max":
+        value = max(values)
+    else:
+        raise ValueError(f"Invalid aggregator: {aggregator}")
+    return round(value, precision)
+
+
+def init_dataframe(config, file_path):
+    """Initializes an empty DataFrame with appropriate columns based on config."""
+    columns = list(f'{s}_{a}' for s, a in itertools.product(config.metrics, config.aggregators))
+    print(columns)
+    try:
+        os.remove(file_path)
+    except OSError:
+        pass
+    return pd.DataFrame(columns=columns).astype('float64')

{phyelds-2.2.0 → phyelds-2.3.0}/src/phyelds/simulator/runner.py

@@ -55,8 +55,9 @@ def aggregate_program_runner(
     node.data["result"] = result
     node.data["messages"] = engine.get().cooldown()
     node.data["state"] = engine.get().state_trace()
+    node.data["outputs"] = engine.get().node_context.outputs
     simulator.schedule_event(
-        time_delta, aggregate_program_runner, simulator, time_delta, node, program
+        time_delta, aggregate_program_runner, simulator, time_delta, node, program, **kwargs
     )