updates for 0.8.0 release (#521)

- bump version number - update ChangeLog - add missing APIs from docs - docs: update releases page
LLNL · Mar 26, 2024 · 8057604 · 8057604
1 parent c18b9a8
commit 8057604
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 4 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,3 +1,45 @@
+# Tue Mar 26 2024 Stephanie Brink <[email protected]> v0.8.0
+Version 0.8.0 is a major release.
+
+### New features
+* Adds energy APIs: Print and JSON (#530)
+* Update powmon to report utilization in addition to power. (#510)
+* Update JSON utilization API to support CPU-only, GPU-only and multi-architecture
+  systems (#525)
+* Support GPUs and multi-architecture builds with new nested variorum_get_power_json API
+* Adds GPU and node utilization JSON APIs (CPU, GPU, Memory) (#431)
+* Add json output for frequency data (#488)
+* Add json output for thermal data (#461)
+* Adds libjustify as an optional build dependency for formatting tabular output (#468)
+
+### Documentation updates
+* Update supported architectures (#482)
+* Fix reference to Examples.rst from api/print_functions.rst
+
+### Bug fixes
+* Fix Intel DRAM overflow issue (#328)
+* Fix memory leak in Nvidia port
+* Decref json object if unable to access ibm OCC sensor file (#477)
+* Fix extern linkage issues in nvidia_gpu_power_features.h in newer versions of gcc
+  (#464)
+
+### Internal changes
+* Rename powmon to var_monitor throughout (#523)
+* Update Variorum AMD GPU port to support ROCm 6.0.2 (#512)
+* Code cleanup: change uint64_t assignments from -1 to 0 (#519)
+* Update the name of variorum_get_thermals_example to match the API (#509)
+* Top-level API: rename variorum_get_node_frequency_json --> variorum_get_frequency_json
+  (#50)
+* Add -example to utilization json example files (#501)
+* Add missing ifdefs for P_*_{CPU,GPU}_IDX variables
+* Format headers, parameters on new lines (#491, #493, #534)
+* Add host config for folsom, alehouse cpu+gpu, alehouse gpu-only, remove host config
+  for tavern, fix host config for rhetoric and thompson (#447, #457, #458, #478, #508)
+* Report GPU power limit using the correct NVML API (#446)
+* Change return code for variorum_cap_socket_frequency_limit from -1 to 0
+* Fix function pointer for intel model/family 06-4f (#536)
+* Various updates to internal GitLab and external GitHub CI
+
 # Tue Jun 13 2022 Stephanie Brink <[email protected]> v0.7.0
 Version 0.7.0 is a major release.
 

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.7.0
+version 0.8.0
 
 
 Last Update
 -----------
-13 June 2023
+26 March 2024
 
 
 Webpages

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.7.0
+0.8.0
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.7.0
+PROJECT_NUMBER         = 0.8.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,17 @@
 Variorum is under constant development. So, we recommend using our ``dev``
 branch, which contains our latest features.
 
+********
+ v0.8.0
+********
+
+03/26/2023: Major release adds JSON APIs for GPU, node utilization, energy
+usage, frequency, and thermal data, adds print and print verbose APIs for energy
+usage, updates JSON power API to support GPUs and multi-architecture builds,
+renames powmon to var_monitor and extends var_monitor to report utilization,
+adds libjustify as an optional build dependency for formatting tabular data.
+`v0.8.0 tarball here <https://github.com/LLNL/variorum/archive/v0.8.0.tar.gz>`_.
+
 ********
  v0.7.0
 ********

diff --git a/src/docs/sphinx/api/json_support_functions.rst b/src/docs/sphinx/api/json_support_functions.rst
@@ -22,3 +22,4 @@ Defined in ``variorum/variorum.h``.
 
 .. doxygenfunction:: variorum_get_utilization_json
 
+.. doxygenfunction:: variorum_get_energy_json
diff --git a/src/docs/sphinx/api/print_functions.rst b/src/docs/sphinx/api/print_functions.rst
@@ -18,6 +18,8 @@ output formats supported by Variorum.
 
 Defined in ``variorum/variorum.h``.
 
+.. doxygenfunction:: variorum_print_verbose_energy
+
 .. doxygenfunction:: variorum_print_verbose_power
 
 .. doxygenfunction:: variorum_print_power
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,3 +22,4 @@ Defined in ``variorum/variorum.h``.

		.. doxygenfunction:: variorum_get_utilization_json

		.. doxygenfunction:: variorum_get_energy_json