Contribute to EnergyModelsCO2
Contributing to EnergyModelsCO2 can be achieved in several different ways.
File a bug report
Another approach to contributing to EnergyModelsCO2 is through filing a bug report as an issue when unexpected behaviour is occuring.
When filing a bug report, please follow the following guidelines:
- Be certain that the bug is a bug and originating in
EnergyModelsCO2:- If the problem is within the results of the optimization problem, please check first that the nodes are correctly linked with each other. Frequently, missing links (or wrongly defined links) restrict the transport of energy/mass. If you are certain that all links are set correctly, it is most likely a bug in
EnergyModelsCO2and should be reported. - If the problem occurs in model construction, it is most likely a bug in either
EnergyModelsBaseorEnergyModelsCO2and should be reported in the respective package. The error message of Julia should provide you with the failing function and whether the failing function is located inEnergyModelsBaseorEnergyModelsCO2. It can occur, that the last shown failing function is withinJuMPorMathOptInterface. In this case, it is best to trace the error to the last calledEnergyModelsBaseorEnergyModelsCO2function. - If the problem is only appearing for specific solvers, it is most likely not a bug in
EnergyModelsCO2, but instead a problem of the solver wrapper forMathOptInterface. In this case, please contact the developers of the corresponding solver wrapper.
- If the problem is within the results of the optimization problem, please check first that the nodes are correctly linked with each other. Frequently, missing links (or wrongly defined links) restrict the transport of energy/mass. If you are certain that all links are set correctly, it is most likely a bug in
- Label the issue as bug, and
- Provide a minimum working example of a case in which the bug occurs.
Feature requests
EnergyModelsCO2 includes several new nodal descriptions for renewable energy producers. However, there can be a demand for additional requirements for the existing nodes or for new descriptions which fall below the umbrella of renewable energy producers. In this case, you can contribute through a feature request.
Feature requests for EnergyModelsCO2 should follow the guidelines developed for EnergyModelsBase.
EnergyModelsCO2 is slightly different than EnergyModelsBase.
Contrary to the other package, we consider that it is beneficial to have all potential features of the CO₂ capture, transport, and storage chain within EnergyModelsCO2. Hence, if you have a requirement for a new nodal description, do not hesitate to create an issue.