changes in preparation of v0.4.0 release (#170)

* convert changelog to markdown * update changelog
LLNL · Mar 3, 2021 · 4edcc9d · 4edcc9d
1 parent a562c97
commit 4edcc9d
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 67 deletions.
diff --git a/ChangeLog b/ChangeLog
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -0,0 +1,80 @@
+# Wed Mar 3 2021 Stephanie Brink <[email protected]> v0.4.0
+* Add support for ARM Juno architecture
+* Add top-level API to query available frequencies, add support for Intel and ARM
+* Add JANSSON-C dependency
+* Introduce JSON API to return monitoring data into a structure
+* Update variorum to build and run with both msr-safe < v1.5 (msr_whitelist)
+  msr-safe >= v1.5 (msr_allowlist)
+* Add best effort node power cap support for Intel Broadwell and IBM
+* Build option to enable all warnings, cleanup compiler warnings
+* Default build type switched from Release to RelWithDebInfo
+* Consistent formatting for verbose printouts across architectures
+* Update year in license headers
+* Update docs throughout: JSON API, best effort power cap, architectures
+  supported, add sample output to examples
+* Rename set functions to cap throughout top-level API (and internally in
+  architecture-level functions) to clarify that the setting is an upper bound;
+  instantaneous reads on these metrics may be at or below the value
+
+# Thu Apr 23 2020 Stephanie Brink <[email protected]> v0.3.0
+* Setup unit test infrastructure, test on gitlab to leverage msr-safe and OPAL
+  access
+* Update return code for top-level variorum APIs from -1 to 0, enables us to
+  run unit tests on any architecture
+* Fix poll_power and monitoring segfaults
+* Start adding python utilities to verify system environments (i.e. msr-safe,
+  OPAL)
+* Rename variorum_set_topology to variorum_get_topology
+* Rename variorum examples
+* Add example integrations with cmake/make-build systems and c/cpp/fortran
+  codes, use these in CI workflow to test install
+* Use spack mirrors in CI workflow to avoid failed fetch commands
+* New mailing lists: variorum-users and variorum-maintainers
+* Nvidia port: use node topology to map GPU to sockets
+* Fix for building variorum as static library
+* Add source code (c/cpp/h/python) format check to CI workflow
+* Add Contributor Covenant Code of Conduct
+
+# Fri Mar 13 2020 Stephanie Brink <[email protected]> v0.2.0
+* Add support for Nvidia platform -- Volta architecture
+* Add ECP 2020 tutorial presentation
+* Prefix front-facing APIs with variorum_
+* Bug fix for computing power usage values
+* On Intel platforms, translate both power limit time windows (not just TW1)
+* Fix hwloc topology mapping (use logical indices, not OS)
+* Integrate Travis and GitLab for CI
+* Modify IBM powmon formatting into columns
+* Update license year for 2020
+
+# Wed Nov 11 2019 Stephanie Brink <[email protected]> v0.1.0
+* Initial release to <https://github.com/llnl/variorum>!
+* Includes support for Intel platform -- Sandy Bridge, Ivy Bridge, Haswell,
+  Broadwell, Skylake, and Kaby Lake architectures
+* Includes support for IBM platform -- Power9 architecture
+* Add powmon command line sample for monitoring performance counters during
+  application execution
+* Initial RTD at <https://variorum.readthedocs.io>
+* Rename libvariorum to variorum
+* Bug fix for computing power from energy on Intel
+* Add developer docs for supporting new platforms
+* Add info on IBM sensors, OCC, and power shifting ratio
+* Rename front-facing APIs from print_*() to print_verbose_*() and dump_*() to
+  print_*()
+
+# Wed Jul 19 2017 Stephanie Labasan <[email protected]> v0.0.0
+* Initial release to libvariorum repo on internal Bitbucket.
+* Base Sphinx documentation taken from SDAV Alpine project. Still has some
+  legacy info as an example..
+* Use Breathe to interpret Doxygen source code comments for documentation on
+  Sphinx webpage.
+* Download and build hwloc dependency.
+* Include googletest in libvariorum source code and build dependency.
+* Include a couple googletests checking the presence, permissions, and validity
+  of the msr and msr-safe drivers and the msr whitelist.
+* Include a host configuration file for LLNL's catalyst system using Intel's
+  compilers to generate a CMakeCache.txt.
+* Add support for the following features: print/dump_power(),
+  print/dump_counters(), print/dump_thermals(), print/dump_package_frequency(),
+  print/dump_power_limits(), print_topology(), print_features().
+* Write examples for the above set of features.
+* Add offset lists for Ivy Bridge, Broadwell, and Kaby Lake.
diff --git a/README b/README
@@ -6,12 +6,12 @@
 Welcome to Variorum, a platform-agnostic library exposing monitor and control
 interfaces for several features in hardware architectures.
 
-version 0.3.0
+version 0.4.0
 
 
 Last Update
 -----------
-15 April 2020
+26 February 2021
 
 
 Webpages

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.3.0
+0.4.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.3.0" LANGUAGES C CXX)
+project(variorum VERSION "0.4.0" LANGUAGES C CXX)
 
 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
 

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.3.0
+PROJECT_NUMBER         = 0.4.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/Releases.rst b/src/docs/sphinx/Releases.rst
@@ -11,6 +11,10 @@ Variorum is under constant development. So, we recommend using our ``dev``
 branch, which contains our latest features. The ``main`` branch will be
 updated as releases occur.
 
+v0.4.0
+------
+02/26/2021: Updated version includes support for ARM Juno architecture, introduction of the JSON API, and Intel support for two versions of msr-safe. `v0.4.0 tarball here <https://github.com/LLNL/variorum/archive/v0.4.0.tar.gz>`_.
+
 v0.3.0
 ------
 04/23/2020: Updated version includes general infrastructure updates, such as unit tests, example integrations, and small bug fixes throughout. `v0.3.0 tarball here <https://github.com/LLNL/variorum/archive/v0.3.0.tar.gz>`_.

diff --git a/src/docs/sphinx/conf.py.in b/src/docs/sphinx/conf.py.in
@@ -45,16 +45,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Variorum'
-copyright = u'2019, LLNS'
+copyright = u'2019-2021, LLNS'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.0'
+version = '0.4.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.0'
+release = '0.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.