Turn off the ironing out loop by default

schemas/input/model.yaml

@@ -31,7 +31,7 @@ properties:
   max_ironing_out_iterations:
     type: integer
     description: The maximum number of iterations to run the "ironing out" step of agent investment for
-    default: 10
+    default: 1
   price_tolerance:
     type: number
     description: The relative tolerance for price convergence in the ironing out loop

src/cli/example.rs

@@ -100,7 +100,7 @@ fn handle_example_extract_command(name: &str, dest: Option<&Path>, patch: bool)
 /// If `patch` is `true`, then the corresponding patched example will be extracted.
 fn extract_example(name: &str, patch: bool, dest: &Path) -> Result<()> {
     if patch {
-        let patches = get_patches(name)?;
+        let (file_patches, toml_patch) = get_patches(name)?;
 
         // NB: All patched models are based on `simple`, for now
         let example = Example::from_name("simple").unwrap();
@@ -114,10 +114,12 @@ fn extract_example(name: &str, patch: bool, dest: &Path) -> Result<()> {
 
         // Patch example and put contents in dest
         fs::create_dir(dest).context("Could not create output directory")?;
-        ModelPatch::new(example_path)
-            .with_file_patches(patches.to_owned())
-            .build(dest)
-            .context("Failed to patch example")
+        let mut model_patch =
+            ModelPatch::new(example_path).with_file_patches(file_patches.to_owned());
+        if let Some(toml_patch) = toml_patch.as_ref() {
+            model_patch = model_patch.with_toml_patch(toml_patch);
+        }
+        model_patch.build(dest).context("Failed to patch example")
     } else {
         // Otherwise it's just a regular example
         let example = Example::from_name(name)?;

src/example/patches.rs

@@ -1,36 +1,47 @@
-//! File patches to be used in integration tests.
+//! Patches to be used in integration tests.
 //!
 //! This is used to test small variations on existing example models.
 use crate::patch::FilePatch;
 use anyhow::{Context, Result};
 use std::{collections::BTreeMap, sync::LazyLock};
 
-/// A map of file patches, keyed by name
-type PatchMap = BTreeMap<&'static str, Vec<FilePatch>>;
+/// Map of patches keyed by name, with the file patches and an optional TOML patch
+type PatchMap = BTreeMap<&'static str, (Vec<FilePatch>, Option<String>)>;
 
-/// The file patches, keyed by name
+/// The patches, keyed by name
 static PATCHES: LazyLock<PatchMap> = LazyLock::new(get_all_patches);
 
 /// Get all patches
 fn get_all_patches() -> PatchMap {
     [
+        // The simple example with gas boiler process made divisible
         (
-            // The simple example with gas boiler process made divisible
             "simple_divisible",
-            vec![
-                FilePatch::new("processes.csv")
-                    .with_deletion("RGASBR,Gas boiler,all,RSHEAT,2020,2040,1.0,")
-                    .with_addition("RGASBR,Gas boiler,all,RSHEAT,2020,2040,1.0,1000"),
-            ],
+            (
+                vec![
+                    FilePatch::new("processes.csv")
+                        .with_deletion("RGASBR,Gas boiler,all,RSHEAT,2020,2040,1.0,")
+                        .with_addition("RGASBR,Gas boiler,all,RSHEAT,2020,2040,1.0,1000"),
+                ],
+                None,
+            ),
         ),
         // The simple example with objective type set to NPV for one agent
         (
             "simple_npv",
-            vec![
-                FilePatch::new("agent_objectives.csv")
-                    .with_deletion("A0_RES,all,lcox,,")
-                    .with_addition("A0_RES,all,npv,,"),
-            ],
+            (
+                vec![
+                    FilePatch::new("agent_objectives.csv")
+                        .with_deletion("A0_RES,all,lcox,,")
+                        .with_addition("A0_RES,all,npv,,"),
+                ],
+                None,
+            ),
+        ),
+        // The simple example with the ironing-out loop turned on
+        (
+            "simple_ironing_out",
+            (vec![], Some("max_ironing_out_iterations = 10".to_string())),
         ),
     ]
     .into_iter()
@@ -43,8 +54,8 @@ pub fn get_patch_names() -> impl Iterator<Item = &'static str> {
 }
 
 /// Get patches for the named patched example
-pub fn get_patches(name: &str) -> Result<&[FilePatch]> {
-    Ok(PATCHES
+pub fn get_patches(name: &str) -> Result<&'static (Vec<FilePatch>, Option<String>)> {
+    PATCHES
         .get(name)
-        .with_context(|| format!("Patched example '{name}' not found"))?)
+        .with_context(|| format!("Patched example '{name}' not found"))
 }

src/model/parameters.rs

@@ -77,7 +77,7 @@ define_unit_param_default!(default_capacity_limit_factor, Dimensionless, 0.1);
 define_unit_param_default!(default_value_of_lost_load, MoneyPerFlow, 1e9);
 define_unit_param_default!(default_price_tolerance, Dimensionless, 1e-6);
 define_unit_param_default!(default_remaining_demand_absolute_tolerance, Flow, 1e-12);
-define_param_default!(default_max_ironing_out_iterations, u32, 10);
+define_param_default!(default_max_ironing_out_iterations, u32, 1);
 define_param_default!(default_capacity_margin, f64, 0.2);
 define_param_default!(default_mothball_years, u32, 0);
 

tests/data/circularity/assets.csv

@@ -6,24 +6,23 @@ asset_id,process_id,region_id,agent_id,group_id,commission_year,decommission_yea
 4,OILRF2,GBR,A0_OAG,,2020,2030,573.9
 5,WNDFRM,GBR,A0_ELC,,2020,,3.964844
 6,GASCGT,GBR,A0_ELC,,2020,,2.999
-7,H2YGEN,GBR,A0_ELC,,2020,,1.0
-8,H2YPRO,GBR,A0_ELC,,2020,2040,31.54
+7,H2YGEN,GBR,A0_ELC,,2020,2030,1.0
+8,H2YPRO,GBR,A0_ELC,,2020,2030,31.54
 9,TPETCR,GBR,A0_TRA,,2020,2030,451.91
 10,TDIECR,GBR,A0_TRA,,2020,2030,176.58
 11,TELCCR,GBR,A0_TRA,,2020,2030,20.99
 12,THYBCR,GBR,A0_TRA,,2020,2030,15.0
 13,RGASBR,GBR,A0_RES,,2020,2035,2900.0
 14,RELCHP,GBR,A0_RES,,2020,2035,399.98
-15,THYBCR,GBR,A0_TRA,,2030,2040,777.3007440837425
+15,TDIECR,GBR,A0_TRA,,2030,2040,777.3007440837425
 16,RBIOBL,GBR,A0_RES,,2030,,355.83840587648046
-17,GASCGT,GBR,A0_ELC,,2030,,19.242225052307102
-18,H2YPRO,GBR,A0_ELC,,2030,,30.278400121113602
-19,OILRF2,GBR,A0_REF,,2030,,756.7022737069626
-20,BIOPLL,GBR,A0_BPL,,2030,,427.00608705177655
-21,BIOPRO,GBR,A0_BPD,,2030,,448.35639140436535
-22,THYBCR,GBR,A0_TRA,,2040,,912.8939641298439
-23,RBIOBL,GBR,A0_RES,,2040,,3655.8189696
-24,GASCGT,GBR,A0_ELC,,2040,,0.8124316982834766
-25,H2YPRO,GBR,A0_ELC,,2040,,19.235689279503628
-26,BIOPLL,GBR,A0_BPL,,2040,,2167.9571005431867
-27,BIOPRO,GBR,A0_BPD,,2040,,2276.354955570347
+17,OILREF,GBR,A0_REF,,2030,2040,3363.1212161390777
+18,BIOPLL,GBR,A0_BPL,,2030,,427.00608705177655
+19,OAGRSV,GBR,A0_OAG,,2030,2040,2269.3348308645695
+20,BIOPRO,GBR,A0_BPD,,2030,,448.35639140436535
+21,THYBCR,GBR,A0_TRA,,2040,,912.8939641298439
+22,RBIOBL,GBR,A0_RES,,2040,,3655.8189696
+23,GASCGT,GBR,A0_ELC,,2040,,20.92678121560944
+24,OILRF2,GBR,A0_REF,,2040,,888.7022733069632
+25,BIOPLL,GBR,A0_BPL,,2040,,2167.9571005431867
+26,BIOPRO,GBR,A0_BPD,,2040,,2276.354955570347