PyPI - fameio - Versions diffs - 3.1.1__tar.gz → 3.3.0__tar.gz - Mend

fameio 3.1.1tar.gz → 3.3.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

{fameio-3.1.1 → fameio-3.3.0}/CHANGELOG.md RENAMED Viewed

@@ -2,6 +2,28 @@
 SPDX-License-Identifier: CC0-1.0 -->
+## [3.3.0](https://gitlab.com/fame-framework/fame-io/-/tags/v3.3.0) - 2025-5-09
+### Changed
+- Expose static methods to read, convert, and write time series #245 (@dlr-cjs)
+- Improve docstrings of SchemaValidator !219 (@dlr-cjs)
+### Added
+- Add command-line script to reformat time series #246 (@dlr-cjs)
+- Read execution metadata from protobuf file #193 (@dlr-cjs)
+## [3.2.0](https://gitlab.com/fame-framework/fame-io/-/tags/v3.2.0) - 2025-04-22
+### Changed
+- Suppress detailed Exception traceback in console #239 (@dlr_fn, @dlr-cjs)
+- Improve speed of time series data conversion #240 (@dlr-cjs)
+- Warn if large time series data files need conversion #241 (@dlr-cjs)
+- Adapt pyproject.toml to latest standard #238 (@dlr-cjs)
+### Added
+- Add warning if unexpected keys are found at agent top level definition #233 (@dlr_fn)
+- Add error if contract product name is empty #221 (@dlr_fn, @dlr-cjs)
+- Add link to best practices and tools in Contributing !209 (@dlr-cjs)
+- Add static type checking to CI and pre-commit #236 (@dlr-cjs)
 ## [3.1.1](https://gitlab.com/fame-framework/fame-io/-/tags/v3.1.1) - 2025-03-21
 ### Added
 - Add static code analysis to CI pipeline #231 (@dlr-cjs)

{fameio-3.1.1 → fameio-3.3.0}/PKG-INFO RENAMED Viewed

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: fameio
-Version: 3.1.1
+Version: 3.3.0
 Summary: Tools for input preparation and output digestion of FAME models
-Home-page: https://gitlab.com/fame-framework/wiki/-/wikis/home
 License: Apache-2.0
 Keywords: FAME,fameio,agent-based modelling,energy systems
 Author: Felix Nitsch
@@ -20,32 +19,35 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
-Requires-Dist: fameprotobuf (>=2.0.2,<3.0.0)
+Requires-Dist: fameprotobuf (>=2.0.2,<3.0)
 Requires-Dist: pandas (>=1.0,<3.0)
 Requires-Dist: pyyaml (>=6.0,<7.0)
-Project-URL: Repository, https://gitlab.com/fame-framework/fame-io/
+Project-URL: Changelog, https://gitlab.com/fame-framework/fame-io/-/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://helmholtz.software/software/fame
+Project-URL: Issue Tracking, https://gitlab.com/fame-framework/fame-io/-/issues
+Project-URL: Repository, https://gitlab.com/fame-framework/fame-io
 Description-Content-Type: text/markdown
 <!-- SPDX-FileCopyrightText: 2025 German Aerospace Center <fame@dlr.de>
 SPDX-License-Identifier: Apache-2.0 -->
-|               |                                                                                                                                                                                                                                                                                                                                             |
-|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Package**   | [![PyPI version](https://badge.fury.io/py/fameio.svg)](https://badge.fury.io/py/fameio) [![PyPI license](https://img.shields.io/pypi/l/fameio.svg)](https://badge.fury.io/py/fameio) [![REUSE status](https://api.reuse.software/badge/gitlab.com/fame-framework/fame-io)](https://api.reuse.software/info/gitlab.com/fame-framework/fame-io) |
-| **Tests**     | [![pipeline status](https://gitlab.com/fame-framework/fame-io/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/fame-io/commits/main) [![coverage report](https://gitlab.com/fame-framework/fame-io/badges/main/coverage.svg)](https://gitlab.com/fame-framework/fame-io/-/commits/main)                                         |
-| **Activity**  | ![GitLab last commit](https://img.shields.io/gitlab/last-commit/fame-framework%2Ffame-io) ![GitLab closed issues by-label](https://img.shields.io/gitlab/issues/closed/fame-framework%2Ffame-io)                                                                                                                                            |
-| **Style**     | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org) [![linting: pylint](https://img.shields.io/badge/linting-pylint-green)](https://github.com/pylint-dev/pylint)                                                                                                                               |
-| **Reference** | [![JOSS](https://joss.theoj.org/papers/10.21105/joss.04958/status.svg)](https://doi.org/10.21105/joss.04958) [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.4314337.svg)](https://doi.org/10.5281/zenodo.4314337)                                                                                                                   |
+|               |                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Package**   | ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fameio) ![PyPI - Version](https://img.shields.io/pypi/v/fameio) [![PyPI license](https://img.shields.io/pypi/l/fameio.svg)](https://badge.fury.io/py/fameio) [![REUSE status](https://api.reuse.software/badge/gitlab.com/fame-framework/fame-io)](https://api.reuse.software/info/gitlab.com/fame-framework/fame-io)                                                  |
+| **Test**      | [![pipeline status](https://gitlab.com/fame-framework/fame-io/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/fame-io/commits/main) [![coverage report](https://gitlab.com/fame-framework/fame-io/badges/main/coverage.svg)](https://gitlab.com/fame-framework/fame-io/-/commits/main)                                                                                                                                    |
+| **Activity**  | ![GitLab last commit](https://img.shields.io/gitlab/last-commit/fame-framework%2Ffame-io) ![GitLab closed issues by-label](https://img.shields.io/gitlab/issues/closed/fame-framework%2Ffame-io)                                                                                                                                                                                                                                       |
+| **Style**     | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![log style - common changelog](https://img.shields.io/badge/log_style-common_changelog-blue)](https://common-changelog.org/) ![Static Badge](https://img.shields.io/badge/type%20checked-mypy-039dfc) [![linting: pylint](https://img.shields.io/badge/linting-pylint-green)](https://github.com/pylint-dev/pylint) |
+| **Reference** | [![JOSS](https://joss.theoj.org/papers/10.21105/joss.04958/status.svg)](https://doi.org/10.21105/joss.04958) [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.4314337.svg)](https://doi.org/10.5281/zenodo.4314337)                                                                                                                                                                                                              |
 # FAME-Io
 *Tools for input preparation and output digestion of FAME models*
 FAME-Io compiles input for FAME models in protobuf format and extracts model outputs to human-readable files.
-Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to get an explanation of FAME and its
-components.
+Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to get an explanation of FAME and its components.
 # Installation
@@ -53,30 +55,26 @@ We recommend installing `fameio` using PyPI:
     pip install fameio
-You may also use `pipx`. For detailed information please refer to the
-official `pipx` [documentation](https://github.com/pypa/pipx).
+You may also use `pipx`. For detailed information please refer to the official `pipx` [documentation](https://github.com/pypa/pipx).
     pipx install fameio
-`fameio` is currently developed and tested for Python 3.8 or higher.
+`fameio` is currently developed and tested for Python 3.9 or higher.
 See the `pyproject.toml` for a complete listing of dependencies.
 # Usage
-FAME-Io currently offers two main scripts `makeFameRunConfig` and `convertFameResults`.
-Both are automatically installed with the package.
+FAME-Io currently offers two main scripts `makeFameRunConfig` and `convertFameResults`, plus a helper script `reformatTimeSeries`
+All are automatically installed with the package.
 The first one creates a protobuf file for FAME applications using YAML definition files and CSV files.
-The latter one reads output files from FAME applications in protobuf format and converts them to CSV files.
+The second one reads output files from FAME applications in protobuf format and converts them to CSV files.
+The third script reformats time series CSV files to FAME format.
-You may use the [example data](https://gitlab.com/dlr-ve/esy/amiris/examples) provided for
-the [AMIRIS](https://gitlab.com/dlr-ve/esy/amiris/amiris) model which can be used to simulate electricity markets
-in [Germany](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Germany2019), [Austria](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Austria2019),
-and a simple [proof-of-concept model](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Simple).
+You may use the [example data](https://gitlab.com/dlr-ve/esy/amiris/examples) provided for the [AMIRIS](https://gitlab.com/dlr-ve/esy/amiris/amiris) model which can be used to simulate electricity markets in [Germany](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Germany2019), [Austria](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Austria2019), and a simple [proof-of-concept model](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Simple).
 ## Make a FAME run configuration
-Digests configuration files in YAML format, combines them with CSV data files and creates a single input file for FAME
-applications in protobuf format.
+Digests configuration files in YAML format, combines them with CSV data files and creates a single input file for FAME applications in protobuf format.
 Call structure:
     makeFameRunConfig -f <path/to/scenario.yaml>
@@ -362,7 +360,9 @@ Agent Parameters:
 * `Attributes` Optional; if the agent has any attributes, specify them here in the format "AttributeName: value"; please
   see attribute table above
 * `Metadata` Optional; can be assigned to each instance of an Agent, as well as to each of its Attributes
+* `Ext` Optional; Reserved key for parameters not used by fameio but its extensions, e.g., FAME-Gui
+A warning is logged for any other key at this level.
 The specified `Attributes` for each agent must match the specified `Attributes` options in the linked Schema (see
 above).
 For better structure and readability of the `scenario.yaml`, `Attributes` may also be specified in a nested way as
@@ -639,10 +639,8 @@ TIME_SERIES inputs are not directly fed into the Scenario YAML file.
 Instead, TIME_SERIES reference a CSV file that can be stored some place else.
 These CSV files follow a specific structure:
-* They should contain exactly two columns - any other columns are ignored.
-  A warning is raised if more than two non-empty columns are detected.
-* The first column must be a time stamp in form `YYYY-MM-DD_hh:mm:ss` or
-  a [FAME-Timestamp](https://gitlab.com/fame-framework/wiki/-/wikis/architecture/decisions/TimeStamp) integer value
+* They should contain exactly two columns - any other columns are ignored. A warning is raised if more than two non-empty columns are detected.
+* The first column must be a time stamp in form `YYYY-MM-DD_hh:mm:ss` or a [FAME-Timestamp](https://gitlab.com/fame-framework/wiki/-/wikis/architecture/decisions/TimeStamp) integer value.
 * The second column must be a numerical value (either integer or floating-point)
 * The separator of the two columns is a semicolon
 * The data must **not** have headers, except for comments marked with `#`
@@ -658,10 +656,10 @@ Exemplary content of a valid CSV file:
     2016-01-01_00:00:00;42  # optional comment on this particular data point
     2017-01-01_00:00:00;0.1
-Please refer also to the detailed article about `TimeStamps` in
-the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/TimeStamp).
-For large CSV files (with more than 20,000 rows) we recommend using the integer representation of FAME-Timestamps in the
-first column (instead of text representation) to improve conversion speed.
+Please refer also to the detailed article about `TimeStamps` in the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/TimeStamp).
+For large CSV files (with more than 20,000 rows) we recommend using the integer representation of FAME-Timestamps in the first column (instead of text representation) to improve conversion speed.
+A warning will be raised for very large files (exceeding 50,000 rows) that require time stamp conversion.
+Use `reformatTimeSeries` to convert one or multiple timeseries CSV files into FAME format to improve conversion speed and avoid this warning.
 ### Split and join multiple YAML files
@@ -930,6 +928,24 @@ run_config = handle_args(my_arg_string, my_defaults)
 convert_results(run_config)
 ```
+## Reformat time series
+Takes CSV time series files and reformats them into FAME time format.
+This improves speed of run configuration creation but also reduces readability of the CSV files' content.
+Thus, we recommend to apply this reformatting only for CSV time series files with more than 20,000 lines.
+Call structure:
+    reformatTimeSeries -fp <file_or_file_pattern*.csv>
+You may also specify any of the following arguments:
+| Command                       | Action                                                                                                                                                                                 |
+|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `-l` or `--log` <option>      | Sets the logging level. Default is `WARNING`. Options are `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`.                                                                             |
+| `-lf` or `--logfile` <file>   | Sets the logging file. Default is `None`. If `None` is provided, all logs get only printed to the console.                                                                             |
+| `--replace` or `--no-replace` | If `--replace` is specified, existing csv files are replaced with the new content. Otherwise and by default, new files are created extending the original file name by "_reformatted". |
 ## Cite FAME-Io
 If you use FAME-Io for academic work, please cite as follows.

{fameio-3.1.1 → fameio-3.3.0}/README.md RENAMED Viewed

@@ -2,21 +2,20 @@
 SPDX-License-Identifier: Apache-2.0 -->
-|               |                                                                                                                                                                                                                                                                                                                                             |
-|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Package**   | [![PyPI version](https://badge.fury.io/py/fameio.svg)](https://badge.fury.io/py/fameio) [![PyPI license](https://img.shields.io/pypi/l/fameio.svg)](https://badge.fury.io/py/fameio) [![REUSE status](https://api.reuse.software/badge/gitlab.com/fame-framework/fame-io)](https://api.reuse.software/info/gitlab.com/fame-framework/fame-io) |
-| **Tests**     | [![pipeline status](https://gitlab.com/fame-framework/fame-io/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/fame-io/commits/main) [![coverage report](https://gitlab.com/fame-framework/fame-io/badges/main/coverage.svg)](https://gitlab.com/fame-framework/fame-io/-/commits/main)                                         |
-| **Activity**  | ![GitLab last commit](https://img.shields.io/gitlab/last-commit/fame-framework%2Ffame-io) ![GitLab closed issues by-label](https://img.shields.io/gitlab/issues/closed/fame-framework%2Ffame-io)                                                                                                                                            |
-| **Style**     | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org) [![linting: pylint](https://img.shields.io/badge/linting-pylint-green)](https://github.com/pylint-dev/pylint)                                                                                                                               |
-| **Reference** | [![JOSS](https://joss.theoj.org/papers/10.21105/joss.04958/status.svg)](https://doi.org/10.21105/joss.04958) [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.4314337.svg)](https://doi.org/10.5281/zenodo.4314337)                                                                                                                   |
+|               |                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Package**   | ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fameio) ![PyPI - Version](https://img.shields.io/pypi/v/fameio) [![PyPI license](https://img.shields.io/pypi/l/fameio.svg)](https://badge.fury.io/py/fameio) [![REUSE status](https://api.reuse.software/badge/gitlab.com/fame-framework/fame-io)](https://api.reuse.software/info/gitlab.com/fame-framework/fame-io)                                                  |
+| **Test**      | [![pipeline status](https://gitlab.com/fame-framework/fame-io/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/fame-io/commits/main) [![coverage report](https://gitlab.com/fame-framework/fame-io/badges/main/coverage.svg)](https://gitlab.com/fame-framework/fame-io/-/commits/main)                                                                                                                                    |
+| **Activity**  | ![GitLab last commit](https://img.shields.io/gitlab/last-commit/fame-framework%2Ffame-io) ![GitLab closed issues by-label](https://img.shields.io/gitlab/issues/closed/fame-framework%2Ffame-io)                                                                                                                                                                                                                                       |
+| **Style**     | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![log style - common changelog](https://img.shields.io/badge/log_style-common_changelog-blue)](https://common-changelog.org/) ![Static Badge](https://img.shields.io/badge/type%20checked-mypy-039dfc) [![linting: pylint](https://img.shields.io/badge/linting-pylint-green)](https://github.com/pylint-dev/pylint) |
+| **Reference** | [![JOSS](https://joss.theoj.org/papers/10.21105/joss.04958/status.svg)](https://doi.org/10.21105/joss.04958) [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.4314337.svg)](https://doi.org/10.5281/zenodo.4314337)                                                                                                                                                                                                              |
 # FAME-Io
 *Tools for input preparation and output digestion of FAME models*
 FAME-Io compiles input for FAME models in protobuf format and extracts model outputs to human-readable files.
-Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to get an explanation of FAME and its
-components.
+Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to get an explanation of FAME and its components.
 # Installation
@@ -24,30 +23,26 @@ We recommend installing `fameio` using PyPI:
     pip install fameio
-You may also use `pipx`. For detailed information please refer to the
-official `pipx` [documentation](https://github.com/pypa/pipx).
+You may also use `pipx`. For detailed information please refer to the official `pipx` [documentation](https://github.com/pypa/pipx).
     pipx install fameio
-`fameio` is currently developed and tested for Python 3.8 or higher.
+`fameio` is currently developed and tested for Python 3.9 or higher.
 See the `pyproject.toml` for a complete listing of dependencies.
 # Usage
-FAME-Io currently offers two main scripts `makeFameRunConfig` and `convertFameResults`.
-Both are automatically installed with the package.
+FAME-Io currently offers two main scripts `makeFameRunConfig` and `convertFameResults`, plus a helper script `reformatTimeSeries`
+All are automatically installed with the package.
 The first one creates a protobuf file for FAME applications using YAML definition files and CSV files.
-The latter one reads output files from FAME applications in protobuf format and converts them to CSV files.
+The second one reads output files from FAME applications in protobuf format and converts them to CSV files.
+The third script reformats time series CSV files to FAME format.
-You may use the [example data](https://gitlab.com/dlr-ve/esy/amiris/examples) provided for
-the [AMIRIS](https://gitlab.com/dlr-ve/esy/amiris/amiris) model which can be used to simulate electricity markets
-in [Germany](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Germany2019), [Austria](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Austria2019),
-and a simple [proof-of-concept model](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Simple).
+You may use the [example data](https://gitlab.com/dlr-ve/esy/amiris/examples) provided for the [AMIRIS](https://gitlab.com/dlr-ve/esy/amiris/amiris) model which can be used to simulate electricity markets in [Germany](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Germany2019), [Austria](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Austria2019), and a simple [proof-of-concept model](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Simple).
 ## Make a FAME run configuration
-Digests configuration files in YAML format, combines them with CSV data files and creates a single input file for FAME
-applications in protobuf format.
+Digests configuration files in YAML format, combines them with CSV data files and creates a single input file for FAME applications in protobuf format.
 Call structure:
     makeFameRunConfig -f <path/to/scenario.yaml>
@@ -333,7 +328,9 @@ Agent Parameters:
 * `Attributes` Optional; if the agent has any attributes, specify them here in the format "AttributeName: value"; please
   see attribute table above
 * `Metadata` Optional; can be assigned to each instance of an Agent, as well as to each of its Attributes
+* `Ext` Optional; Reserved key for parameters not used by fameio but its extensions, e.g., FAME-Gui
+A warning is logged for any other key at this level.
 The specified `Attributes` for each agent must match the specified `Attributes` options in the linked Schema (see
 above).
 For better structure and readability of the `scenario.yaml`, `Attributes` may also be specified in a nested way as
@@ -610,10 +607,8 @@ TIME_SERIES inputs are not directly fed into the Scenario YAML file.
 Instead, TIME_SERIES reference a CSV file that can be stored some place else.
 These CSV files follow a specific structure:
-* They should contain exactly two columns - any other columns are ignored.
-  A warning is raised if more than two non-empty columns are detected.
-* The first column must be a time stamp in form `YYYY-MM-DD_hh:mm:ss` or
-  a [FAME-Timestamp](https://gitlab.com/fame-framework/wiki/-/wikis/architecture/decisions/TimeStamp) integer value
+* They should contain exactly two columns - any other columns are ignored. A warning is raised if more than two non-empty columns are detected.
+* The first column must be a time stamp in form `YYYY-MM-DD_hh:mm:ss` or a [FAME-Timestamp](https://gitlab.com/fame-framework/wiki/-/wikis/architecture/decisions/TimeStamp) integer value.
 * The second column must be a numerical value (either integer or floating-point)
 * The separator of the two columns is a semicolon
 * The data must **not** have headers, except for comments marked with `#`
@@ -629,10 +624,10 @@ Exemplary content of a valid CSV file:
     2016-01-01_00:00:00;42  # optional comment on this particular data point
     2017-01-01_00:00:00;0.1
-Please refer also to the detailed article about `TimeStamps` in
-the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/TimeStamp).
-For large CSV files (with more than 20,000 rows) we recommend using the integer representation of FAME-Timestamps in the
-first column (instead of text representation) to improve conversion speed.
+Please refer also to the detailed article about `TimeStamps` in the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/TimeStamp).
+For large CSV files (with more than 20,000 rows) we recommend using the integer representation of FAME-Timestamps in the first column (instead of text representation) to improve conversion speed.
+A warning will be raised for very large files (exceeding 50,000 rows) that require time stamp conversion.
+Use `reformatTimeSeries` to convert one or multiple timeseries CSV files into FAME format to improve conversion speed and avoid this warning.
 ### Split and join multiple YAML files
@@ -901,6 +896,24 @@ run_config = handle_args(my_arg_string, my_defaults)
 convert_results(run_config)
 ```
+## Reformat time series
+Takes CSV time series files and reformats them into FAME time format.
+This improves speed of run configuration creation but also reduces readability of the CSV files' content.
+Thus, we recommend to apply this reformatting only for CSV time series files with more than 20,000 lines.
+Call structure:
+    reformatTimeSeries -fp <file_or_file_pattern*.csv>
+You may also specify any of the following arguments:
+| Command                       | Action                                                                                                                                                                                 |
+|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `-l` or `--log` <option>      | Sets the logging level. Default is `WARNING`. Options are `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`.                                                                             |
+| `-lf` or `--logfile` <file>   | Sets the logging file. Default is `None`. If `None` is provided, all logs get only printed to the console.                                                                             |
+| `--replace` or `--no-replace` | If `--replace` is specified, existing csv files are replaced with the new content. Otherwise and by default, new files are created extending the original file name by "_reformatted". |
 ## Cite FAME-Io
 If you use FAME-Io for academic work, please cite as follows.

{fameio-3.1.1 → fameio-3.3.0}/pyproject.toml RENAMED Viewed

@@ -2,27 +2,46 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 [build-system]
-requires = ["poetry-core>=1.0.0"]
+requires = ["poetry-core>=2.0.0"]
 build-backend = "poetry.core.masonry.api"
-[tool.poetry]
+[project]
 name = "fameio"
-version = "3.1.1"
+version = "3.3.0"
 description = "Tools for input preparation and output digestion of FAME models"
 license = "Apache-2.0"
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
 authors = [
-    "Felix Nitsch <fame@dlr.de>",
-    "Christoph Schimeczek <fame@dlr.de>",
-    "Ulrich Frey <fame@dlr.de>",
-    "Benjamin Fuchs <fame@dlr.de>",
+    { name = "Felix Nitsch", email = "fame@dlr.de" },
+    { name = "Christoph Schimeczek", email = "fame@dlr.de" },
+    { name = "Ulrich Frey", email = "fame@dlr.de" },
+    { name = "Benjamin Fuchs", email = "fame@dlr.de" },
 ]
 maintainers = [
-    "Felix Nitsch <fame@dlr.de>",
+    { name = "Felix Nitsch", email = "fame@dlr.de" },
+    { name = "Christoph Schimeczek", email = "fame@dlr.de" },
 ]
-readme = "README.md"
-homepage = "https://gitlab.com/fame-framework/wiki/-/wikis/home"
-repository = "https://gitlab.com/fame-framework/fame-io/"
 keywords = ["FAME", "fameio", "agent-based modelling", "energy systems"]
+dynamic = ["classifiers"]
+dependencies = [
+    "fameprotobuf>=2.0.2,<3.0",
+    "pandas>= 1.0,<3.0",
+    "pyyaml>=6.0,<7.0",
+]
+[project.urls]
+homepage = "https://helmholtz.software/software/fame"
+repository = "https://gitlab.com/fame-framework/fame-io"
+"Changelog" = "https://gitlab.com/fame-framework/fame-io/-/blob/main/CHANGELOG.md"
+"Issue Tracking" = "https://gitlab.com/fame-framework/fame-io/-/issues"
+[project.scripts]
+makeFameRunConfig = "fameio.scripts:makeFameRunConfig"
+convertFameResults = "fameio.scripts:convertFameResults"
+reformatTimeSeries = "fameio.scripts:reformatTimeSeries"
+[tool.poetry]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Operating System :: OS Independent",
@@ -33,12 +52,6 @@ classifiers = [
 packages = [{ include = "fameio", from = "src" }]
 include = ["CHANGELOG.md"]
-[tool.poetry.dependencies]
-python = "^3.9"
-fameprotobuf = "^2.0.2"
-pandas = ">= 1.0, <3.0"
-pyyaml = "^6.0"
 [tool.poetry.group.dev]
 optional = true
@@ -48,11 +61,8 @@ mockito = "^1.5"
 pre-commit = "^3.8"
 coverage = { version = "^7.6", extras = ["toml"] }
 black = "^24.8"
-prospector = "^1.15"
-[tool.poetry.scripts]
-makeFameRunConfig = "fameio.scripts:makeFameRunConfig"
-convertFameResults = "fameio.scripts:convertFameResults"
+prospector = { version = "^1.16", extras = ["with_mypy"] }
+types-PyYAML = "^6.0"
 [tool.black]
 line-length = 120
@@ -69,6 +79,7 @@ skip_covered = true
 skip_empty = true
 precision = 2
 sort = "Cover"
+exclude_also  = ['@overload']
 [tool.coverage.xml]
 output = "coverage.xml"

{fameio-3.1.1 → fameio-3.3.0}/src/fameio/cli/convert_results.py RENAMED Viewed

@@ -1,8 +1,10 @@
-# SPDX-FileCopyrightText: 2024 German Aerospace Center <fame@dlr.de>
+# SPDX-FileCopyrightText: 2025 German Aerospace Center <fame@dlr.de>
 #
 # SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
 import argparse
-from typing import Any, Optional
+from typing import Any
 from fameio.cli.options import Options, ResolveOptions, TimeOptions
 from fameio.cli.parser import (
@@ -24,8 +26,8 @@ CLI_DEFAULTS = {
     Options.FILE: None,
     Options.LOG_LEVEL: "WARN",
     Options.LOG_FILE: None,
-    Options.AGENT_LIST: None,
     Options.OUTPUT: None,
+    Options.AGENT_LIST: None,
     Options.SINGLE_AGENT_EXPORT: False,
     Options.MEMORY_SAVING: False,
     Options.RESOLVE_COMPLEX_FIELD: ResolveOptions.SPLIT,
@@ -38,9 +40,8 @@ _INFILE_PATH_HELP = "Provide path to protobuf file"
 _OUTFILE_PATH_HELP = "Provide path to folder to store output .csv files"
-def handle_args(args: list[str], defaults: Optional[dict[Options, Any]] = None) -> dict[Options, Any]:
-    """
-    Handles command line arguments and returns `run_config` for convert_results script
+def handle_args(args: list[str], defaults: dict[Options, Any] | None = None) -> dict[Options, Any]:
+    """Handles command line arguments and returns `run_config` for convert_results script.
     Args:
         args: list of (command line) arguments, e.g., ['-f', 'my_file']; arg values take precedence over defaults
@@ -54,9 +55,8 @@ def handle_args(args: list[str], defaults: Optional[dict[Options, Any]] = None)
     return map_namespace_to_options_dict(parsed)
-def _prepare_parser(defaults: Optional[dict[Options, Any]]) -> argparse.ArgumentParser:
-    """
-    Creates a parser with given defaults to handle `make_config` configuration arguments
+def _prepare_parser(defaults: dict[Options, Any] | None) -> argparse.ArgumentParser:
+    """Creates a parser with given defaults to handle `make_config` configuration arguments.
     Returns:
         new parser using given defaults for its arguments; if a default is not specified, hard-coded defaults are used
@@ -80,5 +80,5 @@ def _prepare_parser(defaults: Optional[dict[Options, Any]]) -> argparse.Argument
 def _get_default(defaults: dict, option: Options) -> Any:
-    """Returns default for given `option` or its cli default"""
+    """Returns default for given `option` or its cli default."""
     return defaults.get(option, CLI_DEFAULTS[option])

{fameio-3.1.1 → fameio-3.3.0}/src/fameio/cli/make_config.py RENAMED Viewed

@@ -1,9 +1,11 @@
-# SPDX-FileCopyrightText: 2024 German Aerospace Center <fame@dlr.de>
+# SPDX-FileCopyrightText: 2025 German Aerospace Center <fame@dlr.de>
 #
 # SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
 import argparse
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any
 from fameio.cli.options import Options
 from fameio.cli.parser import (
@@ -31,9 +33,8 @@ _ENCODING_HELP = (
 )
-def handle_args(args: list[str], defaults: Optional[dict[Options, Any]] = None) -> dict[Options, Any]:
-    """
-    Converts given `arguments` and returns a configuration for the make_config script
+def handle_args(args: list[str], defaults: dict[Options, Any] | None = None) -> dict[Options, Any]:
+    """Converts given `args` and returns a configuration for the make_config script.
     Args:
         args: list of (command line) arguments, e.g., ['-f', 'my_file']; arg values take precedence over defaults
@@ -47,9 +48,8 @@ def handle_args(args: list[str], defaults: Optional[dict[Options, Any]] = None)
     return map_namespace_to_options_dict(parsed)
-def _prepare_parser(defaults: Optional[dict[Options, Any]]) -> argparse.ArgumentParser:
-    """
-    Creates a parser with given defaults to handle `make_config` configuration arguments
+def _prepare_parser(defaults: dict[Options, Any] | None) -> argparse.ArgumentParser:
+    """Creates a parser with given defaults to handle `make_config` configuration arguments.
     Returns:
         new parser using given defaults for its arguments; if a default is not specified, hard-coded defaults are used
@@ -65,5 +65,5 @@ def _prepare_parser(defaults: Optional[dict[Options, Any]]) -> argparse.Argument
 def _get_default(defaults: dict, option: Options) -> Any:
-    """Returns default for given `option` or, if missing, its cli default"""
+    """Returns default for given `option` or, if missing, its cli default."""
     return defaults.get(option, CLI_DEFAULTS[option])

{fameio-3.1.1 → fameio-3.3.0}/src/fameio/cli/options.py RENAMED Viewed

@@ -6,7 +6,7 @@ from enum import Enum, auto
 class ParsableEnum(Enum):
-    """Extend this to create an enum that can be parsed with argparse"""
+    """Extend this to create an enum that can be parsed with argparse."""
     @classmethod
     def instantiate(cls, name: str) -> Enum:
@@ -20,7 +20,7 @@ class ParsableEnum(Enum):
 class Options(Enum):
-    """Specifies command line configuration options"""
+    """Specifies command line configuration options."""
     FILE = auto()
     LOG_LEVEL = auto()
@@ -34,10 +34,12 @@ class Options(Enum):
     TIME_MERGING = auto()
     INPUT_RECOVERY = auto()
     INPUT_ENCODING = auto()
+    FILE_PATTERN = auto()
+    REPLACE = auto()
 class TimeOptions(ParsableEnum, Enum):
-    """Specifies options for conversion of time in output"""
+    """Specifies options for conversion of time in output."""
     INT = auto()
     UTC = auto()
@@ -45,7 +47,7 @@ class TimeOptions(ParsableEnum, Enum):
 class ResolveOptions(ParsableEnum, Enum):
-    """Specifies options for resolving complex fields in output files"""
+    """Specifies options for resolving complex fields in output files."""
     IGNORE = auto()
     SPLIT = auto()

fameio 3.1.1__tar.gz → 3.3.0__tar.gz

fameio 3.1.1tar.gz → 3.3.0tar.gz