Skip to content

Prepare CGE-Core v0.6.0 release - #14

Merged
miraflor merged 1 commit into
mainfrom
v0.6-phase7-release
Aug 28, 2026
Merged

Prepare CGE-Core v0.6.0 release#14
miraflor merged 1 commit into
mainfrom
v0.6-phase7-release

Conversation

@miraflor

Copy link
Copy Markdown
Owner

Summary

Finalize CGE-Core v0.6.0 release metadata, documentation, migration notes, and
release-consistency safeguards.

Changes

  • bump pyproject.toml to 0.6.0;
  • bump CITATION.cff to 0.6.0;
  • update the source-tree __version__ fallback to 0.6.0;
  • update the README software citation to 0.6.0;
  • add the v0.6.0 changelog entry;
  • document the migration from the lower-level PyCGE workflow to the public:
    • CGE
    • Equilibrium
    • Scenario
    • Result
      workflow;
  • replace the stale notebook development-branch example with
    CGE_CORE_REF=v0.6.0;
  • clarify PyCGE as the supported advanced/lower-level API;
  • replace the inaccurate “Public domain API” facade wording with
    “Public scientific API”;
  • add permanent release-consistency regression tests.

Release scope

v0.6.0 introduces the stable public Hosoe workflow:

CGE -> solve_benchmark() -> Equilibrium -> scenario() -> Scenario.set() -> Scenario.solve() -> Result

The release also preserves:

  • independent mutable scenarios from one solved benchmark;
  • immutable previously returned Result snapshots;
  • public value() reads;
  • objective;
  • Result.compare();
  • public imports from cge_core and cge_core.models.

Compatibility

PyCGE remains supported as the advanced/lower-level API for:

  • existing code;
  • implementation inspection;
  • direct engine use;
  • advanced model development.

This release does not remove or deprecate PyCGE.

Deliberate non-changes

This PR does not:

  • modify cge_core/engine.py;
  • change economic equations;
  • intentionally change benchmark or scenario numerical behavior;
  • change IFPRI architecture;
  • change CAMCGE architecture;
  • introduce a universal closure abstraction;
  • introduce plugin infrastructure;
  • introduce persistence;
  • add dynamic-model behavior.

Validation

The full public test suite passes locally.

git diff --check also passes.

The PR CI remains the final release gate for:

  • Python 3.9–3.14 structural coverage;
  • real IPOPT public solver coverage with zero skips;
  • package build and wheel/sdist validation;
  • Twine and CITATION.cff validation;
  • Ruff correctness checks;
  • documentation build.

Release policy

Do not merge until all CI checks are green.

After merge, tag the resulting main commit as v0.6.0 and create the
corresponding GitHub release.

Finalize CGE-Core v0.6.0 release metadata, documentation, migration notes,
and release-consistency guards.

Bump package, citation, README, and source fallback versions to 0.6.0.
Add the v0.6.0 changelog entry and migration mapping from the lower-level
PyCGE workflow to the public CGE / Equilibrium / Scenario / Result API.

Replace the stale notebook development-branch example with the release tag,
clarify the supported advanced/lower-level PyCGE wording, and correct the
facade docstring from "Public domain API" to "Public scientific API".

Add release-consistency regression tests.

The full public test suite and git diff --check pass locally. No economic
equations or solver behavior are changed.
@miraflor
miraflor marked this pull request as ready for review August 28, 2026 18:00
@miraflor
miraflor merged commit 7d07cf8 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