HELICS - v3.6.1

Minor release with updates for connector to allow targets and updates to the command line operations for the helics apps

Fixed

• Fixed issue with apps with positional arguments on the command line, which interacted poorly in some cases with the config file used in Federate definition
• Automatic linking with lib atomic for required systems

Changed

• clone app now uses initialization iteration to resolve some timing issues
• Updated third party libraries (toml, fmt, spdlog, benchmark, googletest)
• Updated copyright dates to 2025
• Updated code to work with Boost 1.87

Added

• Added ability for the connector operations to handle targets specified in potential interfaces
• Added check for exported symbols list on macos to improve portability

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp 3 months ago

HELICS - v3.6.0

Major release including app support in the C library, bug fixes, and an update to the minimum build requirement for HELICS moving to a default of C++20. The 3.7 release will make C++20 the minimum compile standard. This release also changes out the json interpreter to use nlohmann::json instead of json_cpp.

Fixed

• Fixed issue with maximum message size for the ZMQ and ZMQ_SS core types. Now block sizes up to 4 GB are supported on these core types (subject to memory limitations). This change is not backwards compatible in that previous versions will still not work with these sizes but it will still be recognized and perform equivalent or better then previously on older versions of HELICS. To support these sizes all federates must be updated to HELICS 3.6 and higher.
• Fixed release builder to use new minimum build standards
• Fixed issue where in certain cases the potential interfaces were not getting established and used by the connector
• Fixes for sanitizer builds and other clang-tidy and compiler warnings

Changed

• Test with Boost 1.86 and CMake 3.31
• Changed default C++ standard to C++20. Eventual 3.7 release will make this a minimum.
• Minimum build requirements changed to:
  • GCC 11
  • Clang 15
  • CMake 3.22
  • MSVC 16.10
  • XCode 14
  • Boost 1.73
• Updated third party libraries (toml, asio, fmt, spdlog, units)
• Replaced usage of json_cpp with nlohmann::json

Added

• Added C shared library interface to the helics app library
• Added ability to send files directly to brokers and cores for configuration
• Added a global sync disconnect so all federates stay active until the federation is completed

Removed

• Removed Octave interface build from the HELICS repo; Octave is now supported via matHELICS
• Removed dependency on Boost.ScopeExit in the MPI core

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp 5 months ago

HELICS - v3.5.3

Patch release with fixes for potential interface definitions and some compiler warnings

Fixed

• Fixed some compiler warnings on the connector

Added

• Added support for "potential_interface_templates" object in json configuration
• Added support for arrays of tags
• Added support for "fields" object in potential interface template definitions

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp 11 months ago

HELICS - v3.5.2

Patch release with fixes for certain compiler builds, a fix to the test core leading to some sporadic test failures, and fixing a discrepancy in the handing of config files with the helics_apps.

Fixed

• Fixed an issue with the test core leading to sporadic failures in the test suite with the connector
• Fixed compile issues on some versions of clang
• Fixed some warnings on certain builds using sanitizers
• Fixed a discrepancy in the handing of config files with the helics_apps library
• Fixed several clang tidy issues and code cleanup

Added

• Added an --error_on_unmatched flag to the broker for it to error if there are any unmatched requested connectors
• Support for a broker section in config files and subcommand in the command line parsing

Full Changelog: https://github.com/GMLC-TDC/HELICS/compare/v3.5.1...v3.5.2

Energy Systems - Energy System Modeling Frameworks - C++
Published by nightlark about 1 year ago

HELICS - v3.5.1

Patch release including beta version of reentrant federates and support for "potential_interfaces" section in config files and automatic handling of potential interface generation in the federate class for operation with the connector app.

Fixed

• Fixed an issue related to disconnection of federates with endpoints while still executing, that could potentially have resulted in an infinite loop
• Fixed an issue with aliases potentially causing a seg fault or memory condition, now aliases have reciprocity so order in the given alias call doesn't matter

Changed

• Updated 3rd party libraries including cli11, fmt, spdlog, and asio

Added

• Automatic handling of potential interface sequence from Federate class
• Support for potential_interface templates
• Support for reentrant federates: federates with the same name that can come and go, and support for reconnecting interfaces to the reentrant federate
• Support for a "helics" section in the configuration json files

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 1 year ago

HELICS - v3.5.0

Major release including connector app capability, a refresh of the of the dataBuffer interface, and other bug fixes

Fixed

• Fixed some issues regarding config files in the apps, where the config file was not being handled consistently
• Fixed a few more sporadically failing testing cases and a rare bug in the use of wait_for_current_time flag when entering executing mode
• Fixed a memory growth issue related to find operations in the C interface
• Resolved some issues with the threadSanitizer and other sporadic failures in the test cases

Changed

• Test with Boost 1.84 and CMake 3.28
• Large refactor of the dataBufferAPI, this is now considered stable, all dataBuffer related methods now start with helicsDataBuffer for consistency with other API methods and the XXXToBytes methods are changed to FillFromXXXX to be more consistent with other API's
• Update 3rd party libraries
• Update copyright to 2024
• Autobuild ZMQ now set to 4.3.5

Added

• Added Connector app to enable automated connections of the federates via a set of matching rules, and allow optional interface generation via a query/command
• Added helics::systemInfo() to the C++ shared library
• Added ability to generate translators from config files
• Added API's to get and send dataBuffers from publications/inputs/endpoints

Deprecated

• Nearly all methods that use Subscription in the name have been deprecated in favor of an equivalent version for Input to reduce confusion of use of subscription objects (which are just Input objects); these are all 1:1 mappings
  • getSubscription(string target) -> getInputByTarget(string target)
  • getSubscription(int index) -> getInput(int index)
  • helicsSubscriptionGetTarget(inp) -> helicsInputGetTarget(inp)
  • helicsFederateGetSubscription(fed, string target)->helicsFederateGetInputByTarget(fed,string target)

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 1 year ago

HELICS - v3.4.0

Major release including full dynamic federation capability and wildcard based matching for interface connections.

Fixed

• Updated some out of date docker images to build automatically and fix some issues preventing the use of -flto option
• Fixed a few more sporadically failing testing cases and a rare bug in the use of wait_for_current_time flag when entering executing mode

Changed

• Test with Boost 1.81 and CMake 3.25
• Update the units library
• Update Spdlog library
• Update to release 2.3 of CLI11
• Split the application API tests in a set of 4 smaller tests to reduce test runtime and ease maintenance.
• Update copyright to 2023

Added

• Added the capability to link interfaces through a regex expression. "REGEX: <regex>" this format of string can be used in any place interface names can be used. This will not work on targets linked after initialization mode at present though this is expected to be relaxed in the future. Also if both sides are specified as strings at least one of them must be an actual name.
• Added fully dynamic federation capability. Federates may be added dynamically if --dynamic flag is set on the root broker. Dynamic publications and endpoints are enabled by default but can be disabled.
• Added automated workflow for generating release task checklist on version release
• Added dependabot configuration for updating github-actions workflow dependencies
• Added documentation on using encrypted communication in HELICS
• Added support for using environment variables for enabling encryption instead of command line arguments for federates

Deprecated

• Nearly all methods that use Subscription in the name have been deprecated in favor of an equivalent version for Input to reduce confusion of use of subscription objects (which are just Input objects); these are all 1:1 mappings
  • getSubscription(string target) -> getInputByTarget(string target)
  • getSubscription(int index) -> getInput(int index)
  • helicsSubscriptionGetTarget(inp) -> helicsInputGetTarget(inp)
  • helicsFederateGetSubscription(fed, string target)->helicsFederateGetInputByTarget(fed,string target)

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 2 years ago

HELICS - v3.3.2

Patch release to fix some testing issues and add some network probing capabilities and remote terminal connections.

Fixed

• Fixed a few sporadically failing CI tests

Changed

• Update containers library
• Update the units library
• Split the application API tests in a set of 4 smaller tests to reduce test runtime and ease maintenance.

Added

• Added a remote terminal capability to link with a remote Broker server running a rest API.
• Added ARM based Circle CI test.
• Added a probe app for testing some networking situations and connections.
• Added tests for the tcp federate under various conditions.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 2 years ago

HELICS - v3.3.1

Patch release to fix some issues with using HELICS as a subproject, and fix a few bugs related to time barriers, and a few other timing issues.

Fixed

• Fixed an issue where broker based time barriers were not propagating to new federates.
• Fix the code coverage build system.
• Fixed a potential race condition with callback federates if the callback operations are modified during cosimulation.
• Fixed timing synchronization issue with global time coordinator.

Changed

• Cleaned up usage of HELICS in external subprojects and adding some cleanup features, also cleanup the CMake usage to divide some operations into included files to simplify the main CMakeLists.txt
• Changed the default behavior for profiler output files to create a new file instead of appending. Use --profiler_append=<file> to maintain the old behavior.

Added

• Added single thread federate support which includes a federate optimized for use in a single thread.(Corresponding single thread core will come in next release).
• Added support for initialization iteration to allow federates to specify ready and then return to the created mode to do additional initialization potentially with information from other federates.
• Added flag to disable remote termination commands.
• Added C API function calls for alias operations.
• Added read only property HELICS_PROPERTY_INT_ITERATION_COUNT to get the current iteration count for a federate.

Removed

• Removed an unused and unexposed method in the Core API to retrieve the current iteration count, use HELICS_PROPERTY_INT_ITERATION_COUNT with getProperty to retrieve the same data.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 2 years ago

HELICS - v3.3.0

Minimum build requirements updated to CMake 3.11, Visual Studio 2019, XCode 11.0, GCC 8.1, Clang 7.0.
The major new features include a callback federate, and aliases to allow interfaces to have multiple string names, and an asynchronous time coordinator.
The release also includes several bug fixes related to timing and iteration, and updates to third party libraries.

Fixed

• Fixed an issue with using very large iteration counts
• Fixed some potential memory leaks in the test set
• Fixed an issue created by the long name tests with the release generation
• Fixed an issue with mismatching key names for publishers
• Removed additional use of std::async in the tests which was causing sporadic failures in the test execution
• Fixed an issue that could occur when switching between NO_ITERATIONS and ITERATE_IF_NEEDED resulting in deadlock
• Fixed an issue that resulted in a timeout disconnect potentially not working properly
• Fixed the command interface API in the C++98 interface
• Fixed issue with potential out of order messages when using interruptions, MAX_TIME, and endpoint communications

Changed

• Additional use of std::string_view in internal callbacks and network operations
• cleaned up use of internal flags and separated them by category
• Updated the docker images used in CI tests for no_zmq and octave tests
• Updated Utilities, Units, ASIO, fmtlib, gtest to latest versions
• Refactored endpoint management code for consistency with other interfaces
• The HELICS_DATA_TYPE_CHAR is now a member of the enumeration vs a standalone definition there is no change in operation but the numerical value is now different
• The change detection on inputs/publication now can work individually for each interface
• The default webserver ports, now uses 43542(Http) and 43543(Websocket). This is to not conflict by default if both are used and to accommodate other servics that might be running on the same system.
• The REST API now returns a structure on successful broker creation
• The helics_broker executable now has the same command line arguments for the webserver as the broker_server

Added

• Custom Translator functionality in the C API
• Added an asynchronous time coordinator which could be used for testing, or if all federates are driven by real time mode, or if internal synchronization is not required.
• Added alias operations to allow interfaces to have multiple names
• Added CORS access control options to the web server
• Added a HELICS_STATE_UNKNOWN as a potential return value used when the federate does not exist
• A time gate to the publications and input to restrict publications to a certain period
• Added encryption related options to vcpkg
• Tested support for Boost 1.80 and CMake 3.24
• Added a command interface to set/clear time barriers
• Added a Query to retrieve current time barriers
• Added an index group property to manipulate the internal id which could have an impact on some unusual cases of ordering and remove a potential source of randomness in the final results of a co-simulation
• Added a callback Federate capability which allows a large number of callback based federates to execute on a single core without direct user calls
• Added some additional callbacks for federates
• Added flags on the webserver to allow much easier configuration to external network interfaces
• Added read only property HELICS_PROPERTY_INT_ITERATION_COUNT to get the current iteration count for a federate

Removed

• ghc::filesystem, since all minimum compilers have support for std::filesystem available.
• Removed Travis CI related configuration and documentation
• Removed an unused and unexposed method in the Core API to retrieve the current iteration count, use HELICS_PROPERTY_INT_ITERATION_COUNT with getProperty to retrieve the same data.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 2 years ago

HELICS - v3.2.1

The Matlab interface to HELICS has been moved to matHELICS, the C++ interface now uses std::string_view in nearly all places, the translator C API and the dataBuffer API to the C interface were fleshed out a bit more and will be finalized in the 3.3 release. Subsequent releases will change the minimum compiler requirements to build HELICS to Visual Studio 2019, GCC 8.0, Clang 7, Xcode 11.0, and CMake 3.11.

Fixed

• A bug related to iterations and the wait_for_current_time flag in which a deadlock may occur if the flag were set and another federate was requesting iterations at time zero.
• A bug which could cause a deadlock if a very large number of iterations occurred
• A naming bug in the creation of globalInput objects through the C API.
• Fixed some potential race conditions in the Webserver
• Fixed some race conditions and potential segmentation faults when running the C shared library tests
• Fix some tests that were failing when executed without ZMQ support.
• Fix the symbol visibility on Linux systems to reduce the number of visible symbols in the C shared library
• Fix an issue with very long file names when used for configuration
• Fix a race condition and deadlock potential in the log buffer tests.
• Fix a Typo in HELICS_DEPRECATED use.

Changed

• Docker images were updated to be based on Ubuntu 22.04.
• All string interfaces in the C++ interface were altered to use std::string_view instead of const std::string & this corresponds with updates in some third party libraries to better take advantage of the capabilities of std::string_view. The exception to this is strings which reference file names or file contents. These have been left as std::string to match up with iostreams and other file interfaces.
• Updated the Google test version in use.
• Change the symbol visibility for mac systems to be explicitly limited to the HELICS related operations.
• Changed the signal abort code to match standard SIGINT codes
• Some enumerations used inside the CoreLibrary were updated to better match the Style Guide
• Updated the Circle-CI build tests to use more recent compilers and tweak the tests to be more appropriate to test being executed.
• Update the Units, frozen, asio, filesystem, and spdlog libraries to recent releases.
• Updated support CMake 3.23, Boost 1.79, and Visual Studio 2022.

Added

• Numerous functions in the C data API to support all HELICS supported types
• helicsFederateProtect method to all federates to be recovered by name if all references to the C HelicsFederate object was freed.
• Added a callback method for translators in the C API.
• Added a "--force" option for ZMQ brokers to allow a broker to override an existing broker for the network connection and terminate the existing broker to be replaced by a new one.
• Added additional documentation and examples for using iterations

Removed

• The HELICS_BUILD_MATLAB_INTERFACE has been removed and all HELICS support for Matlab in the future will be through the matHELICS repository.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 3 years ago

HELICS - v2.8.1

Final release in the 2.X series of HELICS. This release updates dependencies and a few minor fixes, no further bug fixes are expected.

Changed

• Upgraded Units library to 0.6.0
• update fmtlib, spdlog, asio to latest releases
• update CLI11 to latest release
• update boost support to 1.79
• update CMake supported versions to 3.23

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 3 years ago

HELICS - v3.2.0

Major new features include beta release for Translators, global time coordinator and Data API and the addition of Support for encrypted communication through the TCP and TCP SS core types.
Numerous bug fixes were included related to timing in unusual edge cases.

Fixed

• Fix some undefined behavior warnings with duplicate named federates.
• Fix a discrepancy in the way subscriptions were processed for config files to better match how they are handled for inputs.
• Fix some accidentally disabled test cases testing different network configurations.
• Fix missing dependency generation when subscribing to publications from Endpoints.
• Fixed a few sporadic failures in the test cases.
• Fixed some issues with iterations particularly in initialization mode.
• Fixed a series of edge cases in timing in unusual communication patterns and configurations mostly related to filters, and more complex iteration schemes.
• Fixed an issue related to missing source code on the release source archive.

Changed

• Docker images were updated to be based on Ubuntu 21.10.
• Update asio, json_cpp, and units to recent releases.
• Errors in the networking layer are now propagated through the logging system in HELICS for better diagnostics of networking issues.
• Benchmark tests are now built with Visual studio 2022.
• Code coverage tests are now run nightly instead of on develop PR's.
• Refactored how Apps were handling arguments to the federate to resolve some oddities in argument processing.
• Update CLI11 to use release 2.2.
• The callback for a filter to can return a message Object.

Added

• Added support for openSSL based encryption on the tcp tcpss cores and some tests using that capability.
• Added a callback option which triggers when a federate changes mode.
• Added Translators as a beta API, this is not version locked and likely has a few bugs. The API is subject to minor revisions based on user feedback.
• Added Data API to the C interface as a beta. API is subject to further revisions based on user feedback in upcoming releases until 3.3.
• Added support for command operations through the REST API on the webserver.
• Added swagger documentation for the REST API and queries.
• Added a global time coordinator(in Beta) for handling some unusual cases.
• Added additional callbacks in the application API for entry and exit from a timeRequest call.
• Added support for using external FMT and SPDLOG libraries when linking HELICS.
• Added additional documentation for complex networking environments

Deprecated

• CI tests for visual studio 2017 were deprecated. HELICS still compiles fine on Visual studio 2017. But this is the last release that is specified for. Future releases will not be tested on Visual Studio 2017. HELICS 3.3 will actively change the minimum required to Visual Studio 2019 along with other related minimum compiler updates and requirements

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 3 years ago

HELICS - v3.1.2

This patch release is primarily to address some build issues on MSYS2, MINGW, and CYGWIN platforms. It also includes some preliminary features for the 3.2 release that were already merged including time monitors, remote logging, and a log buffer.

Fixed

• Fixed issue building on CYGWIN with the latest FMT library.
• Build issues related to MSYS2 and Mingw in the networking submodule (submodule updated).
• Fixed argument processing issue in the comboFed Example.

Changed

• Updates to FMT and SPDLOG
• Several documentation updates and cleanup
• Copyright date changed to 2022
• Targeted endpoints now allow all method calls, with the restriction being that the destination must be in the target list otherwise an error is generated. An empty destination in methods that allow destinations will operate identically to calls which do not specify a destination.
• Code cleanup for defining the default port numbers for network core types.

Added

• A process comms method for federates to instruct HELICS to process messages for a specific amount of wall clock time without granting time or changing state.
• Added a threaded signal handler to deal with some particular issues with killing processes in python and potentially other language interfaces.
• Added a log buffer to brokers/cores/federates to store the latest N messages and retrieve it via a query. See log buffer for more details.
• Added a time monitor object to brokers to use a particular federate as the query time standard for brokers, this does not affect the cosimulation only the logging and queries. See time monitor for more details.
• Added a callback to be executed when the time is updated and before the value or message interface callbacks are executed.
• Added remote logging command to mirror logs from one HELICS object to another. See remote logging for more details.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 3 years ago

HELICS - v3.1.1

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.
• 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.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 3 years ago

HELICS - v3.1.0

This release includes some bug fixes and enhancements to HELICS 3 which is now the default. Major new features include the ability to add observer federates to an executing co-simulation, and the ability to specify a grant timeout which can give additional debugging information if the co-simulation is hanging for some reason. More capabilities related to this will be added in a future release. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

Fixed

• Fixed an issue with null strings lacking a null termination when retrieved from the C API. This primarily affected the Python and other language API's.
• CMake fix for some older linkers.
• A fix for ASIO aligned_alloc when used with MinGW.
• Fix to IPC core to support Boost 1.77.
• A few issues around the JsonSerialization options for backwards compatibility with HELICS 2, and add some interoperability tests that can be used to check future versions.
• Fix an issue with the timeCoordinator where a large time value was requested and with certain other configuration parameters the time could overflow and cause a deadlock.

Changed

• precommit-ci now used in the CI chain, pre-commit checks were updated, and a check for python formatting inside the docs was added.
• Update ThirdParty library versions including ASIO, CLI11, toml11, FMT, spdlog, jsoncpp, filesystem.
• Mac binaries are now universal binaries to support ARM based CPU types.
• Update some of the TCP helper classes to better support future encrypted communication efforts.

Added

• Add the ability to add observer federates which can join a federation after it has started and subscribe to values, or make queries of the federation while in progress.
• Add a configurable grant timeout which will trigger diagnostic action if a federate has been waiting sufficiently long for a time grant.
• A document on the Type conversion that HELICS can perform and a series of tests to verify the correct operation of the type conversions.
• Additional missing functions related to linking targeted endpoints from a core, so it can work similar to dataLink methods. These methods were added to Core and Broker applications.
• New benchmark based on the Barabasi-Albert network.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 3 years ago

HELICS - v2.8.0

Final Minor release in the 2.X series of HELICS. This includes profiling capabilities and a compatibility layer for future compatibility through the --json flag. There may be more bug fix releases but no major new features will be added to HELICS 2.

Changed

• Upgraded Units library to 0.5.0
• CMAKE 3.20 was tested and verified and used as the baseline version when available.
• Updated to a newer custom version of JSONCPP to support the json compatibility layer

Fixed

• The uninterruptible flag now works with iterations
• A compile issue with C++20 requiring #include <thread> in a number of files

Added

• Added json data type and flag to support interoperability between HELICS 2 and 3
• Added helicsEndpointPendingMessageCount, helicsFederatePendingMessageCount, and helicsFederateDisconnect[Async|Complete]
• Added a profiling capability

Deprecated

• helicsEndpointPendingMessages and helicsFederatePendingMessages are replaced by helicsEndpointPendingMessageCount andhelicsFederatePendingMessageCount to match HELICS 3 functions

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 3 years ago

HELICS - v3.0.1

This release includes some bug fixes and refinements to the build process for HELICS3, as well as general bug fixes and the addition of a compatibility layer making it possible for HELICS 2 federates to interact with a HELICS 3 broker if absolutely required. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

Fixed

• Timing issues using UNINTERUPTIBLE_FLAG and iterations together resulted in incorrect timing
• Some issues with the automated generation of interface files for inclusion in the repository (Java, and Matlab)
• Fixed several broken links in the documentation pages

Added

• JSON serialization method for HELICS supported data types
• JSON serialization method for HELICS actionMessage to allow some level of backwards compatibility support. The intention is that using the --json flag on a federate will allow full forward compatibility in the future. It is slower but as it is a text stream and it includes a version code, future versions can adapt.
• Profiling capability, see Profiling

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 3 years ago

HELICS - v3.0.0

HELICS 3.0 is a major update to HELICS. The major features that have been added are the command interface and targeted Endpoints. Internally major changes include updating the minimum compiler to C++17, and updates to internal libraries. The binary serialization protocol was shifted from Cereal to a custom format that embeds the data type so is more suitable to HELICS data types. The initial release is an alpha release for some initial testing. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

NOTE: The installers do not include the pre-built Java 1.8 interface; if you need the Java interface, please use swig to build it.

Changed

• Data serialization moved to a custom protocol specific to HELICS.
• Minimum build requirements to C++17.
• Minimum boost library for use is 1.67.
• Many of the API functions now use string_view instead of const std::string &
• The C shared library now comes with only a single header helics.h this should be included for all uses of the C shared library
• The name of the C based shared library changed to libhelics.dll/so
• The name of the C++ shared library changed to libhelicscpp.dll/so
• The name of the apps library changed to libhelicscpp-apps.dll/so
• The style of enumerations and structures was changed to match an updated style guide
• All HELICS specific CMake variables start with HELICS_
• The format for log messages now includes a simulation time stamp [t=xxxx]
• Log level numerical values have been expanded (multiplied by 3) to allow more gradations in log levels than was previously allowed
• The allowed set of string names has been reduced to avoid confusion and remove duplicate entries
• All queries (except global_value) return a valid json string. Errors from queries return a structure with an HTTP error code and message

Fixed

• All bug fixes included in HELICS 2.X are included in HELICS 3

Added

• Command interface
• Targeted Endpoints
• Interface Tags
• Federate and Core Tags

Removed

• Message structure from C API
• Deprecated functions from HELICS 2
• The separate headers for the C shared library are no longer installed. Instead only a single header (helics.h) is needed and includes all functions and operations.
• The cereal library is no longer installed or used with HELICS
• The C++ API no longer has generic type support through Cereal.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 4 years ago

HELICS - v3.0.0-beta.2

HELICS 3.0 is a major update to HELICS. The major features that have been added are the command interface and targeted Endpoints. Internally major changes include updating the minimum compiler to C++17, and updates to internal libraries. The binary serialization protocol was shifted from Cereal to a custom format that embeds the data type so is more suitable to HELICS data types. The initial release is an alpha release for some initial testing. The full change log will be filled out as the release progresses from alpha to beta to final release. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

NOTE For this beta, all public API's are now considered stable, baring a bug report on the API. A final release is expected in 2 weeks, Final steps include code cleanup, and testing of the different language API's. Please make any comments in the discussion page related to this release.

changes from beta.1

• addition of federate tags
• bug fixes from HELICS 2
• cleanup of doxygen comments
• update of the language API builder files
• doc fixes and updates
• update submodules

Changed

• Data serialization moved to a custom protocol specific to HELICS.
• Minimum build requirements to C++17.
• Minimum boost library for use is 1.67.
• Many of the API functions now use string_view instead of const std::string &
• The C shared library now comes with only a single header helics.h this should be included for all uses of the C shared library
• The name of the C based shared library changed to libhelics.dll/so
• The name of the C++ shared library changed to libhelicscpp.dll/so
• The name of the apps library changed to libhelicscpp-apps.dll/so
• The style of enumerations and structures was changed to match an updated style guide
• All HELICS specific CMake variables start with HELICS_
• The format for log messages now includes a simulation time stamp [t=xxxx]
• Log level numerical values have been expanded (multiplied by 3) to allow more gradations in log levels than was previously allowed
• The allowed set of string names has been reduced to avoid confusion and remove duplicate entries

Fixed

Added

• Command interface
• Targeted Endpoints
• Interface Tags
• Federate and core Tags

Removed

• Message structure from C API
• Deprecated functions from HELICS 2
• The separate headers for the C shared library are no longer installed only a single header is needed and includes all functions and operations.
• The cereal library is no longer installed or used with HELICS

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 4 years ago

HELICS - v3.0.0-beta

HELICS 3.0 is a major update to HELICS. The major features that have been added are the command interface and targeted Endpoints. Internally major changes include updating the minimum compiler to C++17, and updates to internal libraries. The binary serialization protocol was shifted from Cereal to a custom format that embeds the data type so is more suitable to HELICS data types. The initial release is an alpha release for some initial testing. The full change log will be filled out as the release progresses from lpha to beta to final release. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

NOTE For this beta, all public API's are now considered stable, baring a bug report on the API. A beta.2 is expected in 2 weeks, with a release 2 weeks later. Final steps include any submodule updates, code cleanup, and testing of the different language API's. Please make any comments in the discussion page related to this release.

Changed

• Data serialization moved to a custom protocol specific to HELICS.
• Minimum build requirements to C++17.
• Minimum boost library for use is 1.67.
• Many of the API functions now use string_view instead of const std::string &
• The C shared library now comes with only a single header helics.h this should be included for all uses of the C shared library
• The name of the C based shared library changed to libhelics.dll/so
• The name of the C++ shared library changed to libhelicscpp.dll/so
• The name of the apps library changed to libhelicscpp-apps.dll/so
• The style of enumerations and structures was changed to match an updated style guide
• All HELICS specific CMake variables start with HELICS_
• The format for log messages now includes a simulation time stamp [t=xxxx]
• Log level numerical values have been expanded (multiplied by 3) to allow more gradations in log levels than was previously allowed
• The allowed set of string names has been reduced to avoid confusion and remove duplicate entries

Fixed

Added

• Command interface
• Targeted Endpoints
• Interface Tags

Removed

• Message structure from C API
• Deprecated functions from HELICS 2
• The separate headers for the C shared library are no longer installed only a single header is needed and includes all functionsa and operations.
• The cereal library is no longer installed or used with HELICS

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 4 years ago

HELICS - v2.7.1

There were several bug fixes in this patch release. Some of them related to changes in 2.7.0 and some new ones that came up from bug reports. Some new enhancements are experimental signal handlers in the C-api, which will be used in the python interface to provide a little better user experience when trying to kill a co-simulation.

Changed

• String output on recorders is now always JSON compatible and allows escaped characters. This allows some additional values to be displayed in ascii format vs base 64 encoding. #1910
• Players read the string fields through a JSON parser unless marked with b64[] to match the string output on recorders #1910
• The default webserver port is now 8080 to allow user space execution on non-Windows platforms #1936

Fixed

• An issue with recorders writing text fields in the incorrect order which could result in incorrect playback #1910
• Fix an issue with core naming that occasionally resulted in same broker name errors when using default names on federates #1919
• Fix an issue where queries were not being resolved when a core disconnects which could result in deadlock. #1931
• The wait_for_current_time flag was not working properly in some cases where time interruption was also taking place #1933
• Fixed issue with the webserver not responding with the index page when requested or detecting the correct broker for certain trivial requests #1936

Added

• Signal handlers for catching SIGINT and optional user callback are available in the C shared API #1915
• Added support for environment variables for setting some network connection settings and other information #1921
• Queries now have timeouts #1931
• Command line and environment variable options for setting the webserver port numbers #1936

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 4 years ago

HELICS - v2.7.0

This release includes a major change internally for filters. Testing and usage revealed some scenarios which could cause deadlock or acausal message arrival. These scenarios were not common so the release was delayed until a fix was in place. As of the 2.7.0 release all the identified issues related to the initial bug have been resolved. There remains some outstanding cases that fail rarely in the CI systems specifically related to rerouting filters that are separate from both the location they are rerouting from and to. The resolution of these is uncertain but will be available in a patch release when resolved. Additional changes include major changes to the CI builds due to changing support of Travis CI and other CI services.

NOTE There are some known issues with using remote rerouting filters in the timing, which can under some conditions allow messages to be delivered after the the time the message was supposed to be delivered. Though most issues have been resolved in this release there remain a few tests in the CI build which are subject to sporadic failures that have yet to be resolved. It is expected these will be resolved in a future release hopefully 2.7.1

Changed

• Update spdlog, fmtlib, filesystem, asio, and units libraries to latest releases (#1798, #1802, #1803)
• Default HELICS_USE_ZMQ_STATIC_LIB to ON if only the static library is found in the search path #1845
• Primary CI systems are now on azure instead of travis #1819
• Only a very limited CI test set is run on formatting PR's #1761

Fixed

• Tests and fixes allowing multiple filters on the same endpoint #1852
• Fixed some failing broker server tests related to input arguments #1825
• Fixed an issue with barrier and maxTime requests #1788
• Fixed a timing bug when using offset and some specific time requests immediately after the enterExecutingMode #1759
• Several fixes and changes to CI systems related to changes in CI infrastructure #1754, #1790, #1828, #1744, #1739
• Fixed deadlock caused when querying a disconnected HELICS object #1705
• Fixed major timing bug with the use of filters #1717
• Fixed issue when sending messages before execution time #1717

Added

• Support for ZMQ 4.3.4 (this will become default in the next version) #1841
• Added a global_flush query to sweep the internal action message queues #1832
• A vcpkg manifest file for some vcpkg support #1835
• Added an event triggered flag to better handle timing on federates that are primarily or exclusively triggered by events like filters #1804
• Added ordered queries which allow queries to run on the normal vs priority pathways for queries that are desired to be synchronous with the other helics messages #1793
• Added github workflow to compress images #1626
• Additional and clearer warning messages when a message is sent to an unknown destination #1702

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 4 years ago

HELICS - v3.0.0-alpha.2

HELICS 3.0 is a major update to HELICS. The major features that have been added are the command interface and targeted Endpoints. Internally major changes include updating the minimum compiler to C++17, and updates to internal libraries. The binary serialization protocol was shifted from Cereal to a custom format that embeds the data type so is more suitable to HELICS data types. The initial release is an alpha release for some initial testing. The full change log will be filled out as the release progresses from alpha to beta to final release. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

Changes expected for beta.1 which will be the next pre-release

• matlab interface built and tested again (It is likely a new matlab API will be coming again)
• more test cases for targetedEndpoints
• docker image build working

This is an early alpha release it includes all the major new features and nearly complete API changes(baring bug reports) please use for testing and report any issues.

Changed

• Data serialization moved to a custom protocol specific to HELICS.
• Minimum build requirements to C++17
• Many of the API functions now use string_view instead of const std::string &
• Several API calls for messages have been updated for clarity and consistency.

Fixed

Added

• Command interface
• Targeted Endpoints

Removed

• Message structure from C API
• Deprecated functions from HELICS 2

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 4 years ago

HELICS - v2.6.1

Several small bug fixes and minor enhancements to query operations

Changed

• In helics_enum.h flags were separated into separate enums with the same symbols splitting up flags specific to federates, cores, and those applicable to all entities
• CMAKE 3.18 was tested and verified and used as the baseline version when available.
• Default libzmq was updated to 4.3.3

Fixed

• A few flags were unable to be queried through getOptionFlag operations #1655
• The index values for some flags were not able to be retrieved via getFlagIndex operations #1645
• In some cases specifying a custom port of a number less than the default ports led to federates being unable to bind the appropriate port #1648
• Duplicate target specification and warnings were improved #1639
• Certain property strings did not generate the correct property index #1642
• For large packets in the TCP core on particular operating systems partial buffers may be sent and this was not handled property in the tcp core #1600
• Boost 1.74 deprecated some interfaces used in the webserver. The code was updated to support the latest release of boost. #1629
• The requested_time field in the current_time query for federates was missing #1619
• Some broker queries did not reset properly when changes in the federation occurred #1617
• Handle cases of empty install prefix #1577

Added

• The C api now has a query callback method for responding to federate specific queries. #1634
• Some tutorials for the hello_world example on visual studio #1621
• A helicsMessageClear method was added to the C API for clearing the data from a message object #1622
• A global_state query to actively query the current state of all objects in a federation. #1614
• A strict config checking flag to generate errors on potentially incorrect configuration files #1607

Energy Systems - Energy System Modeling Frameworks - C++
Published by nightlark over 4 years ago

HELICS - v3.0.0-alpha.1

HELICS 3.0 is a major update to HELICS. The major features that have been added are the command interface and targeted Endpoints. Internally major changes include updating the minimum compiler to C++17, and updates to internal libraries. The binary serialization protocol was shifted from Cereal to a custom format that embeds the data type so is more suitable to HELICS data types. The initial release is an alpha release for some initial testing. The full change log will be filled out as the release progresses from alpha to beta to final release. The migrating 2 to 3 page includes some specific details on migrating from HELICS 2 to 3.

Changes expected for alpha.2

• travis-ci builds operational
• more test cases for targetedEndpoints
• octave build working
• docker image build working

This is an early alpha release it includes all the major new features and nearly complete API changes(baring bug reports) please use for testing and report any issues.

Changed

• Data serialization moved to a custom protocol specific to HELICS.
• Minimum build requirements to C++17
• Many of the API functions now use string_view instead of const std::string &

Fixed

Added

• Command interface
• Targeted Endpoints

Removed

• Message structure from C API
• Deprecated functions from HELICS 2

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 4 years ago

HELICS - v2.6.0

Bug fixes and major logging update

Changed

• The build flag function now returns correct debug or release flags depending on the build
• The debug postfix d is no longer added to the interface libraries
• Spdlog is now being used for logging inside HELICS and the old logger has been removed this results in fewer thread being generated by HELICS.
• CMake will now error if the install directory is set to the build directory
• Some argument names in the C API have been changed for consistency
• Output a more descriptive error message for mismatched data sizes when converting types #1521
• Some C++98 API functions were added and changed for consistency, specifically endpoint get type no returns a char * instead of std::string, and a getCurrentTime function was added to Federate
• logging level properties from a federateInfo structure will be inherited by a core for the first registered federate

Fixed

• String with negative numerical values were not acknowledging the negation Issue #1306
• Config file parsing was not acknowledging "unit" string #1512
• A performance issue with the tcpss and tcp cores in some cases has been resolved by setting the no_delay option
• Inconsistency in type returned by endpoint getType in C++98 API #1523
• a potential segmentation fault when calling some methods in the C shared library after calling helicsCloseLibrary

Added

• Flags for dumplog and force_logging_flush were added to the C API
• Added missing C++98 call to getCurrentTime
• Added closeLibrary function to the C++98 API
• Added a Python benchmark file
• An option to install the benchmark executables has been added
• Data logging output for both send and receive of messages
• A GitHub Actions workflow to build packages for Linux with the benchmark executables

Removed

• The previous logger including logger.h has been replaced with spdlog

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 5 years ago

HELICS - v2.5.2

Bug fix release for some build issues and a fix to the wait_for_current_time flag

Fixed

• Bug in the timing subsystem that was preventing the wait_for_current_time flag from functioning properly
• Fixed some oddities in the java tests, that were doing confusing things and happened to work because of the bug in the timing subsystem
• A build system issue that caused the automated generation of python packages to fail on the 2.5.1 release. This was caused by overriding the output build location in all cases, when it should have been limited if the python interface is getting built separately.
• A few cppcheck issue from the new check (#1414)

Added

• Add print_systeminfo flag to root helics_benchmark command (#1417)
• Added cppcheck github action for PR's

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 5 years ago

HELICS - v2.5.1

Changed

• All ZeroMQ related files are now located in the network library and under a single namespace
• Use Python 3.8 instead of 3.6 for any release build installers that include a copy of the Python interface (pip or anaconda are the recommended ways to install the Python interface)
• Update units library to include some typical natural gas units and conversions
• Use a separate action for automated pr generation
• Update the CLI11 library
• The setOption/getOption functions now take an int32_t as a value instead of a boolean. This does not change the API since in the C library the helics_bool was already an int.
• In the case of multiple sources, getInjectionType, and getInjectionUnits now will return a json string vector.
• The CMake build generation now uses a central location for all build artifacts instead of individual directories.
• Updated the ASIO library to 1-16
• Minor updates to the clang-format to allow better alignment and comment reflow
• Numerous code refactorings to simplify and clean up code
• Move all ZMQ related items to the network library
• Updated Python packages DLL load failed error to suggest installing the latest Visual C++ Runtime

Fixed

• Sporadic failures in the Webserver and websocket tests
• A bug in the translation of vectors to complex vectors
• A bug in the copying of vectors into the C shared library
• Numerous clang-tidy identified issues mostly for code readability
• Some issues with the exists query not working in certain circumstances and for cores and brokers
• The nonlings test would fail if the branch name had error in it. A check was put into eliminate this false negative test failure.
• A few sporadic failure cases in the http and websocket tests
• A build generation issue with disabling the ZMQ core
• An error from the config interpreter where some flags were not getting correctly propagated to the Federate configuration.

Added

• A helics::zmq target was added for linking with zeromq if using HELICS as a subproject
• A HELICS_BENCHMARK_SHIFT_FACTOR CMake option was added to allow the benchmarks to scale depending on computational resources
• "version" and "version_all" queries to get the local version string and the version strings of all the cores/brokers in the federation
• A few missing operations to the C++98 interface for Message objects, add helicsMessageClone and helicsEndpointCreateMessage functions in the C interface. Add a test case for some of the C++98 message operations.
• helicsQuerySetTarget and helicsQuerySetQueryString operations to modify an existing query in the C interface
• A set of reduction operations for multi-input handling on inputs, options for setting input source priority and the number of expected connections
• A Watts-Strogatz like benchmark
• A few more parameters that can be handled in the Webserver and support for use of uuid instead of name
• A few missing message operators to the C++98 API, such as data, append, setFlag, checkFlag, sendMessageZeroCopy
• Made the Message class return a self Reference for the setters
• A test to run the helics-broker executable as part of the CI tests
• A bug in the helics_broker that no longer ran correct defaults
• A "version_all" query, to retrieve the version of HELICS in use for all cores/brokers, and a "version" query to retrieve the version of a specific target.
• A series of checks for markdown, spelling, shellcheck, python formatting, cpplint, end-of-line and automated generation of PR scripts for the formatting updates.
• Some level of automated scaling for benchmarks for small systems
• API functions for retrieving the build flags used to generate the library
• Some additional message interpreters to aid in debugging
• A test using the standalone helics_broker to run an example

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 5 years ago

HELICS - v2.5.0

Some library reorganization, additional static analysis(CppLint and clang-tidy), multiBroker, updates to the webserver including some new capabilities for creating and destroying brokers.

Note: the helics_broker has a bug when using the implicit default core type; as a temporary workaround either run it with the --coretype argument or use the helics_app broker subcommand.

Changed

• Split the HELICS core library into a separate core and network library
• Update FMT library to version 6.2.0
• The core and broker Factories use a map instead of a fixed list which is a step toward allowing user defined cores
• Updated CLI11 included code to customized version to allow configuration of cores and brokers through Json files
• The ordering of the helics_error_types enum is in ascending order
• Refactored the Matlab and Java swig interface builds to enable standalone builds

Fixed

• Added CPPlint and fixed a number of issues that check identified.

Added

• helicsEndpointSendMessageObjectZeroCopy to allow transferring messages with minimal copying.
• helics<Interface>IsValid functions to the C API
• helicscpp::cleanHelicsLibrary to the C++98 API.
• A Comm factory to the Core to enable constructing Comm interfaces directly from the type.
• The REST API in the webserver was updated to include ability to create and destroy brokers.
• A websocket server similar to the REST API but will respond to JSON queries.
• A test suite for the HTTP and websocket servers.
• A Multibroker that can allow multiple communication types to interact together.
• Support for HELICS_BUILD_CONFIGURATION cmake variable for building on unique platforms. The only supported one right now is "PI" for building on raspberry pi platforms.

Deprecated

• in the C shared library helicsFederateGetMessage, helicsEndpointGetMessage, and helicsEndpointSendMessage are deprecated in favor of the object version These will be removed in HELICS 3.0
• deprecated helicsEndpointClearMessage this function does nothing right now, all messages are on a federate level.
• Deprecated error functions in the C++ Federate API in favor of localError and globalError.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 5 years ago

HELICS - v2.4.2

Increased code coverage and additional bug fixes.

On March 31, 2020 support for installing HELICS using the Spack develop branch was added

Changed

• Update toml11 library to 3.3.1 with some warning fixes for C++17
• The query handling in the core library was cleaned up to be more extensible and uniform

Fixed

• MacOS build with python 2.7 failure
• Fixed some issues with the build/test process if the ENABLE_ZMQ_CORE=OFF
• Fixed a potential issue with queries if they are triggered before the connection ack
• An issue with host name resolution on some systems with restricted DNS lookup
• Allow camelCase in file parameters from JSON
• Fixed linking error with default OpenMPI Spack package
• Fixed timing benchmark federate name

Added

• A series of tests for MessageFederate.cpp to increase coverage on that file to 100%
• Callbacks for custom filters in the C shared library
• A series of tests for CoreApp, BrokerApp, and FederateInfo and a few fixes for them
• A few additional tests of helics supports types and conversions
• CoreApp has a connect() and reset() method and constructor from a Core shared pointer
• BrokerApp has a connect() method and constructor from a Broker shared pointer
• Added a data_flow_graph query which gets all the connections in a federation

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 5 years ago

HELICS - v2.4.1

Increased code coverage and additional bug fixes. The error propagation in HELICS was improved such that local errors can be escalated to global errors, and a federate can define errors coming from the federate that are handled appropriately and can halt a co-simulation.

Note for macOS users there is a bug that will be fixed in the next release that prevents building the Python interface with SWIG -- this mostly impacts the small number of users on Python 2.7.

Changed

• The helics webserver will build by default if the conditions are met
• Update filesystem library to v1.3.0
• The behavior of the Federate*Complete operations is slightly modified to be uniform and consistent, no API changes
• Configuration of flags and targets for interfaces in JSON and TOML files can be done in multiple sections
• The benchmark federates have been changed to use a common base benchmark federate class for more consistent behavior
• Switched to including netif as a git submodule
• the error Function in the C++ API is now the same as localError previously it was primary useful for logging and didn't do much, and will be deprecated in the next minor release.
• Updated the GitHub actions (clang-format, swig interface updates, and release builds) to use actions/checkout@v2
• Cleaned up the Windows installer (better component names/descriptions and groups, link to Gitter, and require installing Headers to install SWIG)
• Updated the HELICS apps manpages with new options

Fixed

• Issue with iterative requests that were not being honored if the federate was acting in isolation
• A few pathways which would allow segmentation faults if a federate was disconnected and particular functions were called
• ValueFederate addIndexedTargets, the function template would not work as was written and was unusable, it is now tested and operational.

Added

• HELICS_DISABLE_WEBSERVER option to turn off building of the webserver. It will build by default if Boost is enabled and is version 1.70 or higher; otherwise it is disabled.
• A series of tests for Federate.cpp to increase coverage on that file to 100%
• A series of tests for ValueFederate.*pp to increase coverage on that file to 100%
• Docker image for a helics builder which includes build tools and the helics installation
• helics can be installed on MSYS2 using pacman.
• Standalone benchmark federates for use in multinode benchmark runs
• A FreeBSD 12.1 CI build using Cirrus CI
• Sending an event from GitHub Actions release builds to trigger updating additional HELICS packages when a new release is made
• localError, and GlobalError function calls the Federate API and in the C++ and sharedLibrary.
• helics_terminate_on_error flag to escalate what would be a local error into a global one that will halt the co-simulation. This flag can be specified through the flag to federates or to brokers and cores through a command line option --terminate_on_error
• addDependency function was added to the C++ Federate API and shared library API, it can add a direct dependency between federates manually.
• A 32-bit Windows zip install archive for releases
• "global_time", "current_time", and "state" queries for brokers and cores, and "current_time" query for federates.
• Support for a 'helics-release-build' event trigger to the release build GitHub Actions workflow

Deprecated

Removed

• HELICS_ENABLE_WEBSERVER option to enable the webserver. This option was added as experimental in 2.4.0
• VS2015 Windows Server 2012 CI build is removed. Azure Pipelines is removing the image because it is outdated and sees little use. VS2015 is still tested through Appveyor for the time being.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 5 years ago

HELICS - v2.4.0

Important note for macOS 10.15 Catalina users: Apple made running unsigned apps more strict, downloading and running the helics binaries in the macOS package will get blocked. A workaround is to download the package using curl in Terminal instead. e.g. curl -LO https://github.com/GMLC-TDC/HELICS/releases/download/v2.4.0/Helics-2.4.0-macOS-x86_64.zip.

A few bug fixes, code coverage on the shared library increased to 100%, library updates, Broker server enhancements including an http REST API, and a lot of work on the build systems to enable easier releases and packaging.

Changed

• filesystem include updated to 1.2.10
• CLI11 updated to 1.9
• fmt updated to 6.1.2
• variant header updated to latest release
• Update the units library (v0.3.0)
• The TOML interpreter used in HELICS was changed to toml11
• Some unnecessary files were removed from the all source package
• some internal CMake options and messages were not using new format for message
• Major updates to the python modules build system including merging the python3 and python 2 builds into the same CMake generator
• CMake cleanup and formatting
• A series of changes to the build for more widely supported installations on Linux and MacOS
• The .clang-format file was modified slightly and the entire code base reformatted to the new specification
• the metadata information for the benchmarks was updated
• The FilterOperator class was altered to include a vector output for use with cloning
• TCP and UDP core types are not by default backwards compatible with <2.4 brokers. The flag "--noack_connect" will need to be passed as part of the coreinitialization string to allow this to work if need be. ZMQ_SS cores are not considered interoperable with <2.4 brokers due to a number of bugs. In a few select cases it might still work.

Fixed

• macOS rpath information on the built binaries
• Some issues with swig include directories to allow it to work in other circumstances
• an issue with building the java interface in MSYS2
• an issue with the HELICS_USE_NEW_PYTHON_FIND CMake option
• Some thread sanitizer identified issues
• A series of issues from static analyzers
• an issue in the shared library create core that could emit an exception
• A series of issues related to remote cloning filters not being inline
• Several issues with the zmqss core type it is not backwards compatible with <2.4 brokers
• The code coverage on the C shared library was increased to 100% and a number of small bugs fixed as a result. The overall coverage increased to 71.5%

Added

• Several installers for Linux and Mac and builds for pip install
• Allow standalone builds for the python interface
• Added a Ring Message benchmark, like the ring Benchmark except using messages as the token
• Added a Multinode phold benchmark
• Added a c shared library echo benchmark
• git logic to check if the submodules are at the correct version
• an option for a githook to check the formatting
• git warning if the submodule versions are not at the correct version
• a timing benchmark similar to the echo benchmark
• a number of tests for the C shared library including evil tests for testing bad input
• Hooks to test the coverage builds
• a feature to mark a broker or federate as slow responding so it doesn't time out automatically
• EditorConfig and .gitattributes for cleaner diff and automatic editor configuration
• An incorrect call in the Matlab swig code was fixed
• Automatic generation of pull requests for source code formatting
• Add metadata information to the benchmarks for automatic processing
• Broker server functionality for tcp core, zmqss core, and udp core
• An experimental web server that can be used with the broker server or the broker executables. (requires boost 1.70+ to build)
• man pages for the helics applications

Deprecated

• The ZMQ_SS core type is not generally compatible between 2.3 and 2.4 Minor releases due to bug fixes.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 5 years ago

HELICS - v2.3.1

Bug Fixes and some code refactoring, pkg-config files have been added to the installs

Changed

• Default installation path for MSYS2 is now configured to be part of the system path, typically /mingw64/ or /mingw32/
• HELICS_ENABLE_SLOW_PACKAGING_TESTS renamed to HELICS_ENABLE_SUBPROJECT_TESTS to better reflect usage
• filesystem library updated to clear up some warnings
• The CI system now runs Xcode9 as the oldest release
• Automatic releases build system was changed to use scripts

Fixed

• Some documentation links in the docs
• Missing helics-enums.h header from the install if HELICS_BUILD_CXX_SHARED_LIB was not enabled
• ZMQ install locations on Linux and macOS if ZMQ is used as a subproject without the HELICS_USE_ZMQ_STATIC_LIB option enabled
• The linux shared library release build so it is compatible with a larger number of systems including older ones back to glibc 2.12.
• Fix some documentation and issues with using the STATIC_STANDARD_LIB CMake option

Added

• CMake option for HELICS_DISABLE_ASIO to completely remove the use the ASIO library, turns off the UDP, and TCP core types, all real-time capabilities, and timeout and heartbeat detection for cores and brokers. ASIO doesn't support all version of cygwin.
• pkg-config files for the shared libraries are now installed to <prefix>/lib/pkg-config on unix like systems
• Tests and CI builds for installed CMake package files and pkg-config files

Deprecated

• Trying to install on linux/macos systems with cmake older than 3.13 and ZMQ used as a subproject with the shared library is no longer supported. It is likely this use scenario was broken before, now it produces a warning.

Removed

• If HELICS_BUILD_BENCHMARKS is enabled, the option for ENABLE_INPROC_CORE will not show in the cmake-gui.
• If HELICS_BUILD_TESTS is enabled, the option for ENABLE_TEST_CORE will not show in the cmake-gui.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 5 years ago

HELICS - v2.3.0

Minor release with lots of CMake updates and build changes and a few fixes and additions. The biggest change is in the C++ shared library and complete removal of boost::test.

Changed

• Converted the shared_library_tests and application_api tests to use Google test instead of Boost test
• Most HELICS CMake options have changed to HELICS_**, with the exception of BUILD_XXX_INTERFACE, and ENABLE_XXX_CORE. These options will not change until HELICS 3.0, at which point all HELICS related CMake options that are not standard CMake options will have a leading HELICS_
• The version string printed by HELICS will include git hash codes and base version information for non-release builds
• Some attempts were made to further modernize the usage in CMake. This effort ended up fixing a few bugs in certain conditions and simplifying things, and the CMake code was also run through a formatter
• The exported C++ shared library has been heavily modified to only include functions in the public API, and is now the recommended way to link with HELICS directly in a C++ program. A HELICS::helics-shared target is now available for linking through CMake. If libraries were previously linking with the installed static library this is a BREAKING Change. Those previously linking with the C++ shared library may also need modifications. Changes include:
  • The coreFactory and brokerFactory headers are deprecated as part of the public headers, they are still used internally but should not be used by linking libraries. The public version will remain stable but show deprecated messages. The internal version used by the core will likely be modified in the future.
  • New headers for CoreApp and BrokerApp can be used to provide nearly all the same capabilities in the application API.
  • New headers typeOperations.hpp and timeOperations.hpp were added to the application_api to provide string operations for the time and core types. In the shared-library core-time, and core-type headers included these headers but that will be deprecated in the future.
  • CMake options for building utilities/units/json as object libraries have been removed as they were no longer needed.
  • The cereal library is moved to the external folder in the helics directory and is now required to be available for the C++ shared library, so a CMake variable making it optional was removed.
  • The reason for this change was partly as a stepping stone for other internal library changes, and to simplify the build complexity and allow more flexibility in linking libraries without impacting the installed interfaces. The previous methods and installed libraries were coming into conflict with other packages and posing increasing challenges in maintenance and linking. This change forced more separation in the HELICS layers, and the installed libraries and simplified a lot of the build generation scripts.
• CLI11, utilities, filesystem and units libraries were updated with latest revisions.

Fixed

• Race condition when removing subscriptions or targets from an interface
• Fixed mistakenly excluded tests and the resulting failures in the CI builds
• Some of the interface functions (Python, Java, etc) were generating incorrect code for getting raw data from inputs.
• The language API's were not handling Ctrl-C user disconnects well, so some fixes were added to handle that situation better.

Added

• A set of included HELICS benchmarks using the Google benchmark library.
  • echo benchmark
  • echo message benchmark
  • ring benchmark
  • PHOLD benchmarks for single machine
  • message size and count benchmark
  • filter benchmark based on echo message benchmark
  • actionMessage benchmarks
  • data conversion benchmarks
• The src, test, benchmarks directory can now be used as a root directory for CMake to do the appropriate build with few options.
• Dedicated internal functions for conversion of bool operators, strings such as "off", "false", "disabled", "inactive" are now supported as valid bool values that can be passed.
• Shared libraries for the C++ Application api and apps library are built and installed containing only public API functions and classes. potential breaking change as the CMake library names have changed and the C++ shared library is modified
• Tests executing and linking with the shared libraries
• Example linking with the shared libraries
• a build_flags_target is exported with flags that may effect compilation
• a compile_flags_target is exported, mostly for seeing which non-abi related flags HELICS was built with.
• a helicsXXXMakeConnections function which takes a file to establish linkages for Core and Broker to the C shared API.
• Automated generation of interface code for Python, Matlab, and Java interfaces and automatic PR's with the changes
• Overloads of federate creation functions in C++ for CoreApp
• Overloads of filter creation function in C++ to use CoreApp
• Docstrings were added using swig -doxygen to Python, Python2 and Java interfaces
• Add "queries" query to core, federate, and broker which gets a list of available queries
• Add "isconnected", "filters", "inputs" query to core to retrieve list of available filters and inputs, and if the core is connected.
• Added an INPROC core type, which replaces the TEST core for most user uses, the TEST core does the same thing but has additional functionality to mock network issues for testing, more of these capabilities will be added. The INPROC core will remain simplified and as fast as possible for in process federations.
• Windows CI builds for visual studio 2019, 2017, 2015 on Azure, reduced workload on Appveyor.
• Automatic release file generation for a shared library package on macOS and Linux, and a more complete macOS installation archive. Supported versions are macOS Catalina 10.15 and Ubuntu 18.04, though the macOS binaries might work as far back as 10.11 and the Linux binary should work for older versions and different distributions.

Deprecated

• Use of coreFactory and brokerFactory when using the C++ shared library (use CoreApp and BrokerApp instead)
• coreType and helics-time string conversion functions are no longer defined in the helics-time header. They are still there currently but are deprecated and will be removed in HELICS 3.0
  use the typeOperations.hpp and timeOperations.hpp header instead which now defines those functions.

Removed

• All tests using boost::test have now been replaced with Google test, so references and linking to boost::test has been removed
• Exporting and installing the static libraries has been removed (they can still be used by using HELICS as a CMake subproject)
• CMake option to exclude static libs from the install has been removed as no longer needed
• CMake options for building JSONCPP, Utilities, and units libraries as object libraries have been removed as object libraries are no longer being used
• JSONCPP, Utilities, and units libraries are no longer installed in any form, libraries or headers.
• CMake option to install CEREAL headers (they are now required, but are in a different location)

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 5 years ago

HELICS - v2.2.2

[2.2.2] ~ 2019-10-27

Bug fix release for a timeout regression from 2.2.1,

Fixed

• Links in the README changed with an automated move to travis-ci.com
• Fix issue #853, which was causing core connections to timeout if no direct communication was observed for a period of time. This bug fix release fixes that issue where the pings were not being correctly accounted for in the timeout detection.
• Fix Ctrl-C issue when using HELICS in some language api's (Python and Julia) others may be added in 2.3

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 5 years ago

HELICS - v2.2.1

Minor release with bug fixes and a few additional features

Changed

• helics apps tests is converted to use Google test and is now being run through the sanitizers
• BREAKING CHANGE The C interface helics logging callback specifications now include a user data object. This is technically a breaking change, but there were a few issues with the current implementation so it is not entirely clear it was usable as it was. There are now some tests for the functionality. This log callback specification was not available in the language API's and the C++ API has not changed, only the C interface to specifying direct logging callbacks. This is considered a minor change due to no known users of this interface at present and as it was it wasn't entirely operational. No further changes are expected.
• The use of Boost C++ in the helics core and application api are now limited to the IPC core(there are no plans to remove this usage) and an option to DISABLE_BOOST is available in the CMAKE files. This will turn off the IPC_CORE and any optional uses of boost in some of the libraries. Future features may use Boost but should retain the ability to disable its use.
• BREAKING CHANGE Some function names in the C++98 API were changed to better match the C++ API and were documented more completely through doxygen, these were listed as potentially changing in the Public API so this is not a consideration for semantic versioning. The C++98 API also has limited numbers of users at this point yet and may not be fully stable until HELICS 3.0 release
• The doxygen cmake project was renamed from doc to helics_doxygen
• several variables used by submodules in cmake were hidden
• updated zmq subproject version to 4.3.2

Fixed

• There was a 32 bit issue when using certain vector operation functions in HELICS when compiled with 32 bit, this was preventing the arm 32 from running the tests fully. This issue has been fixed.
• Fixed a race condition related to queries of subscriptions and inputs of a federate if done remotely. The core could lock or a race condition could occur.
• some issues related to file logs
• started to address some recommendations for include-what-you-use
• The cmake conditions for building the C# interface and Python2 interface were not completely correct and incorrectly showed an error which was also incorrectly ignored, so it all worked unless there was an actual error, but those issues have been resolved.

Added

• logMessage functions in the federate for user specified log messages and levels
  • logDebugMessage, logWarningMessage, logErrorMessage, logInfoMessage function in all API's to simplify common logging operations
• function to set the log file from the core C++ API
• A CMAKE option to disable BOOST entirely DISABLE_BOOST
• A CMAKE option HELICS_BINARY_ONLY_INSTALL which will restrict the install to executables and shared libraries with no headers or static libraries.
• Some CMAKE capabilities to better generate the interface files.
• Timeouts on the broker for broker connections, more work is likely needed in the future but for now if a path times out, if things were already disconnecting it assumes it is the equivalent of a disconnect, and if not the federation errors and terminates.
• Automatic release file generation for visual studio builds, windows installers, full source code tar files, and a shared library package.

Removed

• The included build files for the Octave interface have been removed. It is now required to use swig to build these files. The interface file was only valid for Octave 4.2 and had potential to break in later versions. Given the 3 versions of octave in common use it was deemed prudent to just remove the included file and require swig to generate the correct interface, this may be added back in the next release if more testing shows this to not be an issue.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 5 years ago

HELICS - v2.2.0

Minor release with some updates to the networking portion of HELICS and some API additions.

Changed

• Submodule updates for filesystem, libfmt, and google test
• A utilities lib containing many string processing and small functions is now used instead of directly including it.

Fixed

• A error response to a core registration will immediately generate an error on federates waiting for registration instead of waiting for a timeout
• HELICS can now compile with standalone mingw and cygwin 32 bit on Windows. ASIO is not compatible with Cygwin 64 bit so no support for that is expected in the near future. Tests in travis exercise the MinGW build.
• Some issues with the ZMQ core generating an error on close due to incorrect builds of ZMQ in some installations.
• Some changes to the network interface selection process that cause issues on certain platforms.

Added

• The ability to specify a broker key for brokers and cores to limit linking to those cores with the appropriate key
• A units library into HELICS, mismatched units are checked and units published as a double with units on the publication and subscription converted internally
• A new API for messages in the C interface. The old interface has difficulties when working with binary data in the message structure. So a message object API was created with appropriate methods to access the data. The previous message API will be deprecated in release 2.3 and removed in 3.0.
• A clone app for cloning an existing federate including all publications and subscriptions and all data that is being sent out. It is accessible through the helics_app clone subcommand
• CI tests using docker for clang sanitizers and the octave interface.
• Scripts for generating a single zip file with all the code including submodules. This will be generated for each new release.
• A broker server that generate multiple brokers on a single system and handles the port allocation intelligently. (Only ZMQ currently supported, this is not backwards compatible, though regular 2.2 brokers should work with 2.1 federates if needed.)
• A Docker image containing the HELICS apps (available on Docker Hub for tagged releases and the latest develop branch at https://hub.docker.com/r/helics/helics)

Removed

• ENABLE_SWIG option in cmake as always ON. This option will only appear for interfaces that have existing build files. For swig generated interfaces that do not have prebuilt files (octave, python2, and C#) this option will no longer appear as swig is required.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 5 years ago

HELICS - Release 2.1.1

Minor release which fixes a few bugs and add some JSON related input and queries

Changed

• moved concurrency related structures to a standalone library
• System-tests is now based on google test instead of boost test
• Shared_libary_cpp tests now based on google_test instead of boost test
• the deserializer for ActionMessage now uses memcpy to avoid possible undefined behavior
• The value of helics_time_maxtime has been changed for consistency with the C++ equivalent
• The return type of the helicsCLI11App is now named parse_output instead of parse_return
• fmt and googletest were updated to latest version

Fixed

• a few possible race conditions found by thread-sanitizer
• cleared up a couple scenarios that were triggering occasional test failure in the system tests
• helics_broker and helics_app were returning non-zero return values when --version or --help were used, they now return 0 in those cases
• a small memory leak when a JSON stream builder was created and not destroyed properly
• an inconsistency between the helics_time_maxtime in the C shared library and the maxTime value used in C++, this could in some cases result in failing termination conditions

Added

• queries for getting all current inputs in JSON format.
• query for getting all updated inputs in JSON format
• publication function that accepts a JSON structure for multiple publications
• registration function that generates publications based on same JSON structure as the function that accepts JSON for group publication
• function on the inputs to clear the updates, is used from a query
• a const version of the isUpdated function call on inputs
• Shared OBJECT (SO) versions to the shared libraries

Removed

• libguarded and several concurrency related structures as they are now in a standalone repository that is included through submodules

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 6 years ago

HELICS - HELICS 2.1

The main focus of this minor release is cleaning up the build system and extracting required compiled libraries from the HELICS build process, no changes in the C API, and a few additions and deprecations in the C++ API related to command line arguments.

Changed

• remove use of boost::program options and replace usage with CLI11
• remove boost::asio and replace with a submodule for ASIO
• remove included fmt code and replace with submodule
• remove JsonCpp code and replace with a submodule which generates a compiled library - this removed the need to continually regenerate the single header/file with customized namespaces, though if you are using the helics-static library built with a separate JsonCpp static library, the HELICS copy of the jsoncpp static library must be linked with manually (for build systems other than CMake such as waf, meson, premake, etc). Also included is an option to incorporate JsonCpp as an object library within a single helics-static library (default on macOS/Linux), and create a target HELICS::jsoncpp_headers.
• extract several containers used in HELICS to a separate repository for better maintenance and possible reuse elsewhere. Any reference to the containers library was removed from the Public API.
• all required references to boost were removed from the public API.
• the logger headers were split into two sections. The logger.h which includes the logger objects for use in federates was split from the loggerCore which is not publicly accessible.
• The command line arguments are error checked and the help prints all available options (thanks to CLI11)
• the core tests and common tests now use google test instead of boost test. More tests are expected to be migrated in the future.
• updates to the HELICSConfig.cmake file that gets installed to be more resilient to different directory structures.
• use ZMQ as a subproject if needed instead of an autobuild and install it as a target if needed. The CMake option to enable this is ZMQ_LOCAL_BUILD, replacing AUTOBUILD_ZMQ.
• the cereal library is not installed by default except on visual studio, and there is a CMAKE option to install it HELICS_INSTALL_CEREAL
• some updates to the noexcept policy on c++98 interface

Fixed

• an issue with the isUpdated function not registering access (mainly an issue in the C and language interfaces), Issue #655
• certain flags when used with certain brokers could cause errors, Issue #634
• potential issue with only_update_on_change_flag when used at the federate level, along with some tests

Added

• the HELICS library can now operate as a subproject in a larger cmake project if needed
• tcp cores have a --reuse-address flag to allow multiple brokers on the same port, mostly useful for the test suite to prevent spurious failures due to the OS not releasing tcp ports in a timely manner.
• several C++ api functions for using a vector of strings as command line arguments, in the federates and in the broker/core factory, this is related to the transition to CLI11
• tests for building HELICS with musl instead of glibc
• tests for building HELICS on ARM/ARM64

Removed

• tested support of XCode 6.4 and 7.3; these probably still work but we are not testing them anymore.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp almost 6 years ago

HELICS - v2.0.0

This is a major revision so this changelog will not capture all the changes that have been made in detail. Some highlights:

• major revision to the API including
  • use of an error object in the C api function instead of a return code.
  • better match the C++ api in terms of function names and layers.
  • The C++ api now uses objects for the interfaces instead of identification ids.
• Filters can have multiple Targets
• Define an input object which can be addressed from outside the federate
• add a ZMQ_SS core type useful for large numbers of federates on a single machine.
• add a TCP_SS socket for firewall usage though it may be applicable in other situations
• numerous bug fixes and internal refactorings.
• add target functions to the interface objects to add and remove targets
• functions to allow cores and brokers to add links between federates
• an octave interface
• an early version of the C# interface.
• an ability to set a global value (as a string) that can be queried.
• a local info field for all the interfaces for user defined string data.
• many other small changes.
• License file changed to match BSD-3-clause exactly(terms are the same but the file had some extra disclaimers in it, now it matches the standard BSD-3-clause license)

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak about 6 years ago

HELICS - HELICS 2.0 rc1

The 2.0 API is stable and should not change.
Some documentation updates are expected and if there are any bugs they will be fixed but the final 2.0 is expected soon.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 6 years ago

HELICS - HELICS 2.0 Beta.3

Final beta release. The API's should be stable. Remaining changes will be bug fixes and documentation updates.
Changes from beta.2 include a second zmq core type for high federate count systems,. Modified function calls to get and set the default destination for endpoints and incorporation of upsteam changes from third party libraries,. As well as numerous bug fixes and tests.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 6 years ago

HELICS - HELICS 2.0 Beta.2

Second Beta release for 2.0.0

options for interfaces
Several bug fixes and some performance improvements.
Some flags have changed
There is an info field that can be set for each interface object
The finalize call is now blocking

Interfaces can now be closed during a simulation

Global values can be created and queried

Several new test cases to test new features and capabilities.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 6 years ago

HELICS - HELICS 2.0 Beta.1

This is a beta release of the HELICS 2.0 API. There are numerous changes to the API based on feedback from the alpha releases and 1.X releases.

The major changes between the Alpha and Beta release are:

• registerXXX functions in the application API now return object references instead of id codes.
• Also several functions were then removed from the federate API since they are available in the object API's
• The #define's in the API were also removed in favor of enumerations.
• An octave interface is now available
• a preliminary C# interface is available
• Java, Matlab, and Python interfaces are fully operational and tested
• a single socket TCP core is now available
• all interfaces have an info field that can be used to store a string for user purposes
• Brokers and cores can accept a file to make connections

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 6 years ago

HELICS - v1.3.1

Fixed

• some race conditions in a few test cases and in user disconnection calls for brokers
• certain types of federates would occasionally hang during off nominal shutdown call sequences. Fixing this led to a substantial rewrite of the tcp comms

Added

• federate, broker, and core destroy functions to the C api
• tcp cores have a --reuse-address flag to allow multiple brokers on the same port, mostly useful for the test suite to prevent spurious failures due to the OS not releasing tcp ports in a timely manner.

Changed

• wait for Broker now uses a condition variable instead of sleep and checking repeatedly
• changed the logging levels to be error, warning, summary, connections, interfaces, timing, data, and trace to better match debugging levels used in development and make the purpose of each level clearer
• comm objects now can use the same logging system as the rest of HELICS

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak over 6 years ago

HELICS - 2.0.0 alpha release 2

This is the second alpha release for HELICS 2.0. All C/C++ based tests are passing. So for those operations it has equivalent capabilities as the 1.X releases. The language bindings are not operational yet, with the MATLAB interface being farthest along. The target for the beta.1 release will be making sure all the language bindings work and compile. This release also includes several updates to the API's as learned from the previous release.

The target date for the beta.1 release is October 1.
Development work throughout the Beta release process will be to verify operations of the novel capabilities in HELICS 2.0 and add the remaining new planned capabilities.

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 6 years ago

HELICS - RFC for 2.0.0 api

This release is for comment on the updated API's for the 2.0.0 release. Specifically on the C and C++ code.
Not all tests are passing, and none of the language API's are updated.
No binaries are provided for this release as it is not operationally ready.

Current schedule plan is to make sure most tests are passing, and address any comments for an alpha.2 release in a couple week.
Beta.1 Sept 30
Beta.X Mid-October
2.0.0 final late October

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp over 6 years ago

HELICS - v1.3.0

Changed

• some CMake options have been removed (BUILD_BROKER)
• major changes to the build of the CTest testing Framework
• moved most examples to new HELICS-Examples Repo

Fixed

• potential segmentation fault in C shared library when calling free with invalid object.
• autobuild recognizes build configuration

Added

• working octave interface for Linux
• some additional tests for the shared library
• TOML readers for interface description in Federates
• interactive command line for helics_broker
• a few new queries on brokers see Queries
• CPACK can now build a dmg files
• Players can have multiline comments in input file and omit the tag for repeated messages
• marker option on player, recorder, tracer to print time advancement message

Changed

• added better code for allowing static runtime builds
• use the cmake version numbers instead of independent variables
• Environment variables are recognized in CMAKE find options
• split API tests from system wide tests
• added options on MSVC to build with embedded system libraries and embedded debug info.

Removed

• Most examples are now located in HELICS-Examples

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak almost 7 years ago

HELICS - v1.2.1

Fixed

• bug in the conversion of named points from strings
• matlab helicsSubscriptionGetVector function was producing a seg fault, now this is fixed
• performance issue in the delay buffers of federateState
• findMPI for MPI libraries with multiple libraries
• federates will now error on missing required publications

Added

• first cut of matlab interface tests
• some additional Java test cases
• Python test cases for named point and bool tests
• Matlab helper scripts for loading the libary
• String length function for subscriptions

Changed

• conversion of doubles into the internal time base now rounds to the nearest ns instead of truncating
• unify cmake scripts to use lower case commands

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak almost 7 years ago

HELICS - v1.2.0

Fixed

• issue with various filter tyes and random drop filters
• a few minor issues with C api (helicsFederateSetMaxIterations)
• potential threading issues when updating the logger on an executing federate
• federates will now propagate errors properly for duplicate publications and endpoints
• federates will now error on missing required publications

Changed

• implement use of fmt library instead of boost::format
• improved python installation scripts
• general threading and refactoring of the core
• automatic name generation no longer uses random uuid's, but a shorter 20 character random string

Added

• queryCoreExecute, queryBrokerExecute to the C api to allow queries to be executed directly on brokers and cores
• C++ API changes to Brokers and Core's to allow queries directly
• new queries (federate_map, and dependency_graph(partial))
• additional filter tests and query tests
• realtime mode for HELICS specified by activating the realtime flag, and specifying rt_lag and rt_lead the federate will then delay grant or force_grant based on computer clock to match wall time.

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak almost 7 years ago

HELICS - v1.1.1

Added

• BrokerApp as a slightly more convenient runner to Brokers
• getXXSize functions directly in the Subscription object instead of a roundabout call in the C api
• more complete error catching for the C library
• added helics-config executable for getting paths and links and used flags

Changed

• upgrade autobuild ZMQ version to 4.2.5 and change CMake scripts to use zmq target
• updated HELICSConfig.cmake install file to link properly to external libraries and find them if necessary, also included some find functions. The find_package(HELICS) should work properly now
• changed boost inclusion to use targets instead of files directly
• changed MPI inclusion to work better on windows and use targets instead of direct links
• update cereal library with latest bug fixes
• update jsoncpp with latest version
• update cppzmq with the latest version
• moved helics_broker executable code to the apps repository
• the CXX shared library can now be built alongside the C shared library and can be built on Windows.

Fixed

• compilation issue with Xcode 8.0
• inconsistent numerical conversion from vectors to doubles in subscriptions

Removed

• installation of HELICSImport.cmake this is now redundant with updated HELICSConfig.cmake

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak almost 7 years ago

HELICS - v1.1.0

Added

• namedpoint functions in the C++ for publications and subscriptions, and corresponding functions in the C interface and language API's
• boolean publication and subscription for C++ interface, and corresponding functions in the C interface and language API's
• new options for brokers, --local, --ipv4, --ipv6, --all, are shortcuts for specifying external network interfaces
• additional documentation, CONTRIBUTORS, ROADMAP, CONTRIBUTIONS, and some other other documentation improvements

Changed

• the default interface configuration for federates and brokers. The --interface option is less important as interfaces should mostly get automatically determined by the broker address
• minor configuration changes to cmake to be more conforming with modern cmake best practices
• cleaned up header installation for app directory
• shared libary construction now uses some headers generated by cmake

Fixed

• better error checking in the C interface
• fixes for occasionally failing tests

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak about 7 years ago

HELICS - v1.0.3

This is a minor bug fix release, see the changeLog for more details

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 7 years ago

HELICS - v1.0.2

Fixes more timing issues, adds support for Python2

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak about 7 years ago

HELICS - v1.0.1

Bug Fix update and compatibility with Boost 1.67
see changelog for more details

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 7 years ago

HELICS - v1.0.0

This release covers improved interfaces for Python, MATLAB and Java, and several new examples. This release also adds better testing coverage, several helper apps and numerous bug fixes.

Energy Systems - Energy System Modeling Frameworks - C++
Published by kdheepak about 7 years ago

HELICS - v1.0.0-beta.2

This release increases the test coverage and improves the installers and interfaces including Java, Matlab, and python. The binaries contain installers for the libraries, interfaces and executables. The static libraries included are build for Visual Studio 2017 64 bit

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 7 years ago

HELICS -

Please use 1.0.0-beta.1 instead

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 7 years ago

HELICS - v1.0.0-beta.1

This release fixes an issue with brokers in the previous release, all users should update to this release

Energy Systems - Energy System Modeling Frameworks - C++
Published by phlptp about 7 years ago