Contribute to EnergyModelsHydrogen

Contributing to EnergyModelsHydrogen can be achieved in several different ways.

File a bug report

Another approach to contributing to EnergyModelsHydrogen is through filing a bug report as an issue when unexpected behaviour is occuring.

When filing a bug report, please follow the following guidelines:

1. Be certain that the bug is a bug and originating in EnergyModelsHydrogen:
   • 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 EnergyModelsHydrogen and should be reported.
   • If the problem occurs in model construction, it is most likely a bug in either EnergyModelsBase or EnergyModelsHydrogen and 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 in EnergyModelsBase or EnergyModelsHydrogen. It can occur, that the last shown failing function is within JuMP or MathOptInterface. In this case, it is best to trace the error to the last called EnergyModelsBase or EnergyModelsHydrogen function.
   • If the problem is only appearing for specific solvers, it is most likely not a bug in EnergyModelsHydrogen, but instead a problem of the solver wrapper for MathOptInterface. In this case, please contact the developers of the corresponding solver wrapper.
2. Label the issue as bug, and
3. Provide a minimum working example of a case in which the bug occurs.

Feature requests

EnergyModelsHydrogen includes several new nodal descriptions for hydrogen technologies. However, there can be a demand for additional requirements for the existing nodes or for new descriptions which fall below the umbrella of hydrogen technologies. In this case, you can contribute through a feature request.

Feature requests for EnergyModelsHydrogen should follow the guidelines developed for EnergyModelsBase.