Fix attribution of the vendored BPC solver; release 1.1.1 - #4
Merged
Conversation
README.md credited the vendored branch-price-and-cut solver to "Lera-Romero, Rönnqvist & Ljungqvist (2020)" in two places. Rönnqvist and Ljungqvist are not authors of that work, and Miranda Bront and Soulignac, who are, were omitted. The correct reference, as cpp/lera/NOTICE.md has always stated, is Gonzalo Lera-Romero, Juan J. Miranda Bront and Francisco J. Soulignac, "Linear edge costs and labeling algorithms: The case of the time-dependent vehicle routing problem with time windows", Networks 76(1):24-53, 2020, doi:10.1002/net.21937. Since README.md is the PyPI long description, the wrong attribution is live on the package page, so this ships as 1.1.1 to correct it there. Documentation only: no code, no build, no solver behavior change. Also adds a References section with full citations and DOIs for the three works the solver builds on, and restores the CHANGELOG link references for 1.1.1, 1.1.0 and 1.0.0, which were missing. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> Claude-Session: https://claude.ai/code/session_01PAFkDQL4imNfBEemeHNC2s
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
1 participant
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.
Problem
README.mdcredited the vendored branch-price-and-cut solver to "Lera-Romero, Rönnqvist & Ljungqvist (2020)" in two places (lines 72 and 94). Rönnqvist and Ljungqvist are not authors of that work, and Miranda Bront and Soulignac, who are, were omitted.cpp/lera/NOTICE.md,CITATION.cffand the thesis bibliography all had it right. Only the README was wrong.Why this ships as a release
README.mdis the PyPI long description, so the incorrect attribution is currently live on https://pypi.org/project/kayros/. A new version is the only way to correct the package page.Documentation only: no code, no build changes, no solver behavior change. Wheels are functionally identical to 1.1.0.
Changes
Referencessection with full citations and DOIs for the three works the solver builds on (Lera-Romero et al. 2020, Visser & Spliet 2020, Blauth et al. 2024), verified against the thesis bibliography.pyproject.tomlandCITATION.cffto 1.1.1.[1.1.1]/[1.1.0]/[1.0.0]link references.🤖 Generated with Claude Code
https://claude.ai/code/session_01PAFkDQL4imNfBEemeHNC2s