diff --git a/CHANGELOG.md b/CHANGELOG.md index e12e257f75..a34eea463b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,32 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). A note on future revisions. -Everything within a major version number should be code compatible (with the exception of experimental interfaces). The most notable example of an experimental interface is the support for multiple source inputs. The APIs to deal with this will change in future minor releases. Everything within a single minor release should be network compatible with other federates on the same minor release number. Compatibility across minor release numbers may be possible in some situations but we are not going to guarantee this as those components are subject to performance improvements and may need to be modified at some point. Patch releases will be limited to bug fixes and other improvements not impacting the public API or network compatibility. Check the [Public API](./docs/Public_API.md) for details on what is included and excluded from the public API and version stability. +Everything within a major version number should be code compatible (with the exception of experimental interfaces). Everything within a single minor release should be network compatible with other federates on the same minor release number. Compatibility across minor release numbers may be possible in some situations but we are not going to guarantee this as those components are subject to performance improvements and may need to be modified at some point. Patch releases will be limited to bug fixes and other improvements not impacting the public API or network compatibility. Check the [Public API](./docs/Public_API.md) for details on what is included and excluded from the public API and version stability. + +## [2.7.1][] - 2021-06-03 + +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 ## [2.7.0][] - 2021-04-28 @@ -837,3 +862,5 @@ This is a major revision so this changelog will not capture all the changes that [2.5.2]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.5.2 [2.6.0]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.6.0 [2.6.1]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.6.1 +[2.7.0]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.7.0 +[2.7.1]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.7.1 diff --git a/CMakeLists.txt b/CMakeLists.txt index 65e0031d8c..6149313b6c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -23,14 +23,14 @@ if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE) set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake" CACHE STRING "") endif() -project(HELICS VERSION 2.7.0) +project(HELICS VERSION 2.7.1) # ----------------------------------------------------------------------------- # HELICS Version number # ----------------------------------------------------------------------------- set(HELICS_VERSION_BUILD) # use ISO date YYYY-MM-DD -set(HELICS_DATE "2021-04-29") +set(HELICS_DATE "2021-06-05") set(HELICS_VERSION_UNDERSCORE "${HELICS_VERSION_MAJOR}_${HELICS_VERSION_MINOR}_${HELICS_VERSION_PATCH}" diff --git a/README.md b/README.md index aad1e6ccc9..3b4b981073 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,8 @@ HELICS is also highly scalable, enabling everything from simple connections betw ## Getting Started +The users guide has been completely redone for the upcoming HELICS 3. This version is not released yet but it is close, and the [docs](https://docs.helics.org/en/helics3/) are mostly done. We suggest you check it out if you are looking for more documentation. + We've created a series of roughly 10-minute mini-tutorial videos that discuss various design topics, concepts, and interfaces, including how to use the tool. They can be found on our [YouTube channel](https://www.youtube.com/channel/UCPa81c4BVXEYXt2EShTzbcg). The [Introduction to the HELICS documentation](https://helics.readthedocs.io/en/latest/introduction/index.html) goes through a series of examples that step through the basic usage and concepts of HELICS. diff --git a/ThirdParty/concurrency b/ThirdParty/concurrency index b1be15315b..1ffdb2b7d9 160000 --- a/ThirdParty/concurrency +++ b/ThirdParty/concurrency @@ -1 +1 @@ -Subproject commit b1be15315b938fdbf30d71421b837f3c43753d11 +Subproject commit 1ffdb2b7d9894d8dd4e3f284dff1a7052a785ac9 diff --git a/appveyor.yml b/appveyor.yml index 8a0c8fb270..c5fbdd188a 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -7,7 +7,7 @@ branches: - develop - helics3 -version: 2.7.0.{build} +version: 2.7.1.{build} image: Visual Studio 2015 diff --git a/docs/apps/Player.md b/docs/apps/Player.md index 96b5accfa4..f73b5d7c14 100644 --- a/docs/apps/Player.md +++ b/docs/apps/Player.md @@ -133,7 +133,7 @@ m