Skip to main content

Tools for input preparation and output digestion of FAME models

Project description

FAME-Io

Prepare input and digest output from simulation models

License Cite Pipeline Code Coverage Last Commit

FAME-Io compiles input for FAME models and extracts model output to human-readable files. Model data is handled in the efficient protobuf format.
FAME is the open Framework for distributed Agent-based Models of Energy systems. Check out the full FAME-Io documentation.

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.

FAME component workflow

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, 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.

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.

We welcome all contributions: bug reports, feature requests, documentation enhancements, and code.
For substantial enhancements, we recommend that you contact us via fame@dlr.de for working together on the code in common projects or towards common publications and thus further develop FAME-Io.
Please see our Contribution Guidelines.

Citing FAME-Io

If you use FAME-Io in academic work, please cite: DOI 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fameio-3.5.3.tar.gz (83.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fameio-3.5.3-py3-none-any.whl (120.5 kB view details)

Uploaded Python 3

File details

Details for the file fameio-3.5.3.tar.gz.

File metadata

  • Download URL: fameio-3.5.3.tar.gz
  • Upload date:
  • Size: 83.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.12 Windows/10

File hashes

Hashes for fameio-3.5.3.tar.gz
Algorithm Hash digest
SHA256 166f2d4a1b187985fc71391bae35b6dcc173d4919efa4c5baa718caf4e0683ec
MD5 f342cd74a81cb142a37a66625f041131
BLAKE2b-256 811c219f220b172708ddb4922d0b8c122ebf3d10ac0f99cf3c31cb600257fd90

See more details on using hashes here.

File details

Details for the file fameio-3.5.3-py3-none-any.whl.

File metadata

  • Download URL: fameio-3.5.3-py3-none-any.whl
  • Upload date:
  • Size: 120.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.12 Windows/10

File hashes

Hashes for fameio-3.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fa22e09659c6b3b6598d3ad67e493028bf3a4c70a5f292700c8675f8e9c1f873
MD5 0ff6386f614277d8d9be7c6521147ac5
BLAKE2b-256 e71fe6fba69a31a626e1d9777b7757a90af4bc96e0f1546b1923372d292f1d2a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page