Added support for codecarbon in offline mode

Author: wk9874

simvue/config/parameters.py

@@ -48,6 +48,7 @@ def check_token(cls, v: typing.Any) -> str | None:
 
 class OfflineSpecifications(pydantic.BaseModel):
     cache: pathlib.Path | None = None
+    country_iso_code: str | None = None
 
 
 class MetricsSpecifications(pydantic.BaseModel):

simvue/eco.py

@@ -2,7 +2,7 @@
 import logging
 import datetime
 
-from codecarbon import EmissionsTracker
+from codecarbon import EmissionsTracker, OfflineEmissionsTracker
 from codecarbon.output import BaseOutput as cc_BaseOutput
 from simvue.utilities import simvue_timestamp
 
@@ -101,3 +101,32 @@ def post_init(self) -> None:
         self._set_from_conf(self._simvue_run._id, "experiment_id")
         self._set_from_conf(self._simvue_run._name, "experiment_name")
         self.start()
+
+
+class OfflineSimvueEmissionsTracker(OfflineEmissionsTracker):
+    def __init__(
+        self, project_name: str, simvue_run: "Run", metrics_interval: int
+    ) -> None:
+        self._simvue_run = simvue_run
+        logger.setLevel(logging.ERROR)
+        super().__init__(
+            country_iso_code=simvue_run._user_config.offline.country_iso_code,
+            project_name=project_name,
+            measure_power_secs=metrics_interval,
+            api_call_interval=1,
+            experiment_id=None,
+            experiment_name=None,
+            logging_logger=CodeCarbonOutput(simvue_run),
+            save_to_logger=True,
+            allow_multiple_runs=True,
+            log_level="error",
+        )
+
+    def set_measure_interval(self, interval: int) -> None:
+        """Set the measure interval"""
+        self._set_from_conf(interval, "measure_power_secs")
+
+    def post_init(self) -> None:
+        self._set_from_conf(self._simvue_run._id, "experiment_id")
+        self._set_from_conf(self._simvue_run._name, "experiment_name")
+        self.start()

simvue/run.py

@@ -43,7 +43,7 @@
 from .models import FOLDER_REGEX, NAME_REGEX, MetricKeyString
 from .system import get_system
 from .metadata import git_info, environment
-from .eco import SimvueEmissionsTracker
+from .eco import SimvueEmissionsTracker, OfflineSimvueEmissionsTracker
 from .utilities import (
     skip_if_failed,
     validate_timestamp,
@@ -208,11 +208,28 @@ def __init__(
             )
             else self._user_config.metrics.emission_metrics_interval
         )
-        self._emissions_tracker: SimvueEmissionsTracker | None = (
-            SimvueEmissionsTracker("simvue", self, self._emission_metrics_interval)
-            if self._user_config.metrics.enable_emission_metrics
-            else None
-        )
+        if mode == "offline":
+            if (
+                self._user_config.metrics.enable_emission_metrics
+                and not self._user_config.offline.country_iso_code
+            ):
+                raise ValueError(
+                    "Country ISO code must be provided if tracking emissions metrics in offline mode."
+                )
+
+            self._emissions_tracker: OfflineSimvueEmissionsTracker | None = (
+                OfflineSimvueEmissionsTracker(
+                    "simvue", self, self._emission_metrics_interval
+                )
+                if self._user_config.metrics.enable_emission_metrics
+                else None
+            )
+        else:
+            self._emissions_tracker: SimvueEmissionsTracker | None = (
+                SimvueEmissionsTracker("simvue", self, self._emission_metrics_interval)
+                if self._user_config.metrics.enable_emission_metrics
+                else None
+            )
 
     def __enter__(self) -> Self:
         return self
@@ -1028,9 +1045,22 @@ def config(
                 self._emission_metrics_interval = emission_metrics_interval
 
             if enable_emission_metrics:
-                self._emissions_tracker = SimvueEmissionsTracker(
-                    "simvue", self, self._emission_metrics_interval
-                )
+                if self._user_config.run.mode == "offline":
+                    if not self._user_config.offline.country_iso_code:
+                        self._error(
+                            "Country ISO code must be provided if tracking emissions metrics in offline mode."
+                        )
+                    self._emissions_tracker: OfflineSimvueEmissionsTracker = (
+                        OfflineSimvueEmissionsTracker(
+                            "simvue", self, self._emission_metrics_interval
+                        )
+                    )
+                else:
+                    self._emissions_tracker: SimvueEmissionsTracker = (
+                        SimvueEmissionsTracker(
+                            "simvue", self, self._emission_metrics_interval
+                        )
+                    )
 
                 # If the main Run API object is initialised the run is active
                 # hence the tracker should start too