search

GMLC-TDC / HELICS

Hierarchical Engine for Large-scale Infrastructure Co-Simulation (HELICS)
https://docs.helics.org/en/latest/
BSD 3-Clause "New" or "Revised" License
126 stars 40 forks source link

Add documentation and examples on using HELICS callbacks in supported languages #2279

Open trevorhardy opened 2 years ago

trevorhardy commented 2 years ago

Callbacks for custom filters, custom translators (and others?) are supported in some languages but not documented in the User Guide. We should add documentation and examples to fill this gap.

trevorhardy commented 2 years ago

The PyHELICS v2 to v3 transition page has an example of how to set up a filter federate callback in PyHELICS and I'm assuming something similar would work for logging but a full worked example of both would be useful.

trevorhardy commented 6 months ago

Added to PyHELICS documentation as a part of getting v3.5.0 and helics_connector app working. An example of using the query callback exists as part of the HELICS connector example.

trevorhardy commented 6 months ago

With Python knocked out, I think the list of supported languages we need to get an example added to would be:

We're not including C++98 as that is a "native" language for HELICS and implementing the callback there is more about knowing C++98 than knowing anything HELICS-specific. The callback signature is defined in the API and should be manageable.