migrate_model
Forward-migrate a loaded EnergyPlus model to a newer version. Replaces the in-memory document with the migrated version and records a change log for subsequent validation and saving.
Instructions
Forward-migrate the loaded model to a newer EnergyPlus version.
Drives the EnergyPlus IDFVersionUpdater transition binaries through the
required chain of steps and replaces the session document with the migrated
one. state.file_path is unchanged — call save_model(path=...) to
persist the migrated model.
Preconditions: model loaded; target version >= current model version. Side effects: replaces the in-memory document; records a change-log entry. Next step: validate_model + check_model_integrity, then save_model.
Read idfkit://migration/report for per-step stdout/stderr and the
structural diff after the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keep_work_dir | No | Retain the per-step transition work directory for debugging. | |
| energyplus_dir | No | EnergyPlus install dir. Autodetected if None. | |
| target_version | No | Target EnergyPlus version "X.Y.Z". If omitted, uses the installed EnergyPlus version (the migration binaries ship with EnergyPlus, so an install is required regardless). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| diff | Yes | Structural diff between the source and migrated documents. | |
| steps | Yes | ||
| success | Yes | ||
| summary | Yes | ||
| source_version | Yes | ||
| target_version | Yes | ||
| requested_target | Yes |