Clean up v0.6 public-facing internals - #13
Merged
Conversation
Complete the conservative v0.6 internal cleanup after stabilizing the public extension contract. Migrate remaining first-time-user documentation and the OG-Core crosswalk to the CGE / Equilibrium / Scenario / Result workflow. Update samtools examples and Control Room wording to use public scientific terminology while retaining the validated lower-level PyCGE engine unchanged. Replace "legacy" wording in the facade with "lower-level" to reflect PyCGE's continued supported status. Clarify project provenance and credit James Matthew Miraflor as Project Lead and Maintainer, distinguishing that role from authorship of inherited PyCGE code and underlying model specifications. Add regression guards for these cleanup decisions. No economic equations, engine behavior, IFPRI, CAMCGE, or lower-level PyCGE compatibility are changed.
miraflor
marked this pull request as ready for review
August 28, 2026 17:47
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.
Summary
Complete the conservative internal cleanup for CGE-Core v0.6 after the public
API, outward-facing surfaces, and downstream extension contract have been
stabilized.
Changes
CGEsolve_benchmark()EquilibriumScenarioScenario.set()Scenario.solve()ResultResult.compare();samtoolsexample to useCGEandStdCGE;PyCGESAM validator internally;PyCGE's continued supported status;StdModelDefin Control Roomuser-facing text with scientific model terminology;
Project Lead and Maintainer;
PyCGE code and underlying model specifications;
Deliberate non-changes
This PR does not:
cge_core/engine.py;PyCGE;StdModelDeforSplModelDefclasses;PyCGEremains the supported advanced/lower-level API in v0.6.Validation
The Phase 6 cleanup guards and the existing v0.6 documentation, extension
contract, and Control Room regression tests pass locally.
git diff --checkalso passes.Scope
This is a terminology, documentation, provenance, and outward-facing cleanup.
It introduces no new economic or solver behavior.
Merge policy
Do not merge until all CI checks are green.