A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

FAME

Its purpose is supporting the rapid development and fast execution of complex agent-based energy system simulations.
https://gitlab.com/fame-framework/fame-core

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords

FAME

Keywords from Contributors

agent-based-modeling electricity market modelling energy transition

Last synced: about 19 hours ago
JSON representation

Repository metadata

Core library of FAME written in Java

https://gitlab.com/fame-framework/fame-core/blob/dev/

          
# FAME-Core
FAME's core library written in Java. 
Minimum required JDK version is 11.

## What is FAME?
FAME is an open **F**ramework for distributed **A**gent-based **M**odels of **E**nergy systems.
Its purpose is to support the rapid development and fast execution of complex agent-based energy system simulations.
All components of FAME are open source.
These components are:
- **FAME-Core**: A Java library that provides classes and methods to create and run your own agent-based simulations in single-core or multi-core mode.
- **FAME-Io**: A set of Python tools that enable you to feed input data to your simulations and to extract simulation results in a convenient way.
- **FAME-Gui**: A graphical user interface for convenient configuration of FAME-based models.
- **FAME-Protobuf**: Basic definitions for input and output formats of FAME-Core.
- **FAME-Demo**: A simplistic FAME-based simulation demonstrating the most important features of FAME and their application in energy systems analysis.
- **FAME-Mpi**: Components for parallelisation of FAME-Core applications.

Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to access detailed manuals and explanations of these FAME-components.

## Statement of need
FAME is a general framework intended for, but not exclusive to, energy systems analysis.
It facilitates the development of complex agent-based simulations.
FAME enables parallel execution of simulations without any prior knowledge about parallelisation techniques.
Models built with FAME can be executed on computer systems of any capacity – from your laptop to high-performance computing clusters.
Furthermore, FAME applications are binary data files that are portable across Windows and Linux systems.
FAME's highly adaptable contracting system offers broad configuration options to control simulations without changing its code.

FAME-Core has been thoroughly tested to fulfil the demand of scientific rigor and to provide a stable and reliable simulation framework.
It provides thoroughly tested functionality common to all simulations (e.g. input, output, scheduling, communication), resulting in

1. less code → less errors → less maintenance, 
2. higher transparency of existing models due to common interfaces and concepts of the respective framework, and 
3. a lower threshold for developing new models by providing a well-defined starting point.

## Installation instructions
FAME-Core can be installed easily by using [Apache Maven](https://maven.apache.org/).
In your Java project, just add the FAME-Core dependency to your `pom.xml`:

```

    de.dlr.gitlab.fame
    core
    2.0.0

```

Please see [Maven-central](https://mvnrepository.com/artifact/de.dlr.gitlab.fame/core) for the latest version.
Have a look at the [Getting Started](https://gitlab.com/fame-framework/wiki/-/wikis/GetStarted/Getting-started) section in the Wiki to understand how to set up a model using FAME-Core.  

## Available Support
This is a purely scientific project, hence there will be no paid technical support.
Limited support is available, e.g. to enhance FAME, fix bugs, etc. 
To report bugs or pose enhancement requests, please file issues following the provided templates (see also [CONTRIBUTING.md](CONTRIBUTING.md))
For substantial enhancements, contact us via [[email protected]](mailto:[email protected]) for working together on the code in joint projects or towards collaborative publications.

## Citing FAME-Core
If you use FAME-Core in your scientific work please cite:

Christoph Schimeczek, Marc Deissenroth-Uhrig, Ulrich Frey, Benjamin Fuchs, A. Achraf El Ghazi, Manuel Wetzel & Kristina Nienhaus (2023).
FAME-Core: An open Framework for distributed Agent-based Modelling of Energy systems.
Journal of Open Source Software. [doi: 10.21105/joss.05087](https://doi.org/10.21105/joss.05087)

        

Committers metadata

Last synced: 9 months ago

Total Commits: 374
Total Committers: 7
Avg Commits per committer: 53.429
Development Distribution Score (DDS): 0.262

Commits in past year: 131
Committers in past year: 3
Avg Commits per committer in past year: 43.667
Development Distribution Score (DDS) in past year: 0.053

Name Email Commits
Christoph Schimeczek C****k@d****e 276
Christoph Schimeczek c****k@d****e 43
Aboubakr Achraf El Ghazi a****i@d****e 29
schi_co s****o@T****e 19
frey_ul f****l@T****e 4
Felix Nitsch f****h@d****e 2
Frey U****y@d****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: 9 months ago

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull request: 0
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://gitlab.com/fame-framework/fame-core

Top Issue Authors

Top Pull Request Authors


Top Issue Labels

Top Pull Request Labels


Package metadata

repo1.maven.org: de.dlr.gitlab.fame:core

An open framework for distributed agent-based modeling of energy systems

  • Homepage: https://gitlab.com/fame-framework/fame-core
  • Documentation: https://appdoc.app/artifact/de.dlr.gitlab.fame/core/
  • Licenses: The Apache License, Version 2.0
  • Latest release: 2.0.3 (published 23 days ago)
  • Last Synced: 2025-04-26T13:32:37.009Z (2 days ago)
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Rankings:
    • Dependent repos count: 13.777%
    • Average: 43.812%
    • Dependent packages count: 50.15%
    • Stargazers count: 52.69%
    • Forks count: 58.631%

Dependencies

pom.xml maven
  • com.google.protobuf:protobuf-java-util 3.18.1
  • de.dlr.gitlab.fame:mpi-api 1.0.1
  • de.dlr.gitlab.fame:mpi-singlecore-impl 1.0.1
  • de.dlr.gitlab.fame:protobuf 1.2.0
  • info.picocli:picocli 4.6.1
  • org.apache.commons:commons-lang3 3.12.0
  • org.reflections:reflections 0.9.12
  • org.slf4j:slf4j-api 1.7.25
  • org.yaml:snakeyaml 1.29
  • io.github.hakky54:logcaptor 2.6.1 test
  • junit:junit 4.13.2 test
  • org.mockito:mockito-inline 3.12.4 test

Score: 6.263398262591624