Merge pull request #183 from bandframework/167v0.4-versioning

167v0.4 versioning - Update bibentry in citation and CHANGELOG

Author: mosesyhc

.github/config/.wordlist.txt

@@ -7,11 +7,14 @@ Bingham
 CHANGELOG
 CMake
 COVID
+Changelog
 Cython
+Cythonizing
 GPy
 Gitflow
 Gramacy
 Jupyter
+Jupyterbook
 Kriging
 LHS
 LaTeX
@@ -47,6 +50,7 @@ autofunction
 automodule
 bandframework
 bayesian
+bookending
 buildable
 calibrationmethods
 chan
@@ -76,6 +80,7 @@ io
 ipynb
 jupyter
 lbl
+macOS
 miamioh
 microsoft
 mlbayeswoodbury
@@ -123,7 +128,7 @@ whl
 wordpress
 wp
 www
-youtube
 yml
+youtube
 zNqg
 Özge

CHANGELOG.rst

@@ -4,6 +4,39 @@ Release Notes
 
 Below are the notes from all surmise releases.
 
+Release 0.4.0
+-------------
+
+:Date: October 14, 2025
+
+* Improve coverage of test suite for future integration of additional code.
+* Designate methods to "research-grade" if methods are neither fully tested or maintained.
+* Integrate a first example in Jupyterbook as a collection of usage examples.
+* Improve Cython integration by reducing the number of external dependencies.
+* Develop Github wiki pages to log developer notes in terms of packaging, Cythonizing, and major dependency intricacies.
+
+**Full Changelog**: https://github.com/bandframework/surmise/compare/v0.3.1...v0.4.0
+
+Release 0.3.0
+-------------
+
+:Date: September 12, 2024
+
+* Tested in Python 3.9, 3.10, 3.11, 3.12, on Linux, macOS, and Windows.
+* Functionality:
+  * Include tox developer integration.
+  * Include save/load functions for emulator and calibrator.
+  * Include empirical coverage calculations in calibrator.
+  * Modify `covx()`-returned object to improve usability.
+  * Modify object `repr` to improve user feedback.
+  * Update test suite to improve testing, including bookending versions and testing of major methods.
+* Documentation:
+  * Update documentation to emphasize introductory materials and usage tutorials.
+  * Update scientific usage references.
+  * Update README to include collaborator and contributor list.
+
+**Full Changelog**: https://github.com/bandframework/surmise/compare/v0.2.1...v0.3.0
+
 Release 0.2.1
 -------------
 

README.rst

@@ -104,12 +104,12 @@ it to generate documentation.
 
 .. code-block:: bibtex
 
-   @techreport{surmise2024,
+   @techreport{surmise2025,
      author      = {Matthew Plumlee and \"Ozge S\"urer and Stefan M. Wild and Moses Y-H. Chan},
-     title       = {{surmise 0.3.0} Users Manual},
+     title       = {{surmise 0.4.0} Users Manual},
      institution = {NAISE},
-     number      = {Version 0.3.0},
-     year        = {2024},
+     number      = {Version 0.4.0},
+     year        = {2025},
      url         = {https://surmise.readthedocs.io}
    }