HELICS v3.1.1 Release Notes

Release Date: 2021-12-14 // over 2 years ago
  • ๐Ÿš€ Primarily a bug fix release to fix a build issue resulting in internal logging messages being disabled for some of the release packages. Also includes a maxcosimduration argument for brokers to kill the co-sim after a certain amount of wall clock time.

    ๐Ÿ›  Fixed

    • ๐Ÿš€ CMake issue resulting in internal logging messages being disabled for some builds including some package releases.
    • ๐Ÿ›  Fixed a few deadlock pathways if the core was killed internally.
    • ๐Ÿ›  Fixed some timeout issues in the CI builds.
    • ๐Ÿ›  Fixed a potential race condition when setting the log file after execution has started on helics cores.

    ๐Ÿ”„ Changed

    • โœ… CMake version 3.22 tested and used if available.
    • ๐Ÿ‘€ The TCP networking components that were not core to HELICS have been moved to a separate repo and linked as a submodule. See [networking](www.github.com/GMLC-TDC/networking).
    • ๐Ÿ“š Several documentation fixes and updates.
    • ๐Ÿ”€ Moved to using the upstream toml11 repo instead of a custom modified version. Customized modifications have now been merged upstream.

    โž• Added

    • '--maxcosimduration' flag added in the broker to specify a max co-sim duration after which the cosimulation will be terminated.
    • helicsGetSystemInfo() function was added to the API to retrieve HELICS version and system info for debugging and diagnostic purposes.
    • โž• Added a threaded signal handler to execute close out operations in a new thread and return control back to the main thread to wait for error signals.
    • โž• Added helicsFederateInfoLoadFromString to better match C++ API available functions. This loads the federateInfo structure from command line arguments contained in a string.