fameio 3.3.0__py3-none-any.whl → 3.5.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. fameio/__init__.py +2 -1
  2. fameio/cli/__init__.py +2 -0
  3. fameio/cli/convert_results.py +8 -0
  4. fameio/cli/make_config.py +2 -0
  5. fameio/cli/options.py +4 -0
  6. fameio/cli/parser.py +17 -1
  7. fameio/cli/reformat.py +2 -0
  8. fameio/input/__init__.py +2 -1
  9. fameio/input/loader/__init__.py +1 -0
  10. fameio/input/loader/controller.py +12 -0
  11. fameio/input/loader/loader.py +2 -0
  12. fameio/input/metadata.py +2 -0
  13. fameio/input/resolver.py +2 -0
  14. fameio/input/scenario/__init__.py +2 -0
  15. fameio/input/scenario/agent.py +2 -0
  16. fameio/input/scenario/attribute.py +2 -0
  17. fameio/input/scenario/contract.py +57 -10
  18. fameio/input/scenario/exception.py +2 -0
  19. fameio/input/scenario/fameiofactory.py +2 -0
  20. fameio/input/scenario/generalproperties.py +2 -0
  21. fameio/input/scenario/scenario.py +2 -0
  22. fameio/input/scenario/stringset.py +2 -0
  23. fameio/input/schema/__init__.py +1 -0
  24. fameio/input/schema/agenttype.py +2 -0
  25. fameio/input/schema/attribute.py +2 -0
  26. fameio/input/schema/java_packages.py +2 -0
  27. fameio/input/schema/schema.py +8 -3
  28. fameio/input/validator.py +2 -0
  29. fameio/input/writer.py +16 -0
  30. fameio/logs.py +2 -1
  31. fameio/output/__init__.py +1 -0
  32. fameio/output/agent_type.py +14 -0
  33. fameio/output/conversion.py +2 -0
  34. fameio/output/csv_writer.py +4 -2
  35. fameio/output/data_transformer.py +2 -0
  36. fameio/output/execution_dao.py +5 -0
  37. fameio/output/input_dao.py +5 -3
  38. fameio/output/metadata/__init__.py +10 -0
  39. fameio/output/metadata/compiler.py +75 -0
  40. fameio/output/metadata/json_writer.py +37 -0
  41. fameio/output/metadata/locator.py +242 -0
  42. fameio/output/metadata/oeo_template.py +93 -0
  43. fameio/output/metadata/template_reader.py +65 -0
  44. fameio/output/output_dao.py +2 -0
  45. fameio/output/reader.py +1 -0
  46. fameio/output/yaml_writer.py +3 -1
  47. fameio/scripts/__init__.py +4 -0
  48. fameio/scripts/convert_results.py +35 -2
  49. fameio/scripts/exception.py +1 -0
  50. fameio/series.py +14 -6
  51. fameio/time.py +42 -0
  52. fameio/tools.py +1 -0
  53. fameio-3.5.0.dist-info/LICENSES/CC-BY-ND-4.0.txt +392 -0
  54. fameio-3.5.0.dist-info/METADATA +99 -0
  55. fameio-3.5.0.dist-info/RECORD +67 -0
  56. fameio-3.3.0.dist-info/METADATA +0 -976
  57. fameio-3.3.0.dist-info/RECORD +0 -60
  58. {fameio-3.3.0.dist-info → fameio-3.5.0.dist-info}/LICENSE.txt +0 -0
  59. {fameio-3.3.0.dist-info → fameio-3.5.0.dist-info}/LICENSES/Apache-2.0.txt +0 -0
  60. {fameio-3.3.0.dist-info → fameio-3.5.0.dist-info}/LICENSES/CC-BY-4.0.txt +0 -0
  61. {fameio-3.3.0.dist-info → fameio-3.5.0.dist-info}/LICENSES/CC0-1.0.txt +0 -0
  62. {fameio-3.3.0.dist-info → fameio-3.5.0.dist-info}/WHEEL +0 -0
  63. {fameio-3.3.0.dist-info → fameio-3.5.0.dist-info}/entry_points.txt +0 -0
fameio-3.5.0.dist-info/METADATA ADDED
@@ -0,0 +1,99 @@
1
+ Metadata-Version: 2.3
2
+ Name: fameio
3
+ Version: 3.5.0
4
+ Summary: Tools for input preparation and output digestion of FAME models
5
+ License: Apache-2.0
6
+ Keywords: FAME,fameio,agent-based modelling,energy systems
7
+ Author: Felix Nitsch
8
+ Author-email: fame@dlr.de
9
+ Maintainer: Felix Nitsch
10
+ Maintainer-email: fame@dlr.de
11
+ Requires-Python: >=3.9,<4.0
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Scientific/Engineering
24
+ Requires-Dist: fameprotobuf (>=2.1.0,<3.0)
25
+ Requires-Dist: pandas (>=1.0,<3.0)
26
+ Requires-Dist: pyyaml (>=6.0,<7.0)
27
+ Project-URL: Changelog, https://gitlab.com/fame-framework/fame-io/-/blob/main/CHANGELOG.md
28
+ Project-URL: Homepage, https://helmholtz.software/software/fame
29
+ Project-URL: Issue Tracking, https://gitlab.com/fame-framework/fame-io/-/issues
30
+ Project-URL: Repository, https://gitlab.com/fame-framework/fame-io
31
+ Description-Content-Type: text/markdown
32
+
33
+ <!-- SPDX-FileCopyrightText: 2025 German Aerospace Center <fame@dlr.de>
34
+
35
+ SPDX-License-Identifier: Apache-2.0 -->
36
+ # FAME-Io
37
+
38
+ ## *Prepare input and digest output from simulation models*
39
+
40
+ [![License](https://img.shields.io/pypi/l/fameio.svg)](https://badge.fury.io/py/fameio)
41
+ [![Cite](https://img.shields.io/badge/DOI-10.21105%2Fjoss.04958-blue)](https://doi.org/10.21105/joss.04958)
42
+ [![Pipeline](https://gitlab.com/fame-framework/fame-io/badges/main/pipeline.svg)](https://gitlab.com/fame-framework/fame-io/commits/main)
43
+ [![Code Coverage](https://gitlab.com/fame-framework/fame-io/badges/main/coverage.svg)](https://gitlab.com/fame-framework/fame-io/-/jobs)
44
+ ![Last Commit](https://img.shields.io/gitlab/last-commit/fame-framework%2Ffame-io)
45
+
46
+ FAME-Io compiles input for FAME models and extracts model output to human-readable files. Model data is handled in the efficient protobuf format.<br>
47
+ [FAME](https://gitlab.com/fame-framework/wiki/-/wikis/home) is the open **F**ramework for distributed **A**gent-based **M**odels of **E**nergy systems.
48
+ Check out the full [FAME-Io documentation](https://fame-framework.gitlab.io/fame-io).
49
+
50
+ ## What is FAME-Io?
51
+
52
+ FAME-Io is the input-output toolkit for FAME-based simulation models.
53
+ The relationship to other components can be seen below.
54
+
55
+ <img src="https://gitlab.com/fame-framework/wiki/-/wikis/architecture/diagrams/Workflow.png" alt="FAME component workflow" width="75%">
56
+
57
+ FAME-Io (orange) combines model data (purple) and user input data (green) for the computation (blue).
58
+ After the computation, FAME-Io returns the results in a readable format.
59
+
60
+ Thus, with FAME-Io you can:
61
+
62
+ * Compile input binaries for simulation models built with FAME,
63
+ * Extract output binaries to human-readable formats like CSV and JSON,
64
+ * Edit large CSV files to enhance compilation speed.
65
+
66
+ ## Who is FAME-Io for?
67
+
68
+ FAME-Io is a vital file-conversion component for FAME-based workflows. If your model is not built with [FAME](https://gitlab.com/fame-framework/wiki/-/wikis/home), you will probably not profit from FAME-Io.
69
+
70
+ ## Applications
71
+
72
+ FAME-Io is used with any model that is based on FAME.
73
+ An example of its application is the electricity market model [AMIRIS](https://helmholtz.software/software/amiris).
74
+
75
+ ## Community
76
+
77
+ FAME-Io is mainly developed by the German Aerospace Center, Institute of Networked Energy Systems.
78
+ We provide support via the dedicated email address [fame@dlr.de](mailto:fame@dlr.de).
79
+
80
+ **We welcome all contributions**: bug reports, feature requests, documentation enhancements, and code.<br>
81
+ 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.
82
+ <br>Please see our [Contribution Guidelines](docs/source/contribute/contribute.rst).
83
+
84
+ ## Citing FAME-Io
85
+
86
+ If you use FAME-Io in academic work, please cite: [DOI 10.21105/joss.04958](https://doi.org/10.21105/joss.04958)
87
+
88
+ ```
89
+ @article{fameio2023joss,
90
+ author = {Felix Nitsch and Christoph Schimeczek and Ulrich Frey and Benjamin Fuchs},
91
+ title = {FAME-Io: Configuration tools for complex agent-based simulations},
92
+ journal = {Journal of Open Source Software},
93
+ year = {2023},
94
+ doi = {doi: https://doi.org/10.21105/joss.04958}
95
+ }
96
+ ```
97
+
98
+ In other contexts, please include a link to our [Gitlab repository](https://gitlab.com/fame-framework/fame-io).
99
+
fameio-3.5.0.dist-info/RECORD ADDED
@@ -0,0 +1,67 @@
1
+ fameio/__init__.py,sha256=DlM5K-vzwsZTcx932Bmsh5P9Gbb8AGllqPIwScv59lk,261
2
+ fameio/cli/__init__.py,sha256=bUrVcndT6OQ45AiVvG4VwiDAQmmX_FwCZBO8PaVGNa8,234
3
+ fameio/cli/convert_results.py,sha256=QfO5bQrPzFrnj-3C_LfmmPOOQosqAEpl7dTimE3It0k,3868
4
+ fameio/cli/make_config.py,sha256=LWNvqoNu9gYtlGNeLpNlitMhNDILLoVavRyjFfELoJM,2827
5
+ fameio/cli/options.py,sha256=8LwgP0e9DFfiqR1XoxJzpShyZak4o1bBlymq2mh_qYI,1447
6
+ fameio/cli/parser.py,sha256=Ux_SW13y4UhfAEfe02qnODSFVBjW_lndPCSqqp2Prm0,11357
7
+ fameio/cli/reformat.py,sha256=hnVsUyyMly3GN4TShl1QCVvb2w1d5gGgbUJUOWyN3Hw,2288
8
+ fameio/input/__init__.py,sha256=UcBQmK24luQzLUXNaYiJBZcCmYiy8cF2RtM0RJ-Qr9w,615
9
+ fameio/input/loader/__init__.py,sha256=YlxCAEJnORf6Dbab__m1Qr3ZOM55XvtczgFicO-erzc,2812
10
+ fameio/input/loader/controller.py,sha256=-azfGvOiEmMKpRzYFpEjiMcsLrAGbuXK_auPqSLiE3I,8182
11
+ fameio/input/loader/loader.py,sha256=CZxvbdwyPVOogKunH6vUn-OXxNLCCGqVoTqK4rWBKmg,5397
12
+ fameio/input/metadata.py,sha256=VB96o-MMi6WPtzLSM9P0Lrdn0VC6zClXziWrbuovjsk,6638
13
+ fameio/input/resolver.py,sha256=ZJnVICipcMSHp1KYXLeK-nZBXIFQBjmPh3V1Vvqb6nk,1936
14
+ fameio/input/scenario/__init__.py,sha256=h7C9pNtbrwRJ18VWRTCCcvwHrUg4xtPIc4ovhrBKvzI,490
15
+ fameio/input/scenario/agent.py,sha256=SI6HAm-YagnCCxYM55v8ZhrYYvVDSiI5dDKxrH9AqkE,5588
16
+ fameio/input/scenario/attribute.py,sha256=rTgy_rdvM0QYFZW-xzFYu95-yymLZqWc_89pYiKveOk,11458
17
+ fameio/input/scenario/contract.py,sha256=zMxJag_1pQwgthMCDxabmyqrSBKXd4Xpa60e-C5XuFE,15389
18
+ fameio/input/scenario/exception.py,sha256=VFo9wP7J9W0wx_S7ynnTsIcobVB4H82iklH1jUob7to,1998
19
+ fameio/input/scenario/fameiofactory.py,sha256=xjc1s1FTwbnS84pheqcGNllOJsN1fs7--J36RKO7VYI,2854
20
+ fameio/input/scenario/generalproperties.py,sha256=hfcp3fbE7ZtdXo9RrVTiObzHS05jxXf3A5kQP-FSMK8,3824
21
+ fameio/input/scenario/scenario.py,sha256=HOCeYj0i2aoLTpmwoywj0LEnfWjjJN_AHete9ZsbPTw,8422
22
+ fameio/input/scenario/stringset.py,sha256=wDMh0teCX1oiANafrua-_r1DyufL8zfXYQ9e6wlYFdE,2576
23
+ fameio/input/schema/__init__.py,sha256=PAqAvShdyhbxIa95WhJAVsiqeAFXYzb_nJiAHky84cU,401
24
+ fameio/input/schema/agenttype.py,sha256=cnYgAv70ylqnLZJiDar7pqBUGhcr4RqkrC7BZetmgHo,5735
25
+ fameio/input/schema/attribute.py,sha256=sEd7b1sxBWJySXte4vc3GQ2vTz4jPrJZ4NCxMAa_SZs,14962
26
+ fameio/input/schema/java_packages.py,sha256=aAwlr3pTNsRM4u6rj7h1UOPbG_kuMJw7KPk9wdaoISw,3032
27
+ fameio/input/schema/schema.py,sha256=rYfcGSk4byiXuI7QCU0_OH-MWT-Rn-PtkWI25lxetYo,4021
28
+ fameio/input/validator.py,sha256=55dE89u3Y6gYF3ClWXqKdctiVj6CvSU8l6kc1nJ6GEI,24109
29
+ fameio/input/writer.py,sha256=s-BarcsB6c8WqKBx3ctIp58EzqZWHceevMId_A-9df0,16635
30
+ fameio/logs.py,sha256=HgdiotKyp9X308RFXhWAlLVzJjcDSBWZzI-vPRoftls,4595
31
+ fameio/output/__init__.py,sha256=euHuzU3Uq4qWHOJvewNxobqYUha5mxidLuGTkus_Q2o,320
32
+ fameio/output/agent_type.py,sha256=V4wsleNQGp6XLMURHLzYvSGy7K0e9_BiC9WVnBlWmzU,7133
33
+ fameio/output/conversion.py,sha256=Z-x9vLqygFIBIpKGQ-z-qvOWyTobowug1QuI6BhS9dA,4769
34
+ fameio/output/csv_writer.py,sha256=AhUfZSoRemhQ4Zsd8RK3t-LiZrQAaekLkT5PcqSDr_Q,8183
35
+ fameio/output/data_transformer.py,sha256=--sUTADUL66F4zUmw6dOFuBoaJ8gdo_p22HLU8j-ZEQ,5321
36
+ fameio/output/execution_dao.py,sha256=mP1YiTh3_TNgocrJzYqAkdo42oyx7etVTcaQVoOb5QE,7042
37
+ fameio/output/input_dao.py,sha256=fs2SMvI7_aIIwAfMZdyHKGCgumFcFkJE9OGkKHlp4Jk,8530
38
+ fameio/output/metadata/__init__.py,sha256=JbKAcupner2ol7u5p2UyI0x-19OCd_INs24pW_VKmzc,339
39
+ fameio/output/metadata/compiler.py,sha256=r1p_yXqRlS32vo3R0yzdQdBYz5x19WE9I9DKNCRicbY,2958
40
+ fameio/output/metadata/json_writer.py,sha256=i-y_AuPLUiXaVhbZdVBM6gbLzvY8cC7AMdUIdG8Ky_0,1159
41
+ fameio/output/metadata/locator.py,sha256=_ky_aRdY-ktg7FtTRpPgojsu2VwUcFSx7tSYc7vU87w,9859
42
+ fameio/output/metadata/oeo_template.py,sha256=LfxdnJ1go5OjckfmoeAuZ6ltYzEbH_gHjofOBnqmOQI,4160
43
+ fameio/output/metadata/template_reader.py,sha256=A51XrHkr6ck2qHI3ZXJT0AxxXNl_-3Eyw0ada5ZnZws,2071
44
+ fameio/output/output_dao.py,sha256=eS3BwnK8-3GY2mjh1A2ypdlq1bwBTWSxyWnxtqRSOVA,4944
45
+ fameio/output/reader.py,sha256=AgCFDh_vBbLjLxN85OdC_AMOHC3Zst-U69FEa3sdLN4,6603
46
+ fameio/output/yaml_writer.py,sha256=tXNmMHFwpteQwpuREULjNCUQkxJ-OvtKe4Ep_GvGkSg,1131
47
+ fameio/scripts/__init__.py,sha256=8E2JBeaPRM4fmXC3zIugjaUNA1NIBugs5IHc5pZMiMc,1539
48
+ fameio/scripts/__init__.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
49
+ fameio/scripts/convert_results.py,sha256=AJKn5x8AFMv7VFBhdat9FoJXd3B7rx5neDaJZMcR3S0,9569
50
+ fameio/scripts/convert_results.py.license,sha256=EXKiZn-aoR7nO3auGMNGk9upHbobPLHAIBYUO0S6LUg,107
51
+ fameio/scripts/exception.py,sha256=zaIJ3V-KaAOwggW72DSo-LmyN2jtdTG4R-oYi1liVBc,283
52
+ fameio/scripts/make_config.py,sha256=O6GghQ1M1Y6bxlaS1c9joB066SCaCWvG_V-WTFqFreU,2016
53
+ fameio/scripts/make_config.py.license,sha256=EXKiZn-aoR7nO3auGMNGk9upHbobPLHAIBYUO0S6LUg,107
54
+ fameio/scripts/reformat.py,sha256=jYJsl0UkXtZyn2GyA-QVAARilkHa_ZBWa5CGNIGNDuo,2850
55
+ fameio/scripts/reformat.py.license,sha256=EXKiZn-aoR7nO3auGMNGk9upHbobPLHAIBYUO0S6LUg,107
56
+ fameio/series.py,sha256=KNDKe9CxScYSWacQKJGjwoBEK2I8mezYDAQJfmkU-f8,13987
57
+ fameio/time.py,sha256=jz-5ZXkIhrjcNuF0nNrQTShkyQFoeiyVOu5MEe7MPps,10253
58
+ fameio/tools.py,sha256=A3UtAIb-gH6tCcxuTzoNYrj4COGXISxoU9Tn9M_fmSM,2544
59
+ fameio-3.5.0.dist-info/entry_points.txt,sha256=IUbTceB_CLFOHulubEf9jgiCFsV2TchlzCssmjbiOKI,176
60
+ fameio-3.5.0.dist-info/LICENSE.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
61
+ fameio-3.5.0.dist-info/LICENSES/Apache-2.0.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
62
+ fameio-3.5.0.dist-info/LICENSES/CC-BY-4.0.txt,sha256=y9WvMYKGt0ZW8UXf9QkZB8wj1tjJrQngKR7CSXeSukE,19051
63
+ fameio-3.5.0.dist-info/LICENSES/CC-BY-ND-4.0.txt,sha256=i8xEGbjrLjDix0UDvo7U7-Mgb-riQ2jxX2Jozaz4U9k,18829
64
+ fameio-3.5.0.dist-info/LICENSES/CC0-1.0.txt,sha256=9Ofzc7m5lpUDN-jUGkopOcLZC3cl6brz1QhKInF60yg,7169
65
+ fameio-3.5.0.dist-info/METADATA,sha256=Ui_POdIBbt6Cv2KpCPKL7Y29HUsC6ri-GmL7Ob9zM8U,4796
66
+ fameio-3.5.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
67
+ fameio-3.5.0.dist-info/RECORD,,