fameio 3.5.1__tar.gz → 3.5.2__tar.gz

{fameio-3.5.1 → fameio-3.5.2}/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 SPDX-License-Identifier: Apache-2.0 -->
 # Changelog
-##  [3.5.1](https://gitlab.com/fame-framework/fame-io/-/tags/v3.5.1) - 2025-07-25
+## [3.5.2](https://gitlab.com/fame-framework/fame-io/-/tags/v3.5.2) - 2025-10-14
+### Fixed
+- Fix conversion of time stamps on input recovery based on user specifications #274 (@dlr_fn)
+
+## [3.5.1](https://gitlab.com/fame-framework/fame-io/-/tags/v3.5.1) - 2025-07-25
 ### Fixed
 - Fix crash on result conversion if agent list is provided #266 (@dlr-cjs, @dlr_jk)
 - Fix missing recovery of scenario StringSets #264 (@dlr-cjs)

{fameio-3.5.1 → fameio-3.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fameio
-Version: 3.5.1
+Version: 3.5.2
 Summary: Tools for input preparation and output digestion of FAME models
 License: Apache-2.0
 Keywords: FAME,fameio,agent-based modelling,energy systems

{fameio-3.5.1 → fameio-3.5.2}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "fameio"
-version = "3.5.1"
+version = "3.5.2"
 description = "Tools for input preparation and output digestion of FAME models"
 license = "Apache-2.0"
 readme = "README.md"

{fameio-3.5.1 → fameio-3.5.2}/src/fameio/output/conversion.py

@@ -12,7 +12,10 @@ import pandas as pd
 from fameio.cli.options import TimeOptions
 from fameio.logs import log_error, log
 from fameio.output import OutputError
-from fameio.time import FameTime, ConversionError as TimeConversionError
+from fameio.series import TimeSeriesManager
+from fameio.time import FameTime, ConversionError as TimeConversionError, DATE_FORMAT as DATETIME_FORMAT_FAME
+
+DATETIME_FORMAT_UTC = "%Y-%m-%d %H:%M:%S"
 
 _ERR_UNIMPLEMENTED = "Time conversion mode '{}' not implemented."
 _ERR_TIME_CONVERSION = "Conversion of timestamps failed."
@@ -86,9 +89,9 @@ def apply_time_option(data: dict[str | None, pd.DataFrame], mode: TimeOptions) -
         if mode == TimeOptions.INT:
             log().debug("No time conversion...")
         elif mode == TimeOptions.UTC:
-            _convert_time_index(data, "%Y-%m-%d %H:%M:%S")
+            _convert_time_index(data, DATETIME_FORMAT_UTC)
         elif mode == TimeOptions.FAME:
-            _convert_time_index(data, "%Y-%m-%d_%H:%M:%S")
+            _convert_time_index(data, DATETIME_FORMAT_FAME)
         else:
             raise log_error(ConversionError(_ERR_UNIMPLEMENTED.format(mode)))
     except TimeConversionError as e:
@@ -111,5 +114,7 @@ def _convert_time_index(data: dict[str | None, pd.DataFrame], datetime_format: s
     for _, df in data.items():
         index_columns = df.index.names
         df.reset_index(inplace=True)
-        df["TimeStep"] = df["TimeStep"].apply(lambda t: FameTime.convert_fame_time_step_to_datetime(t, datetime_format))
+        df[TimeSeriesManager.KEY_ROW_TIME] = df[TimeSeriesManager.KEY_ROW_TIME].apply(
+            lambda t: FameTime.convert_fame_time_step_to_datetime(t, datetime_format)
+        )
         df.set_index(keys=index_columns, inplace=True)

{fameio-3.5.1 → fameio-3.5.2}/src/fameio/output/csv_writer.py

@@ -6,11 +6,14 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import Literal
 
 import pandas as pd
 
+from fameio.cli.options import TimeOptions
 from fameio.logs import log_error
 from fameio.output import OutputError
+from fameio.output.conversion import apply_time_option
 from fameio.output.data_transformer import INDEX
 from fameio.series import TimeSeriesManager
 from fameio.tools import ensure_path_exists
@@ -59,11 +62,14 @@ class CsvWriter:
                 identifier = self._get_identifier(agent_name, column_name)
                 self._write_data_frame(column_data, identifier)
 
-    def write_all_time_series_to_disk(self, timeseries_manager: TimeSeriesManager) -> None:
+    def write_all_time_series_to_disk(
+        self, timeseries_manager: TimeSeriesManager, time_mode: TimeOptions | None = None
+    ) -> None:
         """Writes time_series of given `timeseries_manager` to disk.
 
         Args:
             timeseries_manager: to provide the time series that are to be written
+            time_mode: mode of representing time in series that are to be written
 
         Raises:
             CsvWriterError: if data could not be written to disk, logged on level "ERROR"
@@ -72,6 +78,8 @@ class CsvWriter:
             if data is not None:
                 target_path = Path(self._output_folder, name)
                 ensure_path_exists(target_path.parent)
+                if time_mode:
+                    apply_time_option(data={name: data}, mode=time_mode)
                 self.write_single_time_series_to_disk(data, target_path)
 
     @staticmethod
@@ -85,10 +93,10 @@ class CsvWriter:
         Raises:
             CsvWriterError: if data could not be written to disk, logged on level "ERROR"
         """
-        CsvWriter._dataframe_to_csv(data, file, header=False, index=False, mode="w")
+        CsvWriter._dataframe_to_csv(data, file, header=False, index=True, mode="w")
 
     @staticmethod
-    def _dataframe_to_csv(data: pd.DataFrame, file: Path, header: bool, index: bool, mode: str) -> None:
+    def _dataframe_to_csv(data: pd.DataFrame, file: Path, header: bool, index: bool, mode: Literal["a", "w"]) -> None:
         """Write given data to specified CSV file in UTF8 encoding with specified parameters using semicolon separators.
 
         Args:
@@ -132,7 +140,7 @@ class CsvWriter:
         """
         if self._has_file(identifier):
             outfile_name = self._get_outfile_name(identifier)
-            mode = "a"
+            mode: Literal["a", "w"] = "a"
             header = False
         else:
             outfile_name = self._create_outfile_name(identifier)

{fameio-3.5.1 → fameio-3.5.2}/src/fameio/scripts/convert_results.py

@@ -9,7 +9,7 @@ import pandas as pd
 
 from fameio.cli import update_default_config
 from fameio.cli.convert_results import handle_args, CLI_DEFAULTS as DEFAULT_CONFIG
-from fameio.cli.options import Options
+from fameio.cli.options import Options, TimeOptions
 from fameio.input import InputError
 from fameio.logs import fameio_logger, log, log_error, log_critical
 from fameio.output import OutputError
@@ -99,7 +99,7 @@ def _extract_and_convert_data(config: dict[Options, Any], file_stream: BinaryIO,
             output_writer.write_to_files(agent_name, data_frames)
 
     if config[Options.INPUT_RECOVERY]:
-        _recover_inputs(output_path, input_dao, execution_dao.get_fameio_version())
+        _recover_inputs(output_path, input_dao, execution_dao.get_fameio_version(), config[Options.TIME])
     if config[Options.MEMORY_SAVING]:
         _memory_saving_apply_conversions(config, output_writer)
 
@@ -118,13 +118,14 @@ def _extract_and_convert_data(config: dict[Options, Any], file_stream: BinaryIO,
     log().info("Data conversion completed.")
 
 
-def _recover_inputs(output_path: Path, input_dao: InputDao, fameio_version: str) -> None:
+def _recover_inputs(output_path: Path, input_dao: InputDao, fameio_version: str, time_mode: TimeOptions) -> None:
     """Reads scenario configuration from provided `input_dao`.
 
     Args:
         output_path: path to output files
         input_dao: to recover the input data from
         fameio_version: version of fameio that was used to create the input data
+        time_mode: mode of representing time in recovered input time series
 
     Raises:
         OutputError: if inputs could not be recovered or saved to files, logged with level "ERROR"
@@ -136,7 +137,7 @@ def _recover_inputs(output_path: Path, input_dao: InputDao, fameio_version: str)
         raise log_error(OutputError(_ERR_RECOVER_INPUT.format(fameio_version))) from ex
 
     series_writer = CsvWriter(output_folder=Path(output_path, RECOVERED_INPUT_PATH), single_export=False)
-    series_writer.write_all_time_series_to_disk(timeseries)
+    series_writer.write_all_time_series_to_disk(timeseries, time_mode)
     data_to_yaml_file(scenario.to_dict(), Path(output_path, RECOVERED_SCENARIO_PATH))
 
 

{fameio-3.5.1 → fameio-3.5.2}/src/fameio/series.py

@@ -8,7 +8,7 @@ import math
 import os
 from enum import Enum, auto
 from pathlib import Path
-from typing import Any
+from typing import Any, Final
 
 import pandas as pd
 from fameprotobuf.input_file_pb2 import InputData
@@ -41,10 +41,11 @@ class Entry(Enum):
 class TimeSeriesManager:
     """Manages matching of timeseries data from files and values to unique ids and vice versa."""
 
+    KEY_ROW_TIME: Final[str] = "TimeStep"
+    KEY_ROW_VALUE: Final[str] = "Value"
+
     _TIMESERIES_RECONSTRUCTION_PATH = "./timeseries/"
     _CONSTANT_IDENTIFIER = "Constant value: {}"
-    _KEY_ROW_TIME = "timeStep"
-    _KEY_ROW_VALUE = "value"
 
     _ERR_FILE_NOT_FOUND = "Cannot find Timeseries file '{}'."
     _ERR_NUMERIC_STRING = " Remove quotes to use a constant numeric value instead of a timeseries file."
@@ -274,7 +275,7 @@ class TimeSeriesManager:
         """Reconstructs and stores time series from given list of `timeseries_dao`."""
         for one_series in timeseries:
             self._id_count += 1
-            reconstructed = {Entry.ID: one_series.series_id}
+            reconstructed: dict[Entry, int | float | None | str | pd.DataFrame] = {Entry.ID: one_series.series_id}
             if len(one_series.values) == 1 or (
                 len(one_series.values) == 2 and one_series.values[0] == one_series.values[1]
             ):
@@ -283,7 +284,8 @@ class TimeSeriesManager:
             else:
                 reconstructed[Entry.NAME] = self._get_cleaned_file_name(one_series.series_name)
                 reconstructed[Entry.DATA] = pd.DataFrame(
-                    {self._KEY_ROW_TIME: list(one_series.time_steps), self._KEY_ROW_VALUE: list(one_series.values)}
+                    data={self.KEY_ROW_VALUE: list(one_series.values)},
+                    index=pd.Index(data=list(one_series.time_steps), name=self.KEY_ROW_TIME),
                 )
             self._series_by_id[one_series.series_id] = reconstructed