PyPI - fameio - Versions diffs - 2.0.0__tar.gz → 2.1.1__tar.gz - Mend

fameio 2.0.0tar.gz → 2.1.1tar.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 (53) hide show

{fameio-2.0.0 → fameio-2.1.1}/CHANGELOG.md RENAMED Viewed

@@ -1,10 +1,33 @@
-<!-- SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
+<!-- SPDX-FileCopyrightText: 2024 German Aerospace Center <fame@dlr.de>
 SPDX-License-Identifier: CC0-1.0 -->
 # Changelog
+## [2.1.1](https://gitlab.com/fame-framework/fame-io/-/tags/v2.1.1) - 2024-05-28
+### Fixed
+- ConvertFameResults: Fix crash on complex column conversion if Agent has no simple columns #204 (@dlr_fn @dlr-cjs)
+## [2.1.0](https://gitlab.com/fame-framework/fame-io/-/tags/v2.1.0) - 2024-05-11
+### Changed
+- Changed format of auto-created timeseries from constant values #196 (@dlr-cjs)
+- Changed default log level to "WARNING" #191 (@dlr_fn @dlr-cjs)
+- Adapted link-formatting in Changelog !155 (@dlr-cjs)
+### Added
+- Read java package names from Schema and write to input.pb #198 (@dlr-cjs)
+### Fixed
+- Fix docstrings in CLI `handle_args()` #190 (@dlr-cjs @dlr_fn)
+- Fix potential duplicates in logging #191 (@dlr_fn @dlr-cjs)
+## [2.0.1](https://gitlab.com/fame-framework/fame-io/-/tags/v2.0.1) - 2024-04-05
+### Fix
+- Fix potential missing columns when memory-saving-mode `-m` is enabled #194 (@dlr_fn @dlr-cjs)
+### Remove
+- Remove convert results option `-cc MERGE` #194 (@dlr_fn @dlr-cjs)
-## [2.0.0 - 2024-04-03](https://gitlab.com/fame-framework/fame-io/-/tags/v2.0.0)
+## [2.0.0](https://gitlab.com/fame-framework/fame-io/-/tags/v2.0.0) - 2024-04-03
 ### Changed
 - **Breaking**: Removed support for `python==3.8` #163 (@dlr-cjs @dlr_fn)
 - **Breaking**: Signature of `run` functions in `make_config.py` and `convert_results.py` changed: the input file is now read from the configuration dictionary #163 (@dlr-cjs @dlr_fn)
@@ -45,11 +68,11 @@ SPDX-License-Identifier: CC0-1.0 -->
 - Fix breaking tests in Pytest 8.0 #176 (@dlr-cjs)
 - Fix PyTests for Python 3.12 #182 (@dlr_fn)
-## [1.8.1 - 2023-05-04](https://gitlab.com/fame-framework/fame-io/-/tags/v1.8.1)
+## [1.8.1](https://gitlab.com/fame-framework/fame-io/-/tags/v1.8.1) - 2023-05-04
 ### Fixed
 - Fix fail of `ConvertFameResults` when `merge-times` was not specified
-## [1.8.0 - 2023-04-14](https://gitlab.com/fame-framework/fame-io/-/tags/v1.8)
+## [1.8.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.8) - 2023-04-14
 ### Changed
 - Update repository to be compliant to `REUSE` standard
 - Accept custom `date_format` (default: `"%Y-%m-%d_%H:%M:%S"`) for `FameTime.convert_fame_time_step_to_datetime()`
@@ -61,7 +84,7 @@ SPDX-License-Identifier: CC0-1.0 -->
 - Add option to merge time steps in results with `convertFameResults`
 - Add pre-commit hooks enforcing high coding standards and reducing CI runner minutes during development
-## [1.7.0 - 2023-02-20](https://gitlab.com/fame-framework/fame-io/-/tags/v1.7)
+## [1.7.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.7) - 2023-02-20
 ### Added
 - Support dictionaries in Schema for field `Products` in elements of `AgentTypes`
 - Support dictionaries in Schema for field `Values` in elements of `Attributes`
@@ -73,15 +96,15 @@ SPDX-License-Identifier: CC0-1.0 -->
 ### Remove
 - **Breaking**: `Products` in Schema no longer support single non-list values
-## [1.6.3 - 2022-11-04](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6.3)
+## [1.6.3](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6.3) - 2022-11-04
 ### Added
 - Allow parsing `Help` for `Attributes` in `schema`
-## [1.6.1 - 2022-11-02](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6.1)
+## [1.6.1](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6.1) - 2022-11-02
 ### Changed
 - Use existing logger if already set up to avoid duplicates when `fameio` is used as dependency in third party workflows
-## [1.6.0 - 2022-07-08](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6)
+## [1.6.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6) - 2022-07-08
 ### Added
 - Add option to enable memory saving mode using the flag `-m` or `--memory-saving`
 - Add options to deal with complex indexed output columns using the flag `-cc` or `--complex-column` with
@@ -94,23 +117,23 @@ SPDX-License-Identifier: CC0-1.0 -->
 - Reduce memory profile for `convertFameResults`
 - Extract `source` scripts relevant for `convertFameResults` to be hosted in subpackage `results`
-## [1.5.4 - 2022-06-01](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.4)
+## [1.5.4](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.4) - 2022-06-01
 ### Changed
 - Limit `protobuf` dependency to `>=3.19,<4.0`
-## [1.5.3 - 2022-03-18](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.3)
+## [1.5.3](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.3) - 2022-03-18
 ### Changed
 - Harmonize interface with `famegui`
 - Return `None` on failure of `resolve_series_file_path` instead of raising a `FileNotFoundError`
-## [1.5.2 - 2022-03-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.2)
+## [1.5.2](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.2) - 2022-03-10
 ### Changed
 - Allow interfacing of `famegui` with `scenario` (e.g. serialization, error handling)
 - Move `scenario` validation to `validator.py`
 - Extract `path_resolver.py`
 - Increase test coverage by incorporating [AMIRIS examples](https://gitlab.com/dlr-ve/esy/amiris/examples)
-## [1.5.1 - 2022-01-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.1)
+## [1.5.1](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.1) - 2022-01-10
 ### Added
 - Provide documentation on installation using `pipx`
 - Add optional argument `-se`/`--singleexport` for exporting individual files for each agent
@@ -120,7 +143,7 @@ SPDX-License-Identifier: CC0-1.0 -->
 - Refactor `scenario.py`
 - Ensure code formatting using `black`
-## [1.5.0 - 2021-06-30](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5)
+## [1.5.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5) - 2021-06-30
 ### Added
 - Support specifying an output folder in command line interface of `convert_results.py`
@@ -128,7 +151,7 @@ SPDX-License-Identifier: CC0-1.0 -->
 - Update to latest protobuf package
 - Refactor code
-## [1.4.0 - 2021-06-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.4)
+## [1.4.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.4) - 2021-06-10
 ### Added
 - Enable "Default" values for Attributes - these are used in case a mandatory attribute is not specified in the Scenario
 - Allow "List" Attributes with multiple values
@@ -145,7 +168,7 @@ SPDX-License-Identifier: CC0-1.0 -->
 ### Fixed
 - Fixed minor bugs
-## [1.3.0 - 2021-04-13](https://gitlab.com/fame-framework/fame-io/-/tags/v1.3)
+## [1.3.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.3) - 2021-04-13
 ### Added
 - Enable `Attributes` in agents (formerly known as `Fields`) to be structured in complex tree-like data dictionaries
 - Allow contracts to support `Attributes` of type `int`, `float`, `enum` or `dict`
@@ -160,26 +183,26 @@ SPDX-License-Identifier: CC0-1.0 -->
 - Raise critical error when trying to convert empty protobuf output file
 - Check if `product` in `contract` is valid according to `schema.yaml`
-## [1.2.4 - 2021-02-26](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.4)
+## [1.2.4](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.4) - 2021-02-26
 ### Changed
 - Move `is_compatible` function to class `AttributeType`
-## [1.2.3 - 2021-02-24](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.3)
+## [1.2.3](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.3) - 2021-02-24
 ### Fixed
 - Fix file prefix `IGNORE_` (used when loading a set of contract files with the !include argument) is now working consistently
-## [1.2.2 - 2021-02-18](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.2)
+## [1.2.2](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.2) - 2021-02-18
 ### Changed
 - **Breaking**: Rename `fieldtype` to `attributetype` in `schema.yaml`
 - Derive protobuf imports from `fameprotobuf` package
 - Improve handling of cases for keys in `scenario.yaml`
 - Improve handling of time stamp strings
-## [1.2.1 - 2021-02-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.1)
+## [1.2.1](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.1) - 2021-02-10
 ### Changed
 - Improve key handling for contracts which are now case-insensitive
-## [1.2.0 - 2021-02-04](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2)
+## [1.2.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2) - 2021-02-04
 ### Added
 - Add `!include` command to yaml loading to allow integrating additional yaml files
@@ -192,7 +215,7 @@ SPDX-License-Identifier: CC0-1.0 -->
 ### Fixed
 - Fix bugs
-## [1.1.0 - 2020-12-09](https://gitlab.com/fame-framework/fame-io/-/tags/v1.1)
+## [1.1.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.1) - 2020-12-09
 ### Added
 - Package to PyPI
 - Provide executables for calling `makeFameRunConfig` and `convertFameResults`
@@ -200,5 +223,5 @@ SPDX-License-Identifier: CC0-1.0 -->
 ### Changed
 - Improve documentation
-## [1.0.0 - 2020-11-17](https://gitlab.com/fame-framework/fame-io/-/tags/v1.0)
+## [1.0.0](https://gitlab.com/fame-framework/fame-io/-/tags/v1.0) - 2020-11-17
 _Initial release of `famepy`_

{fameio-2.0.0 → fameio-2.1.1}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fameio
-Version: 2.0.0
+Version: 2.1.1
 Summary: Python scripts for operation of FAME models
 Home-page: https://gitlab.com/fame-framework/wiki/-/wikis/home
 License: Apache-2.0
@@ -21,13 +21,13 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
-Requires-Dist: fameprotobuf (>=1.4.0,<2.0.0)
+Requires-Dist: fameprotobuf (>=1.5.0,<2.0.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/
 Description-Content-Type: text/markdown
-<!-- SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
+<!-- SPDX-FileCopyrightText: 2024 German Aerospace Center <fame@dlr.de>
 SPDX-License-Identifier: Apache-2.0 -->
 [![PyPI version](https://badge.fury.io/py/fameio.svg)](https://badge.fury.io/py/fameio)
@@ -129,33 +129,45 @@ The "scenario.yaml" file contains all configuration options for a FAME-based sim
 It consists of the sections `Schema`, `GeneralProperties`, `Agents` and `Contracts`, all of them described below.
 #### Schema
-The Schema is used to validate the inputs of the "scenario.yaml".
-Since the Schema should be valid across multiple scenarios, it is recommended to defined it in a separate file and include the file here.
+The Schema describes a model's components such as its types of agents, their inputs, what data they exchange, etc.
+It is also used to validate the model inputs provided in the `scenario.yaml`.
+Since the Schema is valid until the model itself is changed, it is recommended to defined it in a separate file and include the file here.
 Currently, the schema specifies:
 * which type of Agents can be created
 * what type of input attributes an Agent uses
-* what type of Products an Agent can send in Contracts.
+* what type of Products an Agent can send in Contracts, and
+* the names of the Java packages for the classes corresponding to Agents, DataItems and Portables.
-The Schema consists of the sections `Header` and `AgentTypes`.
+The Schema consists of the sections `JavaPackages` and `AgentTypes`.
-##### Header
-Scientific applications often evolve, and so do their required input parameters.
-Therefore, the header specifies information what FAME-based application the schema is corresponding to.
-In this way a schema.yaml is tied to a specific version an application, ensuring a match between the inputs required by
-the application, and those provided by the files created with FAME-Io.
+##### JavaPackages
+This section defines the name of the Java packages in which the model code is located.
+A similar data set was formerly specified in the `fameSetup.yaml`, but is now specified in the schema.
+Each of the three sections `Agents`, `DataItems`, and `Portables` contain a list of fully qualified java package names of your model's classes.
+Package names can occur in multiple lists and may overlap.
+It is not necessary (but possible) to specify the nearest enclosing package for each Agent, DataItem or Portable.
+Specifying any super-package will also work.
+Also, package names occur on multiple lists for Agent, DataItem or Portable.
+For example, for a project with all its
+* Agent-derived java classes located in packages below the package named "agents",
+* DataItem implementation classes in a subpackage named "msg",
+* Portable implementation classes in a subpackages named "portableItems" and "otherPortables",
+the corresponding section in the schema would look like this:
 ```yaml
-Header:
-  Project: MyProjectName
-  RepoUrl: https://mygithosting.com/myProject
-  CommitHash: abc123
+JavaPackages:
+  Agents:
+    - "agents"
+  DataItems:
+    - "msg"
+  Portables:
+    - "portableItems"
+    - "otherPortables"
 ```
-* `Project` name of your project / FAME-based application
-* `RepoUrl` URL of your project
-* `CommitHash` hash of the commit / version of your project
 ##### AgentTypes
 Here, each type of agent that can be created in your FAME-based application is listed, its attributes and its available Products for Contracts.
 The structure of this section
@@ -585,17 +597,17 @@ Call structure:
 You may also specify any of the following arguments:
-| Command                                     | Action                                                                                                                                                                                                                                              |
-|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `-l` or `--log` <option>                    | Sets the logging level. Default is `info`. Options are `debug`, `info`, `warning`, `warn`, `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.                                                                                                                                          |
-| `-a` or `--agents` <list-of-agents>         | If specified, only a subset of agents is extracted from the protobuf file. Default is to extract all agents.                                                                                                                                        |
-| `-o` or `--output`                          | Sets the path to where the generated output files are written to. If not specified, the folder's name is derived from the input file's name. Folder will be created if it does not exist.                                                           |
-| `-se` or `--single-export`                  | Enables export of individual agents to individual files, when present. If not present (the default) one file per `AgentType` is created.                                                                                                            |
-| `-m` or `--memory-saving`                   | When specified, reduces memory usage profile at the cost of runtime. Use only when necessary.                                                                                                                                                       |
-| `-cc` or `--complex-column` <option>        | Defines how to deal with complex indexed output columns (if any). `IGNORE` ignores complex columns. `MERGE` squashes all data from complex columns in one big string entry. `SPLIT` creates a separate file for each complex indexed output column. |
-| `-t` or `--time` <option>                   | Option to define conversion of time steps to given format (default=`UTC`) by `-t/--time {UTC, INT, FAME}`                                                                                                                                           |
-| `--input-recovery` or `--no-input-recovery` | If True, all input data are recovered as well as the outputs (default=False).                                                                                                                                                                       |
+| 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.                                                                                |
+| `-a` or `--agents` <list-of-agents>         | If specified, only a subset of agents is extracted from the protobuf file. Default is to extract all agents.                                                                              |
+| `-o` or `--output`                          | Sets the path to where the generated output files are written to. If not specified, the folder's name is derived from the input file's name. Folder will be created if it does not exist. |
+| `-se` or `--single-export`                  | Enables export of individual agents to individual files, when present. If not present (the default) one file per `AgentType` is created.                                                  |
+| `-m` or `--memory-saving`                   | When specified, reduces memory usage profile at the cost of runtime. Use only when necessary.                                                                                             |
+| `-cc` or `--complex-column` <option>        | Defines how to deal with complex indexed output columns (if any). `IGNORE` ignores complex columns. `SPLIT` creates a separate file for each complex indexed output column.               |
+| `-t` or `--time` <option>                   | Option to define conversion of time steps to given format (default=`UTC`) by `-t/--time {UTC, INT, FAME}`                                                                                 |
+| `--input-recovery` or `--no-input-recovery` | If True, all input data are recovered as well as the outputs (default=False).                                                                                                             |
 Additionally, you may merge TimeSteps of a certain range of steps in the output files to
 i) associate multiple time steps with a common logical time in your simulation

{fameio-2.0.0 → fameio-2.1.1}/README.md RENAMED Viewed

@@ -1,4 +1,4 @@
-<!-- SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
+<!-- SPDX-FileCopyrightText: 2024 German Aerospace Center <fame@dlr.de>
 SPDX-License-Identifier: Apache-2.0 -->
 [![PyPI version](https://badge.fury.io/py/fameio.svg)](https://badge.fury.io/py/fameio)
@@ -100,33 +100,45 @@ The "scenario.yaml" file contains all configuration options for a FAME-based sim
 It consists of the sections `Schema`, `GeneralProperties`, `Agents` and `Contracts`, all of them described below.
 #### Schema
-The Schema is used to validate the inputs of the "scenario.yaml".
-Since the Schema should be valid across multiple scenarios, it is recommended to defined it in a separate file and include the file here.
+The Schema describes a model's components such as its types of agents, their inputs, what data they exchange, etc.
+It is also used to validate the model inputs provided in the `scenario.yaml`.
+Since the Schema is valid until the model itself is changed, it is recommended to defined it in a separate file and include the file here.
 Currently, the schema specifies:
 * which type of Agents can be created
 * what type of input attributes an Agent uses
-* what type of Products an Agent can send in Contracts.
+* what type of Products an Agent can send in Contracts, and
+* the names of the Java packages for the classes corresponding to Agents, DataItems and Portables.
-The Schema consists of the sections `Header` and `AgentTypes`.
+The Schema consists of the sections `JavaPackages` and `AgentTypes`.
-##### Header
-Scientific applications often evolve, and so do their required input parameters.
-Therefore, the header specifies information what FAME-based application the schema is corresponding to.
-In this way a schema.yaml is tied to a specific version an application, ensuring a match between the inputs required by
-the application, and those provided by the files created with FAME-Io.
+##### JavaPackages
+This section defines the name of the Java packages in which the model code is located.
+A similar data set was formerly specified in the `fameSetup.yaml`, but is now specified in the schema.
+Each of the three sections `Agents`, `DataItems`, and `Portables` contain a list of fully qualified java package names of your model's classes.
+Package names can occur in multiple lists and may overlap.
+It is not necessary (but possible) to specify the nearest enclosing package for each Agent, DataItem or Portable.
+Specifying any super-package will also work.
+Also, package names occur on multiple lists for Agent, DataItem or Portable.
+For example, for a project with all its
+* Agent-derived java classes located in packages below the package named "agents",
+* DataItem implementation classes in a subpackage named "msg",
+* Portable implementation classes in a subpackages named "portableItems" and "otherPortables",
+the corresponding section in the schema would look like this:
 ```yaml
-Header:
-  Project: MyProjectName
-  RepoUrl: https://mygithosting.com/myProject
-  CommitHash: abc123
+JavaPackages:
+  Agents:
+    - "agents"
+  DataItems:
+    - "msg"
+  Portables:
+    - "portableItems"
+    - "otherPortables"
 ```
-* `Project` name of your project / FAME-based application
-* `RepoUrl` URL of your project
-* `CommitHash` hash of the commit / version of your project
 ##### AgentTypes
 Here, each type of agent that can be created in your FAME-based application is listed, its attributes and its available Products for Contracts.
 The structure of this section
@@ -556,17 +568,17 @@ Call structure:
 You may also specify any of the following arguments:
-| Command                                     | Action                                                                                                                                                                                                                                              |
-|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `-l` or `--log` <option>                    | Sets the logging level. Default is `info`. Options are `debug`, `info`, `warning`, `warn`, `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.                                                                                                                                          |
-| `-a` or `--agents` <list-of-agents>         | If specified, only a subset of agents is extracted from the protobuf file. Default is to extract all agents.                                                                                                                                        |
-| `-o` or `--output`                          | Sets the path to where the generated output files are written to. If not specified, the folder's name is derived from the input file's name. Folder will be created if it does not exist.                                                           |
-| `-se` or `--single-export`                  | Enables export of individual agents to individual files, when present. If not present (the default) one file per `AgentType` is created.                                                                                                            |
-| `-m` or `--memory-saving`                   | When specified, reduces memory usage profile at the cost of runtime. Use only when necessary.                                                                                                                                                       |
-| `-cc` or `--complex-column` <option>        | Defines how to deal with complex indexed output columns (if any). `IGNORE` ignores complex columns. `MERGE` squashes all data from complex columns in one big string entry. `SPLIT` creates a separate file for each complex indexed output column. |
-| `-t` or `--time` <option>                   | Option to define conversion of time steps to given format (default=`UTC`) by `-t/--time {UTC, INT, FAME}`                                                                                                                                           |
-| `--input-recovery` or `--no-input-recovery` | If True, all input data are recovered as well as the outputs (default=False).                                                                                                                                                                       |
+| 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.                                                                                |
+| `-a` or `--agents` <list-of-agents>         | If specified, only a subset of agents is extracted from the protobuf file. Default is to extract all agents.                                                                              |
+| `-o` or `--output`                          | Sets the path to where the generated output files are written to. If not specified, the folder's name is derived from the input file's name. Folder will be created if it does not exist. |
+| `-se` or `--single-export`                  | Enables export of individual agents to individual files, when present. If not present (the default) one file per `AgentType` is created.                                                  |
+| `-m` or `--memory-saving`                   | When specified, reduces memory usage profile at the cost of runtime. Use only when necessary.                                                                                             |
+| `-cc` or `--complex-column` <option>        | Defines how to deal with complex indexed output columns (if any). `IGNORE` ignores complex columns. `SPLIT` creates a separate file for each complex indexed output column.               |
+| `-t` or `--time` <option>                   | Option to define conversion of time steps to given format (default=`UTC`) by `-t/--time {UTC, INT, FAME}`                                                                                 |
+| `--input-recovery` or `--no-input-recovery` | If True, all input data are recovered as well as the outputs (default=False).                                                                                                             |
 Additionally, you may merge TimeSteps of a certain range of steps in the output files to
 i) associate multiple time steps with a common logical time in your simulation

{fameio-2.0.0 → fameio-2.1.1}/pyproject.toml RENAMED Viewed

@@ -7,7 +7,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "fameio"
-version = "2.0.0"
+version = "2.1.1"
 description = "Python scripts for operation of FAME models"
 license = "Apache-2.0"
 authors = [
@@ -35,7 +35,7 @@ include = ["CHANGELOG.md"]
 [tool.poetry.dependencies]
 python = "^3.9"
-fameprotobuf = "^1.4.0"
+fameprotobuf = "^1.5.0"
 pandas = ">= 1.0, <3.0"
 pyyaml = "^6.0"

{fameio-2.0.0 → fameio-2.1.1}/src/fameio/scripts/convert_results.py RENAMED Viewed

@@ -6,7 +6,7 @@ from pathlib import Path
 from fameio.source.cli.convert_results import handle_args, CLI_DEFAULTS as DEFAULT_CONFIG
 from fameio.source.cli.options import Options
 from fameio.source.cli.parser import update_default_config
-from fameio.source.logs import log_and_raise_critical, set_up_logger, logger
+from fameio.source.logs import log_and_raise_critical, fameio_logger, log
 from fameio.source.results.agent_type import AgentTypeLog
 from fameio.source.results.conversion import apply_time_option, apply_time_merging
 from fameio.source.results.csv_writer import CsvWriter
@@ -23,16 +23,16 @@ ERR_MEMORY_SEVERE = "Out of memory despite memory-saving mode. Reduce output int
 def run(config: dict = None) -> None:
     """Reads file in protobuf format for configures FILE and extracts its content to .csv file(s)"""
     config = update_default_config(config, DEFAULT_CONFIG)
-    set_up_logger(level_name=config[Options.LOG_LEVEL], file_name=config[Options.LOG_FILE])
+    fameio_logger(log_level_name=config[Options.LOG_LEVEL], file_name=config[Options.LOG_FILE])
     file_path = config[Options.FILE]
     output_writer = CsvWriter(config[Options.OUTPUT], Path(file_path), config[Options.SINGLE_AGENT_EXPORT])
     file_stream = open(Path(file_path), "rb")
     if config[Options.MEMORY_SAVING]:
-        logger().info("Memory saving mode enabled: Disable on conversion of small files for performance improvements.")
+        log().info("Memory saving mode enabled: Disable on conversion of small files for performance improvements.")
-    logger().info("Reading and extracting data...")
+    log().info("Reading and extracting data...")
     reader = Reader.get_reader(file=file_stream, read_single=config[Options.MEMORY_SAVING])
     agent_type_log = AgentTypeLog(requested_agents=config[Options.AGENT_LIST])
     data_transformer = DataTransformer.build(config[Options.RESOLVE_COMPLEX_FIELD])
@@ -43,27 +43,27 @@ def run(config: dict = None) -> None:
                 input_dao.store_inputs(data_storages)
             output = OutputDAO(data_storages, agent_type_log)
             for agent_name in output.get_sorted_agents_to_extract():
-                logger().debug(f"Extracting data for {agent_name}...")
+                log().debug(f"Extracting data for {agent_name}...")
                 data_frames = output.get_agent_data(agent_name, data_transformer)
                 apply_time_merging(data_frames, config[Options.TIME_MERGING])
                 apply_time_option(data_frames, config[Options.TIME])
-                logger().debug(f"Writing data for {agent_name}...")
+                log().debug(f"Writing data for {agent_name}...")
                 output_writer.write_to_files(agent_name, data_frames)
         if config[Options.INPUT_RECOVERY]:
-            logger().info("Recovering inputs...")
+            log().info("Recovering inputs...")
             timeseries, scenario = input_dao.recover_inputs()
             series_writer = CsvWriter(Path(config[Options.OUTPUT], "./recovered"), Path("./"), False)
             series_writer.write_time_series_to_disk(timeseries)
             data_to_yaml_file(scenario.to_dict(), Path(config[Options.OUTPUT], "./recovered/scenario.yaml"))
-        logger().info("Data conversion completed.")
+        log().info("Data conversion completed.")
     except MemoryError:
         log_and_raise_critical(ERR_MEMORY_SEVERE if Options.MEMORY_SAVING else ERR_MEMORY_ERROR)
     file_stream.close()
     if not agent_type_log.has_any_agent_type():
-        logger().error("Provided file did not contain any output data.")
+        log().error("Provided file did not contain any output data.")
 if __name__ == "__main__":

{fameio-2.0.0 → fameio-2.1.1}/src/fameio/scripts/make_config.py RENAMED Viewed

@@ -6,7 +6,7 @@ from fameio.source.cli.make_config import handle_args, CLI_DEFAULTS as DEFAULT_C
 from fameio.source.cli.options import Options
 from fameio.source.cli.parser import update_default_config
 from fameio.source.loader import load_yaml, check_for_yaml_file_type
-from fameio.source.logs import set_up_logger, logger
+from fameio.source.logs import fameio_logger, log
 from fameio.source.scenario import Scenario
 from fameio.source.validator import SchemaValidator
 from fameio.source.writer import ProtoWriter
@@ -15,7 +15,7 @@ from fameio.source.writer import ProtoWriter
 def run(config: dict = None) -> None:
     """Executes the main workflow for the building of a FAME configuration file"""
     config = update_default_config(config, DEFAULT_CONFIG)
-    set_up_logger(level_name=config[Options.LOG_LEVEL], file_name=config[Options.LOG_FILE])
+    fameio_logger(log_level_name=config[Options.LOG_LEVEL], file_name=config[Options.LOG_FILE])
     file = config[Options.FILE]
     check_for_yaml_file_type(Path(file))
@@ -26,7 +26,7 @@ def run(config: dict = None) -> None:
     writer = ProtoWriter(config[Options.OUTPUT], timeseries_manager)
     writer.write_validated_scenario(scenario)
-    logger().info("Configuration completed.")
+    log().info("Configuration completed.")
 if __name__ == "__main__":

{fameio-2.0.0 → fameio-2.1.1}/src/fameio/source/cli/convert_results.py RENAMED Viewed

@@ -22,7 +22,7 @@ from fameio.source.cli.parser import (
 CLI_DEFAULTS = {
     Options.FILE: None,
-    Options.LOG_LEVEL: "info",
+    Options.LOG_LEVEL: "WARN",
     Options.LOG_FILE: None,
     Options.AGENT_LIST: None,
     Options.OUTPUT: None,
@@ -39,7 +39,16 @@ _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 `input_file` and `run_config` for convert_results script"""
+    """
+    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
+        defaults: optional default values used for unspecified parameters; missing defaults are replaced by CLI defaults
+    Returns:
+        final configuration compiled from (given) `defaults` and given `args`
+    """
     parser = _prepare_parser(defaults)
     parsed = parser.parse_args(args)
     return map_namespace_to_options_dict(parsed)

{fameio-2.0.0 → fameio-2.1.1}/src/fameio/source/cli/make_config.py RENAMED Viewed

@@ -16,7 +16,7 @@ from fameio.source.cli.parser import (
 CLI_DEFAULTS = {
     Options.FILE: None,
-    Options.LOG_LEVEL: "info",
+    Options.LOG_LEVEL: "WARN",
     Options.LOG_FILE: None,
     Options.OUTPUT: Path("config.pb"),
 }
@@ -34,7 +34,7 @@ def handle_args(args: List[str], defaults: Optional[Dict[Options, Any]] = None)
         defaults: optional default values used for unspecified parameters; missing defaults are replaced by CLI defaults
     Returns:
-        final configuration compiled from (given) defaults and
+        final configuration compiled from (given) `defaults` and given `args`
     """
     parser = _prepare_parser(defaults)
     parsed = parser.parse_args(args)

{fameio-2.0.0 → fameio-2.1.1}/src/fameio/source/cli/options.py RENAMED Viewed

@@ -48,7 +48,6 @@ class ResolveOptions(ParsableEnum, Enum):
     IGNORE = auto()
     SPLIT = auto()
-    MERGE = auto()
 class MergingOptions(Enum):

{fameio-2.0.0 → fameio-2.1.1}/src/fameio/source/cli/parser.py RENAMED Viewed

@@ -8,7 +8,7 @@ from pathlib import Path
 from typing import Optional, Dict, Any, List, Union
 from fameio.source.cli.options import MergingOptions, TimeOptions, ResolveOptions, Options
-from fameio.source.logs import LOG_LEVELS
+from fameio.source.logs import LogLevel
 _ERR_NEGATIVE_INT = "Given value `{}` is not a non-negative int."
@@ -74,8 +74,8 @@ def add_log_level_argument(parser: ArgumentParser, default_value: str) -> None:
         "-l",
         "--log",
         default=default_value,
-        choices=list(LOG_LEVELS.keys()),
-        type=str.lower,
+        choices=[level.name for level in LogLevel if level not in [LogLevel.PRINT, LogLevel.WARN]],
+        type=str.upper,
         help=help_text,
     )

fameio 2.0.0__tar.gz → 2.1.1__tar.gz

fameio 2.0.0tar.gz → 2.1.1tar.gz