EnergyModelsCompliance is an extension package within the EnergyModelsX (EMX) framework.
It provides the user with the functionality for identifying potential problems in newly developed elements for the EMX framework.
While it can be used as a first step for checking new elements, thorough tests of new elements are always recommended to test whether the developed elements fulfill the needs.
The usage of the package is best illustrated through the commented examples.
The examples showcase how the functions from EnergyModelsCompliance can be utilized to identify whether your newly developed element can be incorporated in EnergyModelsBase or EnergyModelsGeography models.
Important
The reimplementation of the ExtensionData in EnergyModelsBase v0.9.1 and the corresponding adjustment in EnergyModelsGeography v0.11.3 resulted in problems for checking the function mode_data.
The check is hence deactivated while we consider how to do properly assess it in EnergyModelsBase and EnergyModelsGeography.
If you find EnergyModelsCompliance useful in your work, we kindly request that you cite the following publication:
@article{hellemo2024energymodelsx,
title = {EnergyModelsX: Flexible Energy Systems Modelling with Multiple Dispatch},
author = {Hellemo, Lars and B{\o}dal, Espen Flo and Holm, Sigmund Eggen and Pinel, Dimitri and Straus, Julian},
journal = {Journal of Open Source Software},
volume = {9},
number = {97},
pages = {6619},
year = {2024},
doi = {https://doi.org/10.21105/joss.06619},
}The development of EnergyModelsCompliance was funded by the European Union’s Horizon Europe research and innovation programme in the project iDesignRES under grant agreement 101095849.