fameio 2.3.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

{fameio-2.3.0.dist-info → fameio-3.0.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: fameio
-Version: 2.3.0
-Summary: Python scripts for operation of FAME models
+Version: 3.0.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
@@ -21,7 +21,7 @@ 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.5.0,<2.0.0)
+Requires-Dist: fameprotobuf (>=2.0.2,<3.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/
@@ -42,17 +42,21 @@ SPDX-License-Identifier: Apache-2.0 -->
 ![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)
 
-
 # FAME-Io
-Python scripts for FAME models, generation of protobuf input files and conversion of protobuf output files.
+
+*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.
 
 # Installation
+
 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
 
@@ -60,15 +64,21 @@ You may also use `pipx`. For detailed information please refer to the official `
 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.
 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.
 
-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>
@@ -94,7 +104,8 @@ from fameio.scripts.make_config import Options, run as make_config
 make_config({Options.FILE: "path/to/scenario.yaml", })
 ```
 
-Similar to the console call you may also specify custom run config arguments and add it in a dictionary to the function call.
+Similar to the console call you may also specify custom run config arguments and add it in a dictionary to the function
+call.
 
 ```python
 from fameio.scripts.make_config import Options, run as make_config
@@ -112,13 +123,13 @@ You can also use the associated argument parser, to extract the run_config dynam
 
 ```python
 from fameio.scripts.make_config import Options, run as make_config
-from fameio.source.cli.make_config import handle_args
+from fameio.cli.make_config import handle_args
 
 my_defaults = {Options.FILE: "path/to/scenario.yaml",
-                 Options.LOG_LEVEL: "info",
-                 Options.OUTPUT: "output.pb",
-                 Options.LOG_FILE: "scenario.log",
-                 }
+               Options.LOG_LEVEL: "info",
+               Options.OUTPUT: "output.pb",
+               Options.LOG_FILE: "scenario.log",
+               }
 my_arg_string = ['-f', 'my/other/scenario.yaml', '-l', 'error']
 
 run_config = handle_args(my_arg_string, my_defaults)
@@ -126,16 +137,21 @@ make_config(run_config)
 ```
 
 ### Scenario YAML
+
 The "scenario.yaml" file contains all configuration options for a FAME-based simulation.
-It consists of the sections `Schema`, `GeneralProperties`, `Agents` and `Contracts`, and the optional section `StringSets`.
+It consists of the sections `Schema`, `GeneralProperties`, `Agents` and `Contracts`, and the optional
+section `StringSets`.
 All of them are described below.
 
 #### Schema
+
 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.
+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, and
@@ -144,15 +160,18 @@ Currently, the schema specifies:
 The Schema consists of the sections `JavaPackages` and `AgentTypes`.
 
 ##### 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.
+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",
@@ -170,8 +189,12 @@ JavaPackages:
     - "otherPortables"
 ```
 
+One can leave out the `DataItems` specifications, but `Agents` and `Portables` are required and must not be empty.
+
 ##### 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.
+
+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
 
 ```yaml
@@ -183,18 +206,49 @@ AgentTypes:
       MyOtherAttribute:
         ...
     Products: [ 'Product1', 'Product2', 'Product3' ]
+    Outputs: [ 'Column1', 'Column2', 'Column3' ]
+    Metadata:
+      Some: "Dict with Metadata that you would like to add"
   MyOtherAgentWithoutProductsOrAttributes:
 ```
 
 * `MyAgentType` Java's simple class name of the Agent type
 * `Attributes` indicates that beginning of the attribute definition section for this Agent type
-* `MyAttribute` Name of an attribute as specified in the corresponding Java source code of this Agent type (annotated with "@Input")
+* `MyAttribute` Name of an attribute as specified in the corresponding Java source code of this Agent type (annotated
+  with "@Input")
 * `MyOtherAttribute` Name of another attribute derived from Java source code
-* `Products` list of Products that this Agent can send in Contracts; derived from Java source code of this Agent type (annotated with "@Product")
+* `Products` list or dictionary of Products that this Agent can send in Contracts; derived from Java source code of this
+  Agent type (annotated with "@Product")
+* `Outputs` list or dictionary of Output columns that this Agent can write to; derived from Java source code of this
+  Agent type (annotated with "@Output")
+* `Metadata` dictionary with any content that is assigned to this Agent type as additional information
 * `MyOtherAgentWithoutProductsOrAttributes` an Agent type that requires neither Attributes nor Products
 
-Both Attributes and Products are optional - there could be useful Agents that require neither of them.
-In the above example attribute definition was not shown (indicated by `...`).
+Attributes, Products, Outputs and Metadata are optional - there may be useful Agents that require none of them.
+Products and Outputs can both be lists of Strings, or dictionaries with additional Metadata.
+For example, you could write the above in the following way:
+
+```yaml
+Products:
+  Product1:
+    Metadata:
+      Any: "information you would like to add to Product1 using a dictionary form"
+  Product2:
+  Product3:
+Outputs:
+  Column1:
+  Column2:
+    ThisEntry: "is ignored, as it is not below the keyword: 'Metadata'"
+    Metadata:
+      My: "Metadata"
+      That: "will be saved to Column2"
+  Column3:
+```
+
+Here, "Product1" and "Column2" have additional, optional Metadata assigned to them (using the keyword "Metadata").
+The other Products and Columns have no metadata assigned to them - which is also ok.
+
+In the AgentType definition example above attribute definition was not shown explicitly (indicated by `...`).
 The next example provides details on how to define an attribute:
 
 ```yaml
@@ -205,29 +259,48 @@ MySimpleAttribute:
   Values: [ 'AllowedValue1', 'AllowedValue2' ]
   Default: 'AllowedValue1'
   Help: 'My help text'
+  Metadata:
+    Go: "here"
 
 MyComplexAttribute:
   AttributeType: block
   NestedAttributes:
     InnerAttributeA:
       AttributeType: integer
+      Values:
+        1:
+          Metadata:
+            Explain: "1 is a allowed value"
+        2:
+          Metadata:
+            Comment: "2 is also allowed, but consider using 1"
     InnerAttributeB:
       AttributeType: double
 ```
 
-* `MySimpleAttribute`, `MyDoubleList`, `MyComplexAttribute` Names of the attributes as specified in the Java enum annotated with "@Input"
+* `MySimpleAttribute`, `MyDoubleList`, `MyComplexAttribute` Names of the attributes as specified in the Java enum
+  annotated with "@Input"
 * `AttributeType` (required) data type of the attribute; see options in table below
-* `Mandatory` (optional - true by default) if true: the attribute is required for this agent and validation will fail if the attribute is missing in the scenario **and** no default is provided
+* `Mandatory` (optional - true by default) if true: the attribute is required for this agent and validation will fail if
+  the attribute is missing in the scenario **and** no default is provided
 * `List` (optional - false by default)
     * `AttributeType: time_series` cannot be true
     * `AttributeType: block`
         * if true: any nested element in the scenario must be part of a list element and thus can appear multiple times
         * if false: any nested element in the scenario can only appear once
-    * any other AttributeType: the attribute is interpreted as list, i.e. multiple values can be assigned to this attribute in the scenario
-* `NestedAttributes` (required only if `AttributeType: block`, otherwise disallowed) starts an inner Attribute definition block - defined Attributes are sub-elements of `MyComplexAttribute`
-* `Values` (optional - None by default): if present defines a list of allowed values for this attribute
-* `Default` (optional - None by default): if present defines a default value to be used in case the scenario does not specify it
-* `Help` (optional - None by default): if present defines a help text to you attribute
+    * any other AttributeType: the attribute is interpreted as list, i.e. multiple values can be assigned to this
+      attribute in the scenario
+* `NestedAttributes` (required only if `AttributeType: block`, otherwise disallowed) starts an inner Attribute
+  definition block - defined Attributes are sub-elements of `MyComplexAttribute`
+* `Values` (optional - None by default):
+  * if present, defines a list or dictionary of allowed values for this attribute
+  * if a dictionary is used, individual Metadata can be assigned to each allowed value using the `Metadata` keyword
+* `Default` (optional - None by default):
+  * if present, defines a default value to be used if the scenario does not specify one
+  * must match one of the entries in `Values` in case those are defined
+  * can be a list if the attribute is a list
+* `Help` (optional - None by default): if present, defines a help text for your Attribute
+* `Metadata` (optional - None by default): if present, defines additional metadata assigned to the Attribute
 
 | AttributeType | value                                                                                                                   |
 |---------------|-------------------------------------------------------------------------------------------------------------------------|
@@ -251,23 +324,18 @@ GeneralProperties:
     StartTime: 2011-12-31_23:58:00
     StopTime: 2012-12-30_23:58:00
     RandomSeed: 1
-  Output:
-    Interval: 100
-    Process: 0
 ```
 
 Parameters:
+
 * `RunId` an ID that can be given to the simulation; use at your discretion
 * `StartTime` time stamp in the format YYYY-MM-DD_hh:mm:ss; first moment of the simulation.
 * `StopTime` time stamp in the format YYYY-MM-DD_hh:mm:ss; last moment of the simulation - i.e. simulation terminates
   after passing that time stamp
 * `RandomSeed` seed to initialise random number generation; each value leads to a unique series of random numbers.
 
-Parameters in section `Output` are deprecated and will be removed in FAME-Io v3.0
-* `Interval` number of simulation ticks in between write-to-disk events; may be used for performance optimisations;
-* `Process` id of process that performs write-to-disk operations; leave at 0 to be compatible with single-processes;
-
 #### Agents
+
 Specifies all Agents to be created in the simulation in a list. Each Agent has its own entry.
 Structure:
 
@@ -280,17 +348,21 @@ Agents:
       MyInteger: 2
       MyDouble: 4.2
       MyTimeSeries: "./path/to/time_series.csv"
+    Metadata:
+      Can: "also be assigned"
 
   - Type: MyAgentWithoutInputs
     Id: 2
 ```
 
 Agent Parameters:
+
 * `Type` Mandatory; Java's simple class name of the agent to be created
 * `Id` Mandatory; simulation-unique id of this agent; if two agents have the same ID, the configuration process will
   stop.
 * `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
 
 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 demonstrated below.
@@ -323,7 +395,102 @@ Attributes:
 
 Here, `MyDoubleList` and `MyListGroup` need to specify `List: true` in the corresponding Schema.
 The shorter `[]`-notation was used to assign a list of floating-point values to `MyDoubleList`.
-Nested items `IntValueA` and `IntValueB` of `MyListGroup` are assigned within a list, allowing the specification of these nested items several times.
+Nested items `IntValueA` and `IntValueB` of `MyListGroup` are assigned within a list, allowing the specification of
+these nested items several times.
+
+##### Attribute Metadata
+Metadata can be assigned to any value, list item, or superstructure.
+To assign Metadata to a primitive value, create a dictionary from it, set the actual value with the inner keyword `Value` and add the keyword `Metadata` like this:
+
+```yaml
+ValueWithoutMetadata: 1
+SameValueWithMetadata:
+  Value: 1
+  Metadata: # describe `SameValueWithMetadata` herein
+```
+
+You can assign Metadata to a list of primitive values using the keyword `Values` like this:
+
+```yaml
+ValueListWithoutMetadata: [1,2,3]
+SameValueListWithListMetadata:
+  Values: [1,2,3]
+  Metadata: # describe the whole list of values with Metadata here
+```
+
+or specify Metadata for each (or just some) value individually, like this:
+
+```yaml
+ValueListWithoutMetadata: [1,2,3]
+SameValueListWithMetadataAtEachElement:
+  - Value: 1
+    Metadata: # describe this specific value "1" with Metadata here
+  - Value: 2  # this value has no Metadata attached, but you can still use the keyword `Value`
+  - 3 # or use in the actual directly since this value has no Metadata anyway
+```
+
+or assign Metadata to both the list and any of its list entries, like this:
+
+```yaml
+ValueListWithoutMetadata: [1,2,3]
+SameValueListWithAllMetadata:
+  Metadata: # Recommendation: place the Metadata of the list first if the list of values is extensive, as in this case
+  Values:
+    - Value: 1
+      Metadata: # describe this specific value "1" with Metadata here
+    - Value: 2
+      Metadata: # describe this specific value "2" with Metadata here
+    - Value: 3
+      Metadata: # describe this specific value "3" with Metadata here
+```
+
+You can assign Metadata directly to a nested element by adding the Metadata keyword:
+
+```yaml
+NestedItemWithoutMetadata:
+  A: 1
+  B: 2
+SameNestedItemWithMetadata:
+  A: 1
+  B: 2
+  Metadata: # These Metadata describe `SameNestedItemWithMetadata`
+```
+
+Similar to lists of values, you can assign Metadata to a list of nested elements using the `Values` keyword, like this:
+
+```yaml
+ListOfNestedItemsWithoutMetadata:
+  - A: 1
+    B: 10
+  - A: 2
+    B: 20
+SameListOfNestedItemsWithGeneralMetadata:
+  Values:
+    - A: 1
+      B: 10
+    - A: 2
+      B: 20
+  Metadata: # These Metadata describe `SameListOfNestedItemsWithGeneralMetadata` as a whole
+```
+
+and, similar to nested elements, you can assign Metadata directly to any list element, like this:
+
+```yaml
+ListOfNestedItemsWithoutMetadata:
+  - A: 1
+    B: 10
+  - A: 2
+    B: 20
+SameListOfNestedItemsWithGeneralMetadata:
+  - A: 1
+    B: 10
+    Metadata: # These Metadata describe the first list item
+  - A: 2
+    B: 20
+    Metadata: # These Metadata describe the second list item
+```
+
+Again, you may apply both variants and apply Metadata to the list and each of its items if you wish.
 
 #### Contracts
 Specifies all Contracts, i.e. repetitive bilateral transactions in between agents.
@@ -337,6 +504,8 @@ Contracts:
     ProductName: ProductOfAgent_1
     FirstDeliveryTime: -25
     DeliveryIntervalInSteps: 3600
+    Metadata:
+      Some: "additional information can go here"
 
   - SenderId: 2
     ReceiverId: 1
@@ -349,17 +518,20 @@ Contracts:
 ```
 
 Contract Parameters:
+
 * `SenderId` unique ID of agent sending the product
 * `ReceiverId` unique ID of agent receiving the product
 * `ProductName` name of the product to be sent
 * `FirstDeliveryTime` first time of delivery in the format "seconds after the January 1st 2000, 00:00:00"
 * `DeliveryIntervalInSteps` delay time in between deliveries in seconds
+* `Metadata` can be assigned to add further helpful information about a Contract
 * `Attributes` can be set to include additional information as `int`, `float`, `enum`, or `dict` data types
 
 ##### Definition of Multiple Similar Contracts
 Often, scenarios contain multiple agents of similar type that also have similar chains of contracts.
 Therefore, FAME-Io supports a compact definition of multiple similar contracts.
-`SenderId` and `ReceiverId` can both be lists and support One-to-N, N-to-One and N-to-N relations like in the following example:
+`SenderId` and `ReceiverId` can both be lists and support One-to-N, N-to-One and N-to-N relations like in the following
+example:
 
 ```yaml
 Contracts:
@@ -389,7 +561,8 @@ Contracts:
 ```
 
 Combined with YAML anchors complex contract chains can be easily reduced to a minimum of required configuration.
-The following example is equivalent to the previous one and allows a quick extension of contracts to a new couple of agents e.g. (4;14):
+The following example is equivalent to the previous one and allows a quick extension of contracts to a new couple of
+agents e.g. (4;14):
 
 ```yaml
 Groups:
@@ -417,9 +590,12 @@ Contracts:
 ```
 
 #### StringSets
+
 This optional section defines values of type `string_set`.
-In contrast to `enum` values, which are **statically** defined in the `Schema`, `string_set` values can be **dynamically** defined in this section.
+In contrast to `enum` values, which are **statically** defined in the `Schema`, `string_set` values can be **dynamically
+** defined in this section.
 If an agent attribute is of type `string_set` and the attribute is set in the `scenario`, then
+
 1. the section `StringSets` in the `scenario` must contain an entry named exactly like the attribute, and
 2. the attribute value must be contained in the string set's `Values` declaration.
 
@@ -449,12 +625,15 @@ Agents:
      FuelType: OIL
 ```
 
-Important: If different types of Agents shall refer to the same StringSet, their attributes in schema must have the **exact** same name.
+Important: If different types of Agents shall refer to the same StringSet, their attributes in schema must have the
+**exact** same name.
 
 ### CSV files
+
 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`
@@ -473,20 +652,24 @@ 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).
+Please refer also to the detailed article about `TimeStamps` in
+the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/TimeStamp).
 
 ### Split and join multiple YAML files
+
 The user may include other YAML files into a YAML file to divide the content across files as convenient.
 We explicitly recommend using this feature for the `Schema` and `Contracts` sections.
 Otherwise, the scenario.yaml may become crowded.
 
 #### Command: !Include
+
 To hint YAML to load the content of another file use `!include "path/relative/to/including/yaml/file.yml"`.
 You can concatenate !include commands and can use !include in the included file as well.
 The path to the included file is always relative to the file using the !include command.
 So with the following file structure
 
 ###### file-structure
+
 ```
 a.yaml
 folder/b.yaml
@@ -497,24 +680,29 @@ folder/deeper_folder/d.yaml
 the following !include commands work
 
 ###### in a.yaml
+
 ```
 ToBe: !include "folder/b.yaml"
 OrNot: !include "folder/deeper_folder/d.yaml"
 ```
 
 ###### in b.yaml
+
 ```
 ThatIs: !include "c.yaml"
 TheQuestion: !include "deeper_folder/d.yaml"
 ```
 
 Provided that
+
 ###### in c.yaml
+
 ```
 Or: maybe
 ```
 
 ###### d.yaml
+
 ```
 not: "?"
 ```
@@ -522,6 +710,7 @@ not: "?"
 the resulting file would look like this:
 
 ###### THe Joined file a.yaml
+
 ```
 ToBe:
   ThatIs:
@@ -540,6 +729,7 @@ However, you cannot combine the value returned from !include with other values i
 Thus, the following combinations do not work:
 
 ###### caveats.yml
+
 ```
 !include "file.yaml" # no key assigned
 
@@ -553,12 +743,14 @@ List:
 ```
 
 #### Integrate specific nodes of YAML files
+
 Instead of including *all* content in the included file, you may also pick a specific node within that file.
 For this use `!include [<relative/path/to/file.yaml>, Path:To:Field:In:Yaml]`.
 Here, `:` is used in the node-specifying string to select a sequence of nodes to follow - with custom depth.
 Consider the following two files:
 
 ###### file_to_be_included.yaml
+
 ```yaml
 Set1:
   Subset1:
@@ -568,6 +760,7 @@ Set2:
 ```
 
 ###### including_file.yaml
+
 ```yaml
 - Type: MyAgentWithInputs
   Id: 1
@@ -577,6 +770,7 @@ Set2:
 Compiling "including_file.yaml" results in
 
 ###### resulting_file.yaml
+
 ```yaml
 - Type: MyAgentWithInputs
   Id: 1
@@ -585,14 +779,18 @@ Compiling "including_file.yaml" results in
 ```
 
 #### Load multiple files
-Using wildcards in the given path (e.g. "path/to/many/*.yaml") will lead to loading multiple files and assigning their content to the same key.
+
+Using wildcards in the given path (e.g. "path/to/many/*.yaml") will lead to loading multiple files and assigning their
+content to the same key.
 You can make use of this feature with or without specifying a node selector.
 However, the elements to be joined across multiple files must be lists.
 These lists are then concatenated into a single list and then assigned to the key in the file calling !include.
-This feature is especially useful for Contracts: You can split the Contracts list into several files and place them in a separate folder.
+This feature is especially useful for Contracts: You can split the Contracts list into several files and place them in a
+separate folder.
 Then use !include to re-integrate them into your configuration. An example:
 
 ###### my_contract1.yaml
+
 ```
 Contracts:
  - ContractA
@@ -600,6 +798,7 @@ Contracts:
 ```
 
 ###### my_contract2.yaml
+
 ```
 Contracts:
  - ContractC
@@ -608,6 +807,7 @@ Contracts:
 ```
 
 ###### including_file.yaml
+
 ```
 Contracts: [!include "my_contract*.yaml", "Contracts"]
 ```
@@ -615,6 +815,7 @@ Contracts: [!include "my_contract*.yaml", "Contracts"]
 results in
 
 ###### result.yaml
+
 ```
 Contracts:
  - ContractA
@@ -625,11 +826,13 @@ Contracts:
 ```
 
 #### Ignoring files
+
 Files that have their name start with "IGNORE_" are not included with the !include command.
 You will see a debug output to notify you that the file was ignored.
 Use this to temporarily take files out ouf your configuration without deleting or moving them.
 
 ## Read FAME results
+
 Takes an output file in protobuf format of FAME-based applications and converts it into files in CSV format.
 An individual file for each type of Agent is created in a folder named after the protobuf input file.
 Call structure:
@@ -638,35 +841,33 @@ Call structure:
 
 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.                                                                                |
-| `-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
-ii) reduce number of lines in output files
-
-For this, add the option `merge-times` and specify the arguments as follows:
-
-| Command                   | Action                                                                                   |
-|---------------------------|------------------------------------------------------------------------------------------|
-| `-fp` or `--focal-point`  | TimeStep on which `steps-before` earlier and `steps-after` later TimeSteps are merged on |
-| `-sb` or `--steps-before` | Range of TimeSteps before the `focal-point` they get merged to                           |
-| `-sa` or `--steps-after`  | Range of TimeSteps after the `focal-point` they get merged to                            |
+| 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 in addition to the outputs (default=False).                                                                                                                     |
+| `-mt` or `--merge-times` <list-of-parameters> | Option to merge `TimeSteps` of a certain range of steps in the output files to associate multiple time steps with a common logical time in your simulation and reduce number of lines in output files |
+
+The option `--merge-times` requires exactly three integer arguments separated by spaces:
+
+| Position | Name         | Meaning                                                                                  |
+|----------|--------------|------------------------------------------------------------------------------------------|
+| First    | Focal point  | TimeStep on which `steps-before` earlier and `steps-after` later TimeSteps are merged on |
+| Second   | Steps before | Range of TimeSteps before the `focal-point` they get merged to, must be Zero or positive |
+| Third    | Steps after  | Range of TimeSteps after the `focal-point` they get merged to, must be Zero or positive  |
+
 
 This could look as follows:
 
-    convertFameResults -f <./path/to/protobuf_file.pb> -l debug -lf <path/to/output.log> -a AgentType1 AgentType2 -o myCsvFolder -m -cc SPLIT merge-times -fp 0 -sb 1799 -sa 1800
+    convertFameResults -f <./path/to/protobuf_file.pb> -l debug -lf <path/to/output.log> -a AgentType1 AgentType2 -o myCsvFolder -m -cc SPLIT --merge-times 0 1799 1800
 
-Make sure that in the range of time steps you specify for merging there is only one value per column in the merged time range.
+Make sure that in the range of time steps you specify for merging, there is only one value per column in the merged time range.
 If multiple values per column are merged values will get concatenated and might yield unexpected results.
 
 You may also call the conversion script from any Python script with:
@@ -677,7 +878,8 @@ from fameio.scripts.convert_results import Options, run as convert_results
 convert_results({Options.FILE: "./path/to/protobuf_file.pb"})
 ```
 
-Similar to the console call you may also specify custom run config arguments and add it in a dictionary to the function call.
+Similar to the console call you may also specify custom run config arguments and add it in a dictionary to the function
+call.
 
 ```python
 from fameio.scripts.convert_results import Options, run as convert_results
@@ -701,7 +903,7 @@ You can also use the associated argument parser, to extract the run_config dynam
 
 ```python
 from fameio.scripts.convert_results import Options, run as convert_results
-from fameio.source.cli.convert_results import handle_args
+from fameio.cli.convert_results import handle_args
 
 my_defaults = {Options.FILE: "./path/to/protobuf_file.pb",
                Options.LOG_LEVEL: "info",
@@ -721,6 +923,7 @@ convert_results(run_config)
 ```
 
 ## Cite FAME-Io
+
 If you use FAME-Io for academic work, please cite as follows.
 
 Bibtex entry:
@@ -736,12 +939,14 @@ Bibtex entry:
 ```
 
 ## Available Support
+
 This is a purely scientific project by (at the moment) one research group.
 Thus, there is no paid technical support available.
 However, we will give our best to answer your questions and provide support.
 
 If you experience any trouble with FAME-Io, you may contact the developers via [fame@dlr.de](mailto:fame@dlr.de).
-Please report bugs and make feature requests by filing issues following the provided templates (see also [Contribute](CONTRIBUTING.md)).
+Please report bugs and make feature requests by filing issues following the provided templates (see
+also [Contribute](CONTRIBUTING.md)).
 For substantial enhancements, we recommend that you contact us via [fame@dlr.de](mailto:fame@dlr.de) for working
 together on the code in common projects or towards common publications and thus further develop FAME-Io.