Skip to content

Commit

Permalink
Final Version and doc update to roadmap and readme and date. (#1126)
Browse files Browse the repository at this point in the history
* Final Version and doc update to roadmap and readme and date.

* suggested updates
  • Loading branch information
phlptp authored Mar 7, 2020
1 parent 89a3cea commit 82839b1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ project(HELICS VERSION 2.4.1)
# -----------------------------------------------------------------------------
set(HELICS_VERSION_BUILD)
# use ISO date YYYY-MM-DD
set(HELICS_DATE "2020-03-05")
set(HELICS_DATE "2020-03-06")

set(HELICS_VERSION_UNDERSCORE
"${HELICS_VERSION_MAJOR}_${HELICS_VERSION_MINOR}_${HELICS_VERSION_PATCH}"
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,13 @@ A list of optional component that are not included in HELICS but are optionally

## Publications

### General HELICS

\[1\] B. Palmintier, D. Krishnamurthy, P. Top, S. Smith, J. Daily, and J. Fuller, “Design of the HELICS High-Performance Transmission-Distribution-Communication-Market Co-Simulation Framework,” in *Proc. of the 2017 Workshop on Modeling and Simulation of Cyber-Physical Energy Systems*, Pittsburgh, PA, 2017. [pre-print](https://www.nrel.gov/docs/fy17osti/67928.pdf) | [published](https://ieeexplore.ieee.org/document/8064542/)

## In the News

HELICS was selected as an [R&D 100 Award Finalist](https://www.rdworldonline.com/finalists-announced-for-2019-rd-100-awards/).


## Source Repo

The HELICS source code is hosted on GitHub: [https://github.com/GMLC-TDC/HELICS](https://github.com/GMLC-TDC/HELICS)
Expand Down
16 changes: 10 additions & 6 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,35 @@
This document contains tentative plans for changes and improvements of note in upcoming versions of the HELICS library. All dates are approximate and subject to change, but this is a snapshot of the current planning thoughts. See the [projects](https://github.com/GMLC-TDC/HELICS/projects) for additional details


## \[2.5\] ~ 2020-05-01
## \[2.5\] ~ 2020-04-15
- Multi-broker to allow multiple communication cores to be connected in the same federation
- Some dynamic federation support
- C API callbacks for custom filters
- improved REST API support
- Improved REST API support
- Clarification and API support for multiple publications to a single input N-1 value based
- Websocket based core type
- Internal text based(probably JSON) message format option for general backwards compatibility
- Separate out networking library
- Separate out additional networking library components
- Split core library between comms layer components and actual core API
- Debugging tools (Global time synchronization points)
- Additional package manager integration
- Performance improvements and tests
- Increased code Coverage (target 80%)
- Deprecate C api message structure

## \[2.6\] ~ 2020-07-31
It is unclear if there will be a 2.6 release or the changes would just get rolled into a 3.0 release. If there is it would be the last of the 2.X series and would likely be released in late July, 2020.
## \[2.6\] ~ 2020-07-15
This will be the last of the 2.X series releases, there will likely be at least one patch release after this before fully moving to 3.0
- Internal text based (probably JSON) message format option for general backwards compatibility
- Debugging tools
- Additional package manager integration
- Performance improvements and tests

## \[3.0\] ~ 2020-08-26
- Upgrade minimum compilers and build systems. Currently planned targets are gcc 7.0, clang 5.0, MSVC 2017 15.7, CMake 3.10. This is a setup which should be supported on Ubuntu 18.04 repositories. Minimum Boost version will also be updated though Boost is becoming less critical for the HELICS core so may not be that important. The likely minimum tested target will likely be 1.65.1 though the core make work with older versions and can be disabled completely. Certain features may require a newer boost version(1.70) than what would be available on Ubuntu 18.04. HELICS 3.0 will not be released until Ubuntu 20.04 LTS is out and RHEL 8.0 has been out for a year, and RHEL 8.1 is released, and probably 8.2. Minimum required compilers for building on macOS and systems using ICC will include Xcode 10 and ICC 19. The minimum ZMQ version will also be bumped up to 4.2. General policy for Mac builds will be supporting Xcode compilers on versions of MacOS that receive security upgrades which is generally the last 3 versions, though 11 and 10 will likely be the only 2 supported at HELICS 3.0 release. MSVC compilers will be supported for at least 2 years from release date, an appropriate CMake (meaning slightly newer than the compiler) will also be required for Visual studio builds.
- Control interface
- Full Dynamic Federation support
- Much more general debugging support
- Targeted endpoints
- General API changes based on feedback
- SSL capable core
- Single thread cores
- Plugin architecture for user defined cores
Expand Down

0 comments on commit 82839b1

Please sign in to comment.