Add release notes for everything since 1.6.1 - #45
Draft
Jim Garrison (garrison) wants to merge 1 commit into
Draft
Jim Garrison (garrison) wants to merge 1 commit into
Jim Garrison (garrison) wants to merge 1 commit into
Conversation
PR #43 adds the reno machinery but deliberately ships no notes, so the release-notes page renders empty. Twenty-eight commits have landed since the 1.6.1 tag, several of which change behavior a user has to know about, and none of it is written down anywhere a user will look. Backfill that history as 19 notes: 6 upgrade, 7 features, 6 fixes. The 1.6.1 tag is far behind main, so every commit covered here is unreleased and the notes render under "Upcoming release" until 1.7.0 is tagged; they need no coordination with the version bump in #42. The upgrade notes are the point of the exercise. Multi-iteration SQD results move, because the amplitudes handed back to the SQD loop were being replaced by a uniform array and are now correct. h_comm_size is gone from the config objects, which raises AttributeError on assignment and, less obviously, is silently ignored as an sbd_config key. carryover_type now defaults to 0, SBD_BUILD_BACKEND=both is rejected in favor of all, backends load one per process with OMP_TARGET_OFFLOAD defaulted to MANDATORY, and pybind11 is no longer a runtime dependency. Examples get one combined note rather than one per pull request: they are scripts in the repository, not importable API, so the note records the parameter regrouping, the dropped Hartree-Fock seed and the new enlarge-subspace driver without itemizing seven pull requests. CI and documentation-only changes get no notes. Three further changes are deliberately omitted as invisible to a 1.6.1 user: the importlib.metadata version switch, the vendored upstream bump (the makestring template instantiation preserves the exposed signature), and the internal GPU build-flag cleanups. Assisted-by: Claude Opus 5
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#43 adds the reno machinery but deliberately ships no notes, so the release-notes page it builds renders empty. Twenty-eight commits have landed since the 1.6.1 tag, several of which change behavior a user has to know about, and none of it is written down anywhere a user will look. This backfills that history as 19 notes: 6 upgrade, 7 features, 6 fixes.
The 1.6.1 tag is far behind
main, so every commit covered here is unreleased. The notes render under "Upcoming release" until 1.7.0 is tagged, at which point reno attaches them to it — so this needs no coordination with the version bump in #42, and the notes are filed loose inreleasenotes/notes/rather than in a1.7.0/subdirectory.The upgrade notes are the point of the exercise
h_comm_sizeis gone fromTPB_SBD/GDB_SBD(Separate SQD parameters from SBD parameters, and expose the ones that were unreachable #28). Assignment now raisesAttributeError, and — less obviously, so the note says it explicitly — an"h_comm_size"key insbd_configis now silently ignored.carryover_typedefaults to 0 (Separate SQD parameters from SBD parameters, and expose the ones that were unreachable #28): a speedup, with bit-identical energies.SBD_BUILD_BACKEND=bothis rejected in favor ofall(Conda-friendly builds, AMD GPU support, and macOS OpenMP #23).OMP_TARGET_OFFLOADdefaulted toMANDATORY(Conda-friendly builds, AMD GPU support, and macOS OpenMP #23) so a silent host fallback becomes an error.pybind11is no longer a runtime dependency (Drop pybind11 from the runtime dependencies #33).Scope
Examples get one combined note rather than one per pull request: they are scripts in the repository, not importable API. It records the parameter regrouping, the dropped Hartree-Fock seed and the new enlarge-subspace driver without itemizing seven pull requests. CI and documentation-only changes get no notes.
Three changes are deliberately omitted as invisible to a 1.6.1 user: the
importlib.metadataversion switch (#16), the vendored upstream bump (#24 — themakestringtemplate instantiation preserves the exposed signature), and the internal GPU build-flag cleanups (#17, #25).Verification
sphinx-build -W --keep-going, the same commandtox -e docsruns, succeeds with zero warnings. All 19 notes render under the correct New Features / Upgrade Notes / Bug Fixes headings, and all 22:func:cross-references resolve to real anchors — 22 roles, 22 links, so none failed silently.reno lintpasses.This pull request was generated by Claude Opus 5 under my guidance.