Merge pull request #786 from simvue-io/dev

Create v2.1.1 Release

Author: wk9874

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
         args: [--branch, main, --branch, dev]
       - id: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.2
+    rev: v0.11.4
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix, "--ignore=C901" ]

CHANGELOG.md

@@ -1,4 +1,11 @@
 # Change log
+## [v2.1.1](https://github.com/simvue-io/client/releases/tag/v2.1.1) - 2025-04-25
+* Changed from CO2 Signal to ElectricityMaps
+* Fixed a number of bugs in how offline mode is handled with emissions
+* Streamlined EmissionsMonitor class and handling
+* Fixed bugs in client getting results from Simvue server arising from pagination
+* Fixed bug in setting visibility in `run.init` method
+* Default setting in `Client.get_runs` is now `show_shared=True`
 ## [v2.1.0](https://github.com/simvue-io/client/releases/tag/v2.1.0) - 2025-03-28
 * Removed CodeCarbon dependence in favour of a slimmer solution using the CO2 Signal API.
 * Added sorting to server queries, users can now specify to sort by columns during data retrieval from the database.

CITATION.cff

@@ -42,6 +42,6 @@ keywords:
   - alerting
   - simulation
 license: Apache-2.0
-commit: 8f13a7adb2ad0ec53f0a4949e44e1c5676ae342d
-version: 2.1.0
-date-released: '2025-03-28'
+commit: f1bde5646b33f01ec15ef72a0c5843c1fe181ac1
+version: 2.1.1
+date-released: '2025-04-25'

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simvue"
-version = "2.1.0"
+version = "2.1.1"
 description = "Simulation tracking and monitoring"
 authors = [
   {name = "Simvue Development Team", email = "[email protected]"}

simvue/api/objects/base.py

@@ -365,7 +365,7 @@ def ids(
         """
         _class_instance = cls(_read_only=True, _local=True)
         _count: int = 0
-        for response in cls._get_all_objects(offset):
+        for response in cls._get_all_objects(offset, count=count):
             if (_data := response.get("data")) is None:
                 raise RuntimeError(
                     f"Expected key 'data' for retrieval of {_class_instance.__class__.__name__.lower()}s"
@@ -404,7 +404,7 @@ def get(
         """
         _class_instance = cls(_read_only=True, _local=True)
         _count: int = 0
-        for _response in cls._get_all_objects(offset, **kwargs):
+        for _response in cls._get_all_objects(offset, count=count, **kwargs):
             if count and _count > count:
                 return
             if (_data := _response.get("data")) is None:
@@ -438,7 +438,7 @@ def count(cls, **kwargs) -> int:
 
     @classmethod
     def _get_all_objects(
-        cls, offset: int | None, **kwargs
+        cls, offset: int | None, count: int | None, **kwargs
     ) -> typing.Generator[dict, None, None]:
         _class_instance = cls(_read_only=True)
         _url = f"{_class_instance._base_url}"
@@ -448,7 +448,7 @@ def _get_all_objects(
             _label = _label[:-1]
 
         for response in get_paginated(
-            _url, headers=_class_instance._headers, offset=offset, **kwargs
+            _url, headers=_class_instance._headers, offset=offset, count=count, **kwargs
         ):
             yield get_json_from_response(
                 response=response,

simvue/api/objects/events.py

@@ -51,7 +51,7 @@ def get(
         _class_instance = cls(_read_only=True, _local=True)
         _count: int = 0
 
-        for response in cls._get_all_objects(offset, run=run_id, **kwargs):
+        for response in cls._get_all_objects(offset, count=count, run=run_id, **kwargs):
             if (_data := response.get("data")) is None:
                 raise RuntimeError(
                     f"Expected key 'data' for retrieval of {_class_instance.__class__.__name__.lower()}s"

simvue/api/request.py

@@ -281,6 +281,7 @@ def get_paginated(
     timeout: int = DEFAULT_API_TIMEOUT,
     json: dict[str, typing.Any] | None = None,
     offset: int | None = None,
+    count: int | None = None,
     **params,
 ) -> typing.Generator[requests.Response, None, None]:
     """Paginate results of a server query.
@@ -302,22 +303,18 @@ def get_paginated(
         server response
     """
     _offset: int = offset or 0
-
     while (
-        (
-            _response := get(
-                url=url,
-                headers=headers,
-                params=(params or {})
-                | {"count": MAX_ENTRIES_PER_PAGE, "start": _offset},
-                timeout=timeout,
-                json=json,
-            )
+        _response := get(
+            url=url,
+            headers=headers,
+            params=(params or {})
+            | {"count": count or MAX_ENTRIES_PER_PAGE, "start": _offset},
+            timeout=timeout,
+            json=json,
         )
-        .json()
-        .get("data")
-    ):
+    ).json():
         yield _response
         _offset += MAX_ENTRIES_PER_PAGE
 
-    yield _response
+        if (count and _offset > count) or (_response.json().get("count", 0) < _offset):
+            break

simvue/client.py

@@ -181,7 +181,7 @@ def get_runs(
         output_format: typing.Literal["dict", "objects", "dataframe"] = "objects",
         count_limit: pydantic.PositiveInt | None = 100,
         start_index: pydantic.NonNegativeInt = 0,
-        show_shared: bool = False,
+        show_shared: bool = True,
         sort_by_columns: list[tuple[str, bool]] | None = None,
     ) -> DataFrame | typing.Generator[tuple[str, Run], None, None] | None:
         """Retrieve all runs matching filters.
@@ -210,7 +210,7 @@ def get_runs(
         start_index : int, optional
             the index from which to count entries. Default is 0.
         show_shared : bool, optional
-            whether to include runs shared with the current user. Default is False.
+            whether to include runs shared with the current user. Default is True.
         sort_by_columns : list[tuple[str, bool]], optional
             sort by columns in the order given,
             list of tuples in the form (column_name: str, sort_descending: bool),
@@ -234,8 +234,9 @@ def get_runs(
         RuntimeError
             if there was a failure in data retrieval from the server
         """
+        filters = filters or []
         if not show_shared:
-            filters = (filters or []) + ["user == self"]
+            filters += ["user == self"]
 
         _runs = Run.get(
             count=count_limit,
@@ -835,7 +836,8 @@ def get_metric_values(
 
         _args = {"filters": json.dumps(run_filters)} if run_filters else {}
 
-        _run_data = dict(Run.get(**_args))
+        if not run_ids:
+            _run_data = dict(Run.get(**_args))
 
         if not (
             _run_metrics := self._get_run_metrics_from_server(
@@ -853,7 +855,8 @@ def get_metric_values(
             )
         if use_run_names:
             _run_metrics = {
-                _run_data[key].name: _run_metrics[key] for key in _run_metrics.keys()
+                Run(identifier=key).name: _run_metrics[key]
+                for key in _run_metrics.keys()
             }
         return parse_run_set_metrics(
             _run_metrics,

simvue/config/user.py

@@ -200,6 +200,7 @@ def fetch(
             _default_dir = _config_dict["offline"].get(
                 "cache", DEFAULT_OFFLINE_DIRECTORY
             )
+        pathlib.Path(_default_dir).mkdir(parents=True, exist_ok=True)
 
         _config_dict["offline"]["cache"] = _default_dir
 

simvue/eco/api_client.py

@@ -19,38 +19,33 @@
 import geocoder.location
 import typing
 
-CO2_SIGNAL_API_ENDPOINT: str = "https://api.co2signal.com/v1/latest"
+CO2_SIGNAL_API_ENDPOINT: str = (
+    "https://api.electricitymap.org/v3/carbon-intensity/latest"
+)
 
 
 class CO2SignalData(pydantic.BaseModel):
     datetime: datetime.datetime
     carbon_intensity: float
-    fossil_fuel_percentage: float
 
 
 class CO2SignalResponse(pydantic.BaseModel):
-    disclaimer: str
     country_code: str
-    status: str
     data: CO2SignalData
     carbon_intensity_units: str
 
     @classmethod
     def from_json_response(cls, json_response: dict) -> "CO2SignalResponse":
-        _data: dict[str, typing.Any] = json_response["data"]
         _co2_signal_data = CO2SignalData(
             datetime=datetime.datetime.fromisoformat(
-                _data["datetime"].replace("Z", "+00:00")
+                json_response["datetime"].replace("Z", "+00:00")
             ),
-            carbon_intensity=_data["carbonIntensity"],
-            fossil_fuel_percentage=_data["fossilFuelPercentage"],
+            carbon_intensity=json_response["carbonIntensity"],
         )
         return cls(
-            disclaimer=json_response["_disclaimer"],
-            country_code=json_response["countryCode"],
-            status=json_response["status"],
+            country_code=json_response["zone"],
             data=_co2_signal_data,
-            carbon_intensity_units=json_response["units"]["carbonIntensity"],
+            carbon_intensity_units="gCO2e/kWh",
         )
 
 
@@ -82,18 +77,15 @@ def __init__(self, *args, **kwargs) -> None:
         co2_api_endpoint : str
             endpoint for CO2 signal API
         co2_api_token: str
-            RECOMMENDED. The API token for the CO2 Signal API, default is None.
+            The API token for the ElectricityMaps API, default is None.
         timeout : int
             timeout for API
         """
         super().__init__(*args, **kwargs)
         self._logger = logging.getLogger(self.__class__.__name__)
 
         if not self.co2_api_token:
-            self._logger.warning(
-                "⚠️  No API token provided for CO2 Signal, "
-                "use of a token is strongly recommended."
-            )
+            raise ValueError("API token is required for ElectricityMaps API.")
 
         self._get_user_location_info()
 
@@ -109,16 +101,14 @@ def _get_user_location_info(self) -> None:
     def get(self) -> CO2SignalResponse:
         """Get the current data"""
         _params: dict[str, float | str] = {
-            "lat": self._latitude,
-            "lon": self._longitude,
-            "countryCode": self._two_letter_country_code,
+            "zone": self._two_letter_country_code,
         }
 
         if self.co2_api_token:
             _params["auth-token"] = self.co2_api_token.get_secret_value()
 
         self._logger.debug(f"🍃 Retrieving carbon intensity data for: {_params}")
-        _response = requests.get(f"{self.co2_api_endpoint}", params=_params)
+        _response = requests.get(f"{self.co2_api_endpoint}", headers=_params)
 
         if _response.status_code != http.HTTPStatus.OK:
             try:

simvue/eco/config.py

@@ -8,10 +8,6 @@
 __date__ = "2025-03-06"
 
 import pydantic
-import pathlib
-import os
-
-from simvue.config.files import DEFAULT_OFFLINE_DIRECTORY
 
 
 class EcoConfig(pydantic.BaseModel):
@@ -25,30 +21,13 @@ class EcoConfig(pydantic.BaseModel):
         the TDP for the CPU
     gpu_thermal_design_power: int | None, optional
         the TDP for each GPU
-    local_data_directory: str, optional
-        the directory to store local data, default is Simvue offline directory
     """
 
     co2_signal_api_token: pydantic.SecretStr | None = None
     cpu_thermal_design_power: pydantic.PositiveInt | None = None
     cpu_n_cores: pydantic.PositiveInt | None = None
     gpu_thermal_design_power: pydantic.PositiveInt | None = None
-    local_data_directory: pydantic.DirectoryPath | None = pydantic.Field(
-        None, validate_default=True
-    )
     intensity_refresh_interval: pydantic.PositiveInt | str | None = pydantic.Field(
-        default="1 day", gt=2 * 60
+        default="1 hour", gt=2 * 60
     )
     co2_intensity: float | None = None
-
-    @pydantic.field_validator("local_data_directory", mode="before", check_fields=True)
-    @classmethod
-    def check_local_data_env(
-        cls, local_data_directory: pathlib.Path | None
-    ) -> pathlib.Path:
-        if _data_directory := os.environ.get("SIMVUE_ECO_DATA_DIRECTORY"):
-            return pathlib.Path(_data_directory)
-        if not local_data_directory:
-            local_data_directory = pathlib.Path(DEFAULT_OFFLINE_DIRECTORY)
-            local_data_directory.mkdir(exist_ok=True, parents=True)
-        return local_data_directory