Contribute to EnergyModelsInvestments
Contributing to EnergyModelsInvestments can be achieved in several different ways.
File a bug report
Another approach to contributing to EnergyModelsInvestments 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
EnergyModelsInvestments:- 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
EnergyModelsInvestmentsand should be reported. - If the problem occurs in model construction, it is most likely a bug in either
EnergyModelsBaseorEnergyModelsInvestmentsand 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 inEnergyModelsBaseorEnergyModelsInvestments. It can occur, that the last shown failing function is withinJuMPorMathOptInterface. In this case, it is best to trace the error to the last calledEnergyModelsBaseorEnergyModelsInvestmentsfunction. - If the problem is only appearing for specific solvers, it is most likely not a bug in
EnergyModelsInvestments, 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.
We are aware that certain design choices within EnergyModelsInvestments can lead to method ambiguities. Our aim is to extend the documentation to improve the description on how to best extend the base functionality as well as which caveats can occur.
In order to improve the code, we welcome any reports of potential method ambiguities to help us improving the structure of the framework.
Feature requests
EnergyModelsInvestments includes several Investment options and LifetimeModes. However, not all potential options are included. Hence, if you require a new investment or lifetime mode, it is best to provide a feature request.
Feature requests for EnergyModelsInvestments should follow the guidelines developed for EnergyModelsBase.
EnergyModelsInvestments is slightly different than EnergyModelsBase.
Contrary to the other package, we consider that it is beneficial to have all potential features of investment decisions within EnergyModelsInvestments. Hence, requiring a new Investment mode or LifetimeMode should be addressed directly to EnergyModelsInvestments through creating an issue.