updates for 0.5.0 release

* bump version number * update ChangeLog
LLNL · Jun 22, 2022 · 340d9c3 · 340d9c3
1 parent d34f5aa
commit 340d9c3
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 14 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,3 +1,33 @@
+# Wed Jun 22 2022 Stephanie Brink <[email protected]> v0.5.0
+Version 0.5.0 is a major release.
+
+### New features
+* Support for new architectures: AMD CPUs, Intel Ice Lake
+* Add examples for integration Variorum into OpenMP and MPI programs, adds
+  dependency on rankstr library for MPI examples (optional)
+
+### API changes
+* Rename clock_speed to frequency and power_limits to power_limit throughout
+  Variorum API
+* Report info about power domains through JSON, such as what can be measured,
+  what can be measured and capped (along with limits), and what cannot be
+  measured or capped (unsupported).
+* Deprecate set_and_verify API and removes associated example
+* Extend JSON API and Best Effort Node Power Cap to ARM, AMD, and Intel
+  platforms, IBM already supported
+
+### Other notable changes
+* Use getopt to parse arguments in examples
+* CI migrated from Travis to GitLab
+* Add presentations from ECP 2021 tutorial seriess
+* Extend GitLab build matrix to build across different GCC versions
+* Refactor msr_core.[ch] into its own directory as it is used by both Intel and
+  AMD ports
+* Improved docs: add AMD and ARM docs, rankstr dependency, re-organize
+  hierarchy, update system digram, add pages for categories of APIs, add info
+  on Argo, PowerStack, EEHPC WG, PowerAPI, and Variorum integrations
+* License header check as new unit test
+
 # Fri Apr 2 2021 Stephanie Brink <[email protected]> v0.4.1
 * Add docs for NVIDIA port
 * Add units to tabular and JSON output formats

diff --git a/README b/README
@@ -6,7 +6,7 @@
 Welcome to Variorum, a platform-agnostic library exposing monitor and control
 interfaces for several features in hardware architectures.
 
-version 0.4.1
+version 0.5.0
 
 
 Last Update
@@ -84,7 +84,7 @@ or `/proc/cpuinfo` (note that it will not be in hexadecimal).
 
 Supported AMD Microrchitectures:
 
-    Family 19h, Models 0~Fh and 30h ~ 3Fh (EPYC Milan) 
+    Family 19h, Models 0~Fh and 30h ~ 3Fh (EPYC Milan)
 
 Supported ARM Microrchitectures:
 
@@ -128,8 +128,9 @@ For sample code, see the `examples/` directory.
 This software has certain system requirements depending on what hardware you
 are running on.
 
-AMD: Running this software on AMD platforms depends on the AMD Energy Driver, 
-AMD HSMP driver, and AMD E-SMI library being available with the correct permissions. 
+AMD: Running this software on AMD platforms depends on the AMD Energy Driver,
+AMD HSMP driver, and AMD E-SMI library being available with the correct
+permissions.
 
 ARM: Running this software on ARM platforms depends on the Linux Hardware
 Monitoring (hwmon) subsystem for access to the monitoring and control

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.4.1
+0.5.0
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -6,7 +6,7 @@
 # avoid warnings for project commands w/o VERSION
 cmake_policy(SET CMP0048 NEW)
 
-project(variorum VERSION "0.4.1" LANGUAGES C CXX)
+project(variorum VERSION "0.5.0" LANGUAGES C CXX)
 
 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
 

diff --git a/src/docs/dox/Doxyfile b/src/docs/dox/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "variorum"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.4.1
+PROJECT_NUMBER         = 0.5.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/src/docs/dox/Doxyfile.in b/src/docs/dox/Doxyfile.in
@@ -38,7 +38,7 @@ PROJECT_NAME           = "variorum"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.4.1
+PROJECT_NUMBER         = 0.5.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/src/docs/sphinx/conf.py b/src/docs/sphinx/conf.py
@@ -39,7 +39,7 @@
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-# templates_path = ['/g/g19/brink2/git_root_pub/variorum-docs/src/docs/sphinx/_templates']
+# templates_path = []
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -59,9 +59,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.4.1'
+version = '0.5.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.4.1'
+release = '0.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -135,7 +135,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['/g/g19/brink2/git_root_pub/variorum-docs/src/docs/sphinx/_static']
+# html_static_path = []
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

diff --git a/src/docs/sphinx/conf.py.in b/src/docs/sphinx/conf.py.in
@@ -59,9 +59,9 @@ copyright = u'2019-2022, LLNS'
 # built documents.
 #
 # The short X.Y version.
-version = '0.4.1'
+version = '0.5.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.4.1'
+release = '0.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.