<!-- SPDX-FileCopyrightText: 2025 German Aerospace Center <fame@dlr.de>
SPDX-License-Identifier: Apache-2.0 -->
# FAME-Io
## *Prepare input and digest output from simulation models*
[](https://badge.fury.io/py/fameio)
[](https://doi.org/10.21105/joss.04958)
[](https://gitlab.com/fame-framework/fame-io/commits/main)
[](https://gitlab.com/fame-framework/fame-io/-/jobs)
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>
[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.
Check out the full [FAME-Io documentation](https://fame-framework.gitlab.io/fame-io).
## What is FAME-Io?
FAME-Io is the input-output toolkit for FAME-based simulation models.
The relationship to other components can be seen below.
<img src="https://gitlab.com/fame-framework/wiki/-/wikis/architecture/diagrams/Workflow.png" alt="FAME component workflow" width="75%">
FAME-Io (orange) combines model data (purple) and user input data (green) for the computation (blue).
After the computation, FAME-Io returns the results in a readable format.
Thus, with FAME-Io you can:
* Compile input binaries for simulation models built with FAME,
* Extract output binaries to human-readable formats like CSV and JSON,
* Edit large CSV files to enhance compilation speed.
## Who is FAME-Io for?
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.
## Applications
FAME-Io is used with any model that is based on FAME.
An example of its application is the electricity market model [AMIRIS](https://helmholtz.software/software/amiris).
## Community
FAME-Io is mainly developed by the German Aerospace Center, Institute of Networked Energy Systems.
We provide support via the dedicated email address [fame@dlr.de](mailto:fame@dlr.de).
**We welcome all contributions**: bug reports, feature requests, documentation enhancements, and code.<br>
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.
<br>Please see our [Contribution Guidelines](docs/source/contribute/contribute.rst).
## Citing FAME-Io
If you use FAME-Io in academic work, please cite: [DOI 10.21105/joss.04958](https://doi.org/10.21105/joss.04958)
```
@article{fameio2023joss,
author = {Felix Nitsch and Christoph Schimeczek and Ulrich Frey and Benjamin Fuchs},
title = {FAME-Io: Configuration tools for complex agent-based simulations},
journal = {Journal of Open Source Software},
year = {2023},
doi = {doi: https://doi.org/10.21105/joss.04958}
}
```
In other contexts, please include a link to our [Gitlab repository](https://gitlab.com/fame-framework/fame-io).
Raw data
{
"_id": null,
"home_page": "https://helmholtz.software/software/fame",
"name": "fameio",
"maintainer": "Felix Nitsch",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "fame@dlr.de",
"keywords": "FAME, fameio, agent-based modelling, energy systems",
"author": "Felix Nitsch",
"author_email": "fame@dlr.de",
"download_url": "https://files.pythonhosted.org/packages/a8/ab/3b50a525dc454c80113d41f61107210d4d5e8cafef9eda42da455d8aa763/fameio-3.5.1.tar.gz",
"platform": null,
"description": "<!-- SPDX-FileCopyrightText: 2025 German Aerospace Center <fame@dlr.de>\n\nSPDX-License-Identifier: Apache-2.0 -->\n# FAME-Io\n\n## *Prepare input and digest output from simulation models*\n\n[](https://badge.fury.io/py/fameio)\n[](https://doi.org/10.21105/joss.04958)\n[](https://gitlab.com/fame-framework/fame-io/commits/main)\n[](https://gitlab.com/fame-framework/fame-io/-/jobs)\n\n\nFAME-Io compiles input for FAME models and extracts model output to human-readable files. Model data is handled in the efficient protobuf format.<br>\n[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.\nCheck out the full [FAME-Io documentation](https://fame-framework.gitlab.io/fame-io).\n\n## What is FAME-Io?\n\nFAME-Io is the input-output toolkit for FAME-based simulation models.\nThe relationship to other components can be seen below.\n\n<img src=\"https://gitlab.com/fame-framework/wiki/-/wikis/architecture/diagrams/Workflow.png\" alt=\"FAME component workflow\" width=\"75%\">\n\nFAME-Io (orange) combines model data (purple) and user input data (green) for the computation (blue).\nAfter the computation, FAME-Io returns the results in a readable format.\n\nThus, with FAME-Io you can:\n\n* Compile input binaries for simulation models built with FAME,\n* Extract output binaries to human-readable formats like CSV and JSON,\n* Edit large CSV files to enhance compilation speed.\n\n## Who is FAME-Io for?\n\nFAME-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.\n\n## Applications\n\nFAME-Io is used with any model that is based on FAME.\nAn example of its application is the electricity market model [AMIRIS](https://helmholtz.software/software/amiris).\n\n## Community\n\nFAME-Io is mainly developed by the German Aerospace Center, Institute of Networked Energy Systems.\nWe provide support via the dedicated email address [fame@dlr.de](mailto:fame@dlr.de).\n\n**We welcome all contributions**: bug reports, feature requests, documentation enhancements, and code.<br>\nFor 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.\n<br>Please see our [Contribution Guidelines](docs/source/contribute/contribute.rst).\n\n## Citing FAME-Io\n\nIf you use FAME-Io in academic work, please cite: [DOI 10.21105/joss.04958](https://doi.org/10.21105/joss.04958)\n\n```\n@article{fameio2023joss,\n author = {Felix Nitsch and Christoph Schimeczek and Ulrich Frey and Benjamin Fuchs},\n title = {FAME-Io: Configuration tools for complex agent-based simulations},\n journal = {Journal of Open Source Software},\n year = {2023},\n doi = {doi: https://doi.org/10.21105/joss.04958}\n}\n```\n\nIn other contexts, please include a link to our [Gitlab repository](https://gitlab.com/fame-framework/fame-io).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Tools for input preparation and output digestion of FAME models",
"version": "3.5.1",
"project_urls": {
"Changelog": "https://gitlab.com/fame-framework/fame-io/-/blob/main/CHANGELOG.md",
"Homepage": "https://helmholtz.software/software/fame",
"Issue Tracking": "https://gitlab.com/fame-framework/fame-io/-/issues",
"Repository": "https://gitlab.com/fame-framework/fame-io"
},
"split_keywords": [
"fame",
" fameio",
" agent-based modelling",
" energy systems"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "949b4a4cbf2bb045b041985d32657407df2c5abcac81d336f890758fa678060a",
"md5": "b6aad2be92f007ecae2b9bdbcd55aeee",
"sha256": "79ab63de85fbc8274928f149156c39ba6eeec5885577c4fe0479e0879ebe7ab7"
},
"downloads": -1,
"filename": "fameio-3.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b6aad2be92f007ecae2b9bdbcd55aeee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 120204,
"upload_time": "2025-07-25T10:16:45",
"upload_time_iso_8601": "2025-07-25T10:16:45.112910Z",
"url": "https://files.pythonhosted.org/packages/94/9b/4a4cbf2bb045b041985d32657407df2c5abcac81d336f890758fa678060a/fameio-3.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8ab3b50a525dc454c80113d41f61107210d4d5e8cafef9eda42da455d8aa763",
"md5": "4530ef219bf14b4e687380bddac34cfa",
"sha256": "f49ca913b4b034dd59eb037db37658c7ae03c6a6a65045b2d070552ddbe9d9c3"
},
"downloads": -1,
"filename": "fameio-3.5.1.tar.gz",
"has_sig": false,
"md5_digest": "4530ef219bf14b4e687380bddac34cfa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 83193,
"upload_time": "2025-07-25T10:16:46",
"upload_time_iso_8601": "2025-07-25T10:16:46.564567Z",
"url": "https://files.pythonhosted.org/packages/a8/ab/3b50a525dc454c80113d41f61107210d4d5e8cafef9eda42da455d8aa763/fameio-3.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 10:16:46",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "fame-framework",
"gitlab_project": "fame-io",
"lcname": "fameio"
}
JSON