Skip to content

Clean up v0.6 public-facing internals - #13

Merged
miraflor merged 1 commit into
mainfrom
v0.6-phase6-internal-cleanup
Aug 28, 2026
Merged

Clean up v0.6 public-facing internals#13
miraflor merged 1 commit into
mainfrom
v0.6-phase6-internal-cleanup

Conversation

@miraflor

Copy link
Copy Markdown
Owner

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

  • migrate remaining first-time-user documentation to the public v0.6 workflow;
  • update the OG-Core crosswalk to lead with:
    • CGE
    • solve_benchmark()
    • Equilibrium
    • Scenario
    • Scenario.set()
    • Scenario.solve()
    • Result
    • Result.compare();
  • update the public samtools example to use CGE and StdCGE;
  • retain the existing lower-level PyCGE SAM validator internally;
  • replace “legacy” terminology in the facade with “lower-level” to reflect
    PyCGE's continued supported status;
  • replace implementation-class wording such as StdModelDef in Control Room
    user-facing text with scientific model terminology;
  • clarify project provenance and credit James Matthew Miraflor as
    Project Lead and Maintainer;
  • distinguish project leadership and maintenance from authorship of inherited
    PyCGE code and underlying model specifications;
  • add Phase 6 regression guards.

Deliberate non-changes

This PR does not:

  • modify cge_core/engine.py;
  • change economic equations;
  • remove or deprecate PyCGE;
  • rename the internal StdModelDef or SplModelDef classes;
  • change IFPRI;
  • change CAMCGE;
  • add a universal closure abstraction;
  • add persistence or plugin infrastructure;
  • change dynamic-model behavior;
  • bump the release version.

PyCGE remains 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 --check also 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.

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
miraflor marked this pull request as ready for review August 28, 2026 17:47
@miraflor
miraflor merged commit 1ea0ac0 into main Aug 28, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant