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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fameio
-Version: 2.0.0
+Version: 2.1.0
 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.1.0.dist-info/RECORD

@@ -0,0 +1,53 @@
+CHANGELOG.md,sha256=cXIVQA_QDtE73CZbA7P_DWqaegoPdVY4389UVQiT87g,10680
+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=mUO_lKk788JpfLdGYxhNuwYekKDMnoHC8awWgkd56vE,3615
+fameio/scripts/convert_results.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
+fameio/scripts/make_config.py,sha256=OL72ii06m9N0ncWYHdsIivzeOj8Xd_6Se6caWkdCAEs,1347
+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=LY9ySXs3dAyyos0yoc-bY8M1Z9Oti-AgGYEEK5K-Ctg,3412
+fameio/source/cli/make_config.py,sha256=Y49qWewg2Z3THWA4drrVp4Avag26cDOcLzBiKmxbESw,2384
+fameio/source/cli/options.py,sha256=H7befeI-fDItdzjlqZlpWtJfZGUaYzrfGdzBiWbAg28,1393
+fameio/source/cli/parser.py,sha256=0r2CAcBfpinrE3EASxoYv2i_0Obz2zIbe9RqeCwK0kA,9423
+fameio/source/loader.py,sha256=xDmTKPmIrSfYQtIZe8cUAbiDKxdFqcTH9n1EckKAZc4,7403
+fameio/source/logs.py,sha256=9Iq9jcglGyALYir-Luxfa-m4uUJX074JkUM0uMwzPNc,3684
+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=F7rDJ_iJGN1DFt_9jkweGap_TGMJV3UnUyssfIJehDM,3709
+fameio/source/results/csv_writer.py,sha256=A4hWnuBmU0cOfFLkW57L0NlH2tHc4H-ME1fmJitZLI8,4856
+fameio/source/results/data_transformer.py,sha256=tz58m7_TZPE3YjBoDyiMWiP_sz9mWaj1JfW2FjKLVhY,5490
+fameio/source/results/input_dao.py,sha256=5V_7dUhO1XZGNuwH5041HnMGCcQjC9d9_TBR4FZ9QJE,6919
+fameio/source/results/output_dao.py,sha256=8FocGe4yyH3EdHD5Chw9uCGnDetfJoSglBga0o3lnWE,3960
+fameio/source/results/reader.py,sha256=g3cfbNq7eHO98dxtpqjjPE8_YJVM56Wp0MCnNi3ds5g,5054
+fameio/source/results/yaml_writer.py,sha256=rOAbeZQgRojYvofUcXreIdIJtdSbOrHAohiNLkmPgCI,837
+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=lM2NN_CUDh9iqDghq_F6JE9rEW3ZGUhBJOD0qkjuKBU,9442
+fameio/source/scenario/exception.py,sha256=7MYN4h40ptMZFD1lLtnK5PWXbAGlsmUSDmUQ5FAKeN8,1554
+fameio/source/scenario/fameiofactory.py,sha256=7P-x8i9sSU9sIkOlgF6gVRFuNacFMUBrBh4KdHoAUtU,1376
+fameio/source/scenario/generalproperties.py,sha256=UysnP8FClKcPCoAzElyRb950Aq1kC8JQPhjs3Fo2OP4,4539
+fameio/source/scenario/scenario.py,sha256=j2IVVZlpBJjYECXzBouFtrDXPPES0uSf_Q2l0MzcQkQ,3727
+fameio/source/schema/__init__.py,sha256=ZGTyliDbjlYGPAjB9bbggzACOYWdhm4I1VSmm7YGmTk,270
+fameio/source/schema/agenttype.py,sha256=fe6GWJwl2S-J7KmH_eR5Y8Ieez1difez1w7v-r26yGU,5183
+fameio/source/schema/attribute.py,sha256=o2eZjurrYfvBiaZm1WE1XW0u8joHSbbXEKu-385cuW8,8296
+fameio/source/schema/exception.py,sha256=NMftGnrFOaS3MwrjZl8qbx3bi6KYUxhzHJIX1v--B5M,224
+fameio/source/schema/java_packages.py,sha256=-2ZbAG_htEowB-fBSMizsLWrphyiKfESDDHspzdEQP4,2656
+fameio/source/schema/schema.py,sha256=-J8VtO4W9Z-OnTV7MFO1umZWIC_epbLCYd6-q4lNQ8Y,2975
+fameio/source/series.py,sha256=00HBTz_liP0T_2yRQ3__xjHjZBT0bVGA00CZxcyGCqk,8232
+fameio/source/time.py,sha256=Vsd95nTubL8x5cwiznJYeti6clZCCHHJv7xjSpYqkF0,6984
+fameio/source/tools.py,sha256=7YxX-CmsakJJB2RbBhf2u8y1-RyhDhsASHXFztkDIKE,1052
+fameio/source/validator.py,sha256=cXTDl75zt6NVVyHUUFDL9Y_lg3QuJJfTdW83lv4Krvs,15719
+fameio/source/writer.py,sha256=vZd8om08xO4fnb2o6lkLXFdDjDlX3_NcHl6TwR4YYkM,11921
+fameio-2.1.0.dist-info/entry_points.txt,sha256=jvQVfwJjZXPWQjJlhj1Dt6PTeblryTc1GxjKeK90twI,123
+fameio-2.1.0.dist-info/LICENSE.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
+fameio-2.1.0.dist-info/LICENSES/Apache-2.0.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
+fameio-2.1.0.dist-info/LICENSES/CC-BY-4.0.txt,sha256=y9WvMYKGt0ZW8UXf9QkZB8wj1tjJrQngKR7CSXeSukE,19051
+fameio-2.1.0.dist-info/LICENSES/CC0-1.0.txt,sha256=9Ofzc7m5lpUDN-jUGkopOcLZC3cl6brz1QhKInF60yg,7169
+fameio-2.1.0.dist-info/METADATA,sha256=Fnk0T5HpZjVPYNb9do_EzAht_PojGc9685u-K4ElSrc,30847
+fameio-2.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+fameio-2.1.0.dist-info/RECORD,,

fameio-2.0.0.dist-info/RECORD

@@ -1,52 +0,0 @@
-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,,