fameio 1.8.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

{fameio-1.8.1.dist-info → fameio-2.0.0.dist-info}/METADATA

@@ -1,26 +1,31 @@
 Metadata-Version: 2.1
 Name: fameio
-Version: 1.8.1
+Version: 2.0.0
 Summary: Python scripts for operation of FAME models
-Home-page: https://gitlab.com/fame-framework/fame-io/
-Author: Felix Nitsch, Christoph Schimeczek, Ulrich Frey, Marc Deissenroth-Uhrig, Benjamin Fuchs, A. Achraf El Ghazi
+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
 Author-email: fame@dlr.de
-License: Apache License 2.0
-Keywords: FAME,agent-based modelling
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3
+Maintainer: Felix Nitsch
+Maintainer-email: fame@dlr.de
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Scientific/Engineering
+Requires-Dist: fameprotobuf (>=1.4.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
-License-File: LICENSE.txt
-Requires-Dist: pandas
-Requires-Dist: fameprotobuf (<1.3,>=1.2)
-Requires-Dist: pyyaml
-Provides-Extra: dev
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: mockito ; extra == 'dev'
-Requires-Dist: pre-commit ; extra == 'dev'
 
 <!-- SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
 
@@ -31,15 +36,18 @@ SPDX-License-Identifier: Apache-2.0 -->
 [![PyPI license](https://img.shields.io/pypi/l/fameio.svg)](https://badge.fury.io/py/fameio)
 [![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)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![REUSE status](https://api.reuse.software/badge/gitlab.com/fame-framework/fame-io)](https://api.reuse.software/info/gitlab.com/fame-framework/fame-io)
+[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)
+![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.
 Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to get an explanation of FAME and its components.
-The package is also formerly known as [FAME-Py](https://doi.org/10.5281/zenodo.4314338).
 
 # Installation
-
 We recommend installing `fameio` using PyPI:
 
     pip install fameio
@@ -48,11 +56,10 @@ You may also use `pipx`. For detailed information please refer to the official `
 
     pipx install fameio
 
-`fameio` is currently developed and tested for Python 3.8 or higher. 
-See the `setup.py` for a complete listing of dependencies. 
+`fameio` is currently developed and tested for Python 3.8 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.
 The first one creates a protobuf file for FAME applications using YAML definition files and CSV files.
@@ -78,27 +85,43 @@ This could look as follows:
 
     makeFameRunConfig -f <path/to/scenario.yaml> -l debug -lf <path/to/scenario.log> -o <path/to/config.pb>
 
-
 You may also call the configuration builder from any Python script with
 
 ```python
-from fameio.scripts.make_config import run as make_config
+from fameio.scripts.make_config import Options, run as make_config
 
-make_config("path/to/scenario.yaml")
+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.
 
 ```python
-from fameio.scripts.make_config import run as make_config
-from fameio.source.cli import Options
+from fameio.scripts.make_config import Options, run as make_config
 
-run_config = {Options.LOG_LEVEL: "info",
+run_config = {Options.FILE: "path/to/scenario.yaml",
+              Options.LOG_LEVEL: "info",
               Options.OUTPUT: "output.pb",
               Options.LOG_FILE: "scenario.log",
               }
 
-make_config("path/to/scenario.yaml", run_config)
+make_config(run_config)
+```
+
+You can also use the associated argument parser, to extract the run_config dynamically from a string:
+
+```python
+from fameio.scripts.make_config import Options, run as make_config
+from fameio.source.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",
+                 }
+my_arg_string = ['-f', 'my/other/scenario.yaml', '-l', 'error']
+
+run_config = handle_args(my_arg_string, my_defaults)
+make_config(run_config)
 ```
 
 ### Scenario YAML
@@ -119,7 +142,8 @@ The Schema consists of the sections `Header` 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.
+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.
 
 ```yaml
 Header:
@@ -141,9 +165,9 @@ AgentTypes:
   MyAgentType:
     Attributes:
       MyAttribute:
-         ...
+        ...
       MyOtherAttribute:
-         ...
+        ...
     Products: [ 'Product1', 'Product2', 'Product3' ]
   MyOtherAgentWithoutProductsOrAttributes:
 ```
@@ -181,26 +205,26 @@ MyComplexAttribute:
 * `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
 * `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
+    * `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
 
-| AttributeType   | value                                                                                                                   |
-|-----------------|-------------------------------------------------------------------------------------------------------------------------|
-| `integer`       | a 32-bit integer value                                                                                                  |
-| `double`        | a 64-bit floating-point value (integers also allowed)                                                                   |
-| `long`          | a 64-bit integer value                                                                                                  |
-| `time_stamp`    | either a FAME time stamp string or 64-bit integer value                                                                 |
-| `string`        | any string                                                                                                              |
-| `enum`          | any string, however, usually tied to a set of allowed `Values`                                                          |
-| `time_series`   | either a path to a .csv-file or a single 64-bit floating-point value; does not support `List: true`                     |
-| `block`         | this attribute has no value of its own but hosts a group of nested Attributes; implies `NestedAttributes` to be defined |
+| AttributeType | value                                                                                                                   |
+|---------------|-------------------------------------------------------------------------------------------------------------------------|
+| `integer`     | a 32-bit integer value                                                                                                  |
+| `double`      | a 64-bit floating-point value (integers also allowed)                                                                   |
+| `long`        | a 64-bit integer value                                                                                                  |
+| `time_stamp`  | either a FAME time stamp string or 64-bit integer value                                                                 |
+| `string`      | any string                                                                                                              |
+| `enum`        | any string, however, usually tied to a set of allowed `Values`                                                          |
+| `time_series` | either a path to a .csv-file or a single 64-bit floating-point value; does not support `List: true`                     |
+| `block`       | this attribute has no value of its own but hosts a group of nested Attributes; implies `NestedAttributes` to be defined |
 
 #### GeneralProperties
 Specifies FAME-specific properties of the simulation. Structure:
@@ -220,7 +244,8 @@ GeneralProperties:
 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
+* `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.
 * `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;
@@ -228,6 +253,7 @@ Parameters:
 #### Agents
 Specifies all Agents to be created in the simulation in a list. Each Agent has its own entry.
 Structure:
+
 ```yaml
 Agents:
   - Type: MyAgentWithInputs
@@ -244,8 +270,10 @@ Agents:
 
 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
+* `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
 
 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.
@@ -268,7 +296,7 @@ In case Attributes are defined with `List: true` option, lists are assigned to a
 
 ```yaml
 Attributes:
-  MyDoubleList: [5.2, 4.5, 7, 9.9]
+  MyDoubleList: [ 5.2, 4.5, 7, 9.9 ]
   MyListGroup:
     - IntValueA: 5
       IntValueB: 42
@@ -321,14 +349,14 @@ Contracts:
   # effectively 3 similar contracts (0 -> 11), (0 -> 12), (0 -> 13)
   # with otherwise identical ProductName, FirstDeliveryTime & DeliveryIntervalInSteps
   - SenderId: 0
-    ReceiverId: [11, 12, 13]
+    ReceiverId: [ 11, 12, 13 ]
     ProductName: MyOtherProduct
     FirstDeliveryTime: 100
     DeliveryIntervalInSteps: 3600
 
   # effectively 3 similar contracts (1 -> 10), (2 -> 10), (3 -> 10)
   # with otherwise identical ProductName, FirstDeliveryTime & DeliveryIntervalInSteps
-  - SenderId: [1, 2, 3]
+  - SenderId: [ 1, 2, 3 ]
     ReceiverId: 10
     ProductName: MyProduct
     FirstDeliveryTime: 100
@@ -336,8 +364,8 @@ Contracts:
 
   # effectively 3 similar contracts (1 -> 11), (2 -> 12), (3 -> 13)
   # with otherwise identical ProductName, FirstDeliveryTime & DeliveryIntervalInSteps
-  - SenderId: [1, 2, 3]
-    ReceiverId: [11, 12, 13]
+  - SenderId: [ 1, 2, 3 ]
+    ReceiverId: [ 11, 12, 13 ]
     ProductName: MyThirdProduct
     FirstDeliveryTime: 100
     DeliveryIntervalInSteps: 3600
@@ -348,8 +376,8 @@ The following example is equivalent to the previous one and allows a quick exten
 
 ```yaml
 Groups:
-  - &agentList1: [1,2,3]
-  - &agentList2: [11,12,13]
+  - &agentList1: [ 1,2,3 ]
+  - &agentList2: [ 11,12,13 ]
 
 Contracts:
   - SenderId: 0
@@ -379,14 +407,17 @@ These CSV files follow a specific structure:
 * The first column must be a time stamp in form `YYYY-MM-DD_hh:mm:ss`
 * 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 `#`
 
+You may add comments using `#`.
 Exemplary content of a valid CSV file:
 
+    # If you want an optional header, you must use a comment
     2012-01-01_00:00:00;400
     2013-01-01_00:00:00;720.5
     2014-01-01_00:00:00;650
     2015-01-01_00:00:00;99.27772
-    2016-01-01_00:00:00;42
+    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).
@@ -409,6 +440,7 @@ folder/b.yaml
 folder/c.yaml
 folder/deeper_folder/d.yaml
 ```
+
 the following !include commands work
 
 ###### in a.yaml
@@ -428,10 +460,12 @@ Provided that
 ```
 Or: maybe
 ```
+
 ###### d.yaml
 ```
 not: "?"
 ```
+
 the resulting file would look like this:
 
 ###### THe Joined file a.yaml
@@ -451,6 +485,7 @@ When specifying only a file path, the complete content of the file is assigned t
 You always need a key to assign the !include command to.
 However, you cannot combine the value returned from !include with other values in the same key.
 Thus, the following combinations do not work:
+
 ###### caveats.yml
 ```
 !include "file.yaml" # no key assigned
@@ -483,7 +518,7 @@ Set2:
 ```yaml
 - Type: MyAgentWithInputs
   Id: 1
-  Attributes: !include_node [file_to_be_included.yaml, Set1:Subset1]
+  Attributes: !include_node [ file_to_be_included.yaml, Set1:Subset1 ]
 ```
 
 Compiling "including_file.yaml" results in
@@ -503,12 +538,14 @@ 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.
 Then use !include to re-integrate them into your configuration. An example:
+
 ###### my_contract1.yaml
 ```
 Contracts:
  - ContractA
  - ContractB
 ```
+
 ###### my_contract2.yaml
 ```
 Contracts:
@@ -516,12 +553,14 @@ Contracts:
  - ContractD
  - ContractE
 ```
+
 ###### including_file.yaml
 ```
 Contracts: [!include "my_contract*.yaml", "Contracts"]
 ```
 
 results in
+
 ###### result.yaml
 ```
 Contracts:
@@ -546,20 +585,21 @@ 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}`                                                                                                                                           |
+| 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).                                                                                                                                                                       |
 
 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
+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:
 
@@ -579,18 +619,18 @@ If multiple values per column are merged values will get concatenated and might
 You may also call the conversion script from any Python script with:
 
 ```python
-from fameio.scripts.convert_results import run as convert_results
+from fameio.scripts.convert_results import Options, run as convert_results
 
-convert_results("./path/to/protobuf_file.pb")
+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.
 
 ```python
-from fameio.scripts.convert_results import run as convert_results
-from fameio.source.cli import Options
+from fameio.scripts.convert_results import Options, run as convert_results
 
-run_config = {Options.LOG_LEVEL: "info",
+run_config = {Options.FILE: "./path/to/protobuf_file.pb",
+              Options.LOG_LEVEL: "info",
               Options.LOG_FILE: "scenario.log",
               Options.OUTPUT: "Output",
               Options.AGENT_LIST: ['AgentType1', 'AgentType2'],
@@ -601,13 +641,37 @@ run_config = {Options.LOG_LEVEL: "info",
               Options.TIME_MERGING: {},
               }
 
-convert_results("./path/to/protobuf_file.pb", run_config)
+convert_results(run_config)
+```
+
+You can also use the associated argument parser, to extract the run_config dynamically from a string:
+
+```python
+from fameio.scripts.convert_results import Options, run as convert_results
+from fameio.source.cli.convert_results import handle_args
+
+my_defaults = {Options.FILE: "./path/to/protobuf_file.pb",
+               Options.LOG_LEVEL: "info",
+               Options.LOG_FILE: "scenario.log",
+               Options.OUTPUT: "Output",
+               Options.AGENT_LIST: ['AgentType1', 'AgentType2'],
+               Options.MEMORY_SAVING: False,
+               Options.SINGLE_AGENT_EXPORT: False,
+               Options.RESOLVE_COMPLEX_FIELD: "SPLIT",
+               Options.TIME: "INT",
+               Options.TIME_MERGING: {},
+               }
+my_arg_string = ['-f', 'my/other/scenario.yaml', '-l', 'error']
+
+run_config = handle_args(my_arg_string, my_defaults)
+convert_results(run_config)
 ```
 
 ## Cite FAME-Io
 If you use FAME-Io for academic work, please cite as follows.
 
 Bibtex entry:
+
 ```
 @article{fameio2023joss,
   author  = {Felix Nitsch and Christoph Schimeczek and Ulrich Frey and Benjamin Fuchs},
@@ -619,44 +683,12 @@ Bibtex entry:
 ```
 
 ## Available Support
-This is a purely scientific project by (at the moment) one research group. 
+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](#Contribute)).
-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.
-
-# Contribute
-Please read the Contributors License Agreement `cla.md`, sign it and send it to [`fame@dlr.de`](mailto:fame@dlr.de) before contributing.
-
-You will also find templates for [bug reports](https://gitlab.com/fame-framework/fame-io/-/blob/main/.gitlab/issue_templates/bug_report.md),
-[feature requests](https://gitlab.com/fame-framework/fame-io/-/blob/main/.gitlab/issue_templates/feature_request.md), and 
-[pull requests](https://gitlab.com/fame-framework/fame-io/-/blob/main/.gitlab/issue_templates/pull_request.md).
-
-We kindly ask you to read the Contributors License Agreement `cla.md`, sign it, and send it to [`fame@dlr.de`](mailto:fame@dlr.de) before contributing. Please see our [conventions of contribution](https://gitlab.com/fame-framework/wiki/-/wikis/developers/contribute/Conventions) which are described in the Wiki.
-
-## Testing changes locally 
-
-Once some changes have been performed on the local git clone, use the following command to override your local installation with your modified copy in order to test the result:
-
-```bash
-python3 setup.py bdist_wheel && pip3 install --force-reinstall --no-dependencies ./dist/*.whl
-```
-
-## Code style
-
-We use the code formatting library [`black`](https://pypi.org/project/black/).
-The maximum line length is defined as 120 characters. 
-Therefore, before committing, run `black --line-length 120 .`
-
-## Pre-Commit hooks
-
-FAME-Io uses several pre-commit hooks to ensure high code quality.
-To use them, install `dev` packages and then initialise pre-commit in FAME-Io's base folder:
-
-```
-    pip install fameio[dev]
-    pre-commit install -t pre-commit -t pre-push
-```
+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.
 

fameio-2.0.0.dist-info/RECORD

@@ -0,0 +1,52 @@
+CHANGELOG.md,sha256=HzXg9-Yd8w0npG0ZJfmcGQNbP59XQchdOpZlWvFHIWI,9874
+fameio/__init__.py,sha256=IQm0MNOXkhBexiMXBoNZDK5xHUYgazH7oXm-lc0Vm04,109
+fameio/scripts/__init__.py,sha256=Bdu79kajJvvmPWdSP82Y6G8MCpP4n9ftTR-snWSbMJY,741
+fameio/scripts/__init__.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
+fameio/scripts/convert_results.py,sha256=Ddv40nIK4fuFgGd_l81KtCg7rzAuH_sNzjuqL2w7xfQ,3635
+fameio/scripts/convert_results.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
+fameio/scripts/make_config.py,sha256=s5UfsGT93vfwEBXTmmhJTw0HwNvk7d5iDAbbL5u7o2c,1349
+fameio/scripts/make_config.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
+fameio/source/__init__.py,sha256=14CnWOIkdSeKQg6FioQSgO7UtEFF6pO4MUtDAUfwNmA,278
+fameio/source/cli/__init__.py,sha256=UqrdWnYMoy-o2--m0a4c-MtAorsc4eILXaPq27EXM1Q,112
+fameio/source/cli/convert_results.py,sha256=VmGBTCXlr6G2AziS3RRGUk4g0agf6MVuMxlWq3fbzZ0,3072
+fameio/source/cli/make_config.py,sha256=_PsQTQNYqRKr8PyGZtMDQskK_qn-tH_rsUZqesYK0UI,2369
+fameio/source/cli/options.py,sha256=zprTvGVNF8Nm71XJ3eMKrwb5pn2ait8VdDwwP5UYLNA,1413
+fameio/source/cli/parser.py,sha256=gFkWDjTj2e08ZbIWio7d4KOLHFJiCDq-tsL-oP2y_00,9366
+fameio/source/loader.py,sha256=SzExknxxrMoL5RG_7TAJ1jVxm93r9VrwT3bzJ196zO4,7433
+fameio/source/logs.py,sha256=sg8MYTm1lquUA8mJSfhaYsC9Dm78fpHstQbQWAM41E8,2806
+fameio/source/path_resolver.py,sha256=cIEVvz7Eh4e3Rh87XkwyGiyj9iKxUI7TzWtq6ClhLd8,1321
+fameio/source/results/__init__.py,sha256=IQm0MNOXkhBexiMXBoNZDK5xHUYgazH7oXm-lc0Vm04,109
+fameio/source/results/agent_type.py,sha256=pW5cLduLlNOcBBvS6sCLpTpZt3D6B8UMsizEZhe5lJ0,4321
+fameio/source/results/conversion.py,sha256=ZaTM3kejkmAr8INdI7FTHoJglFm6MlEGd7phJt1Po1c,3721
+fameio/source/results/csv_writer.py,sha256=txs26dqThagTseCC6UCjBK2ByQZYbNR_sPldUIGPnow,4868
+fameio/source/results/data_transformer.py,sha256=KP2Z-R0Na5JjOvI_DWgmaAdR5wdXKOxbIuUxsIXZ5nY,6264
+fameio/source/results/input_dao.py,sha256=VDIbcq0z600kptyktLPM7RsvZWsx6KBJvvViCL2jOdI,6928
+fameio/source/results/output_dao.py,sha256=8FocGe4yyH3EdHD5Chw9uCGnDetfJoSglBga0o3lnWE,3960
+fameio/source/results/reader.py,sha256=OH18c-IBR7j0uKp2ZU_j5vPIFfasv3ziipjcgXDXYl0,5078
+fameio/source/results/yaml_writer.py,sha256=9BjS0hMcGr2qgtcpwoY3Mmh-XyG3kjkTYqDI-xSAXww,843
+fameio/source/scenario/__init__.py,sha256=YfJvz275GWX8kVWMSMRcF3KsUQNqSAPrwBgNV7tqBTY,372
+fameio/source/scenario/agent.py,sha256=Z8jfMfUjrTJ4R1rEpwNdKCblhEx6-9xioewxGuajuqw,4713
+fameio/source/scenario/attribute.py,sha256=-Ed6jHlztwf9NhvpfRNt6ohGKKqkPBx_hLvGFE6O6K0,4834
+fameio/source/scenario/contract.py,sha256=WI9dY8xWEXB5vGvXWDye6LAA9P-8GXFAep8Z-QTbhjg,9448
+fameio/source/scenario/exception.py,sha256=2mJC8EuZqyZsb31qw6ZtOBZWKm9kILgB3n3JHrIYmAc,1560
+fameio/source/scenario/fameiofactory.py,sha256=7P-x8i9sSU9sIkOlgF6gVRFuNacFMUBrBh4KdHoAUtU,1376
+fameio/source/scenario/generalproperties.py,sha256=CaFny6xyGs3sHqSHNKyWUB68lWOrTOnYfAnIcPaSusQ,4545
+fameio/source/scenario/scenario.py,sha256=j2IVVZlpBJjYECXzBouFtrDXPPES0uSf_Q2l0MzcQkQ,3727
+fameio/source/schema/__init__.py,sha256=ZGTyliDbjlYGPAjB9bbggzACOYWdhm4I1VSmm7YGmTk,270
+fameio/source/schema/agenttype.py,sha256=x4A5eLDC9SfC2PwUUUg0U6OdFJ49oLH61CwSWDoIKZc,5198
+fameio/source/schema/attribute.py,sha256=rcltVycTipwnrQNiKFJTifhuDZHgLOcVtcYjOwHDo2A,8308
+fameio/source/schema/exception.py,sha256=NMftGnrFOaS3MwrjZl8qbx3bi6KYUxhzHJIX1v--B5M,224
+fameio/source/schema/schema.py,sha256=TmlIwnVUjKbNx6ZH8soe2tbiQ0-X7oqIsrSNBGlOwWk,2240
+fameio/source/series.py,sha256=g2nwFqED-TQhHP5YraWcavmLBXmVxEKEF4HKa9C5n4I,8120
+fameio/source/time.py,sha256=Vsd95nTubL8x5cwiznJYeti6clZCCHHJv7xjSpYqkF0,6984
+fameio/source/tools.py,sha256=7YxX-CmsakJJB2RbBhf2u8y1-RyhDhsASHXFztkDIKE,1052
+fameio/source/validator.py,sha256=bk1tkz4eu_LG28Sey9PNNT5KqQKQuokdf9OSorSJJgo,15734
+fameio/source/writer.py,sha256=9v4GGKc-5d65K48f0IlqgB0UTYu4XTwPzzLS_JD7Wp8,11353
+fameio-2.0.0.dist-info/entry_points.txt,sha256=jvQVfwJjZXPWQjJlhj1Dt6PTeblryTc1GxjKeK90twI,123
+fameio-2.0.0.dist-info/LICENSE.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
+fameio-2.0.0.dist-info/LICENSES/Apache-2.0.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
+fameio-2.0.0.dist-info/LICENSES/CC-BY-4.0.txt,sha256=y9WvMYKGt0ZW8UXf9QkZB8wj1tjJrQngKR7CSXeSukE,19051
+fameio-2.0.0.dist-info/LICENSES/CC0-1.0.txt,sha256=9Ofzc7m5lpUDN-jUGkopOcLZC3cl6brz1QhKInF60yg,7169
+fameio-2.0.0.dist-info/METADATA,sha256=V2Z4AkAJLlyCbFml9ZF6B9_0TzsrtkBr0F-5ZWWHwWs,30769
+fameio-2.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+fameio-2.0.0.dist-info/RECORD,,

{fameio-1.8.1.dist-info → fameio-2.0.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

fameio-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+convertFameResults=fameio.scripts:convertFameResults
+makeFameRunConfig=fameio.scripts:makeFameRunConfig
+