Merge branch 'main' into topo_sort_cycles

tsmbland · web-flow · commit 1b5c6ef8462e · 2025-10-28T11:00:28.000Z
diff --git a/.github/workflows/cargo-test.yml b/.github/workflows/cargo-test.yml
@@ -30,7 +30,7 @@ jobs:
           cargo test --verbose --no-fail-fast
 
       # Upload regression test results for analysis
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v5
         if: "!cancelled()"
         with:
           name: muse2_test_results_${{ matrix.os }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -48,7 +48,7 @@ jobs:
           cp target/release/muse2${{ matrix.exe_suffix }} muse2
           cp LICENSE muse2/LICENCE.txt
           cp assets/readme/readme_${{ matrix.osname }}.txt muse2/README.txt
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v5
         if: ${{ github.event_name != 'release' }}
         with:
           name: muse2_${{ matrix.osname }}
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -24,7 +24,7 @@ toml = "0.9.8"
 unicase = "2.8.1"
 fern = {version = "0.7.1", features = ["chrono", "colored"]}
 chrono = "0.4"
-clap = {version = "4.5.49", features = ["cargo", "derive"]}
+clap = {version = "4.5.50", features = ["cargo", "derive"]}
 include_dir = "0.7.4"
 highs = "1.12.0"
 indexmap = "2.12.0"
diff --git a/docs/glossary.md b/docs/glossary.md
@@ -16,7 +16,7 @@ becomes an *Asset* that they own and operate. An *Asset* is an instance of a *Pr
 specific capacity, and a decommissioning year. A set of *Assets* must exist in the base year
 sufficient to serve base year demands (i.e. a calibrated base year, based on user input data).
 
-**Availability:** The maximum, minimum or fixed percentage of maximum output (or input) that an
+**Availability:** The maximum, minimum or fixed percentage of maximum output (or input) that a
 *Process* delivers over a period. The time period could be a single time slice, a season, or a year.
 
 **Base Year:** The starting year of a model run. The base year is typically calibrated to known
diff --git a/docs/templates/input_files.md.jinja b/docs/templates/input_files.md.jinja
@@ -6,6 +6,7 @@
 <!-- markdownlint-disable MD033 -->
 
 This file contains information about the file formats for MUSE2 input files.
+It is not required to supply every input file - empty files can be omitted.
 
 {{ toml_info }}
 
diff --git a/examples/missing_commodity/agent_search_space.csv b/examples/missing_commodity/agent_search_space.csv
diff --git a/examples/missing_commodity/process_availabilities.csv b/examples/missing_commodity/process_availabilities.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,time_slice,limit_type,value
+process_id,regions,commission_years,time_slice,limit_type,value
 GASDRV,all,all,annual,up,0.9
 GASPRC,all,all,annual,up,0.9
 BIOPRO,all,all,annual,up,1.0
diff --git a/examples/missing_commodity/process_flows.csv b/examples/missing_commodity/process_flows.csv
@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,coeff,type,cost
+process_id,commodity_id,regions,commission_years,coeff,type,cost
 GASDRV,GASPRD,all,all,1.0,fixed,
 GASPRC,GASPRD,all,all,-1.05,fixed,
 GASPRC,GASNAT,all,all,1.0,fixed,
diff --git a/examples/missing_commodity/process_parameters.csv b/examples/missing_commodity/process_parameters.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
+process_id,regions,commission_years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
 GASDRV,all,all,10.0,0.3,2.0,25,0.1
 GASPRC,all,all,7.0,0.21,0.5,25,0.1
 BIOPRO,all,all,1.0,0.2,0.25,20,0.09
diff --git a/examples/muse1_default/agent_cost_limits.csv b/examples/muse1_default/agent_cost_limits.csv
diff --git a/examples/muse1_default/agent_search_space.csv b/examples/muse1_default/agent_search_space.csv
diff --git a/examples/muse1_default/process_availabilities.csv b/examples/muse1_default/process_availabilities.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,time_slice,limit_type,value
+process_id,regions,commission_years,time_slice,limit_type,value
 gassupply1,R1,all,annual,up,0.9
 gasCCGT,R1,all,annual,up,0.9
 windturbine,R1,all,annual,up,0.4
diff --git a/examples/muse1_default/process_flows.csv b/examples/muse1_default/process_flows.csv
@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,coeff,type,cost
+process_id,commodity_id,regions,commission_years,coeff,type,cost
 gassupply1,gas,R1,all,1,fixed,
 gasCCGT,gas,R1,all,-1.67,fixed,
 gasCCGT,electricity,R1,all,1,fixed,
diff --git a/examples/muse1_default/process_parameters.csv b/examples/muse1_default/process_parameters.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
+process_id,regions,commission_years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
 gassupply1,R1,all,0,0,2.55,60,0.1
 gasCCGT,R1,all,23.78234399,0,0,60,0.1
 windturbine,R1,all,36.30771182,0,0,60,0.1
diff --git a/examples/simple/agent_search_space.csv b/examples/simple/agent_search_space.csv
diff --git a/examples/simple/process_availabilities.csv b/examples/simple/process_availabilities.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,time_slice,limit_type,value
+process_id,regions,commission_years,time_slice,limit_type,value
 GASDRV,all,all,annual,up,0.9
 GASPRC,all,all,annual,up,0.9
 GASCGT,all,all,annual,up,0.9
diff --git a/examples/simple/process_flows.csv b/examples/simple/process_flows.csv
@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,coeff,type,cost
+process_id,commodity_id,regions,commission_years,coeff,type,cost
 GASDRV,GASPRD,all,all,1.0,fixed,
 GASPRC,GASPRD,all,all,-1.05,fixed,
 GASPRC,GASNAT,all,all,1.0,fixed,
diff --git a/examples/simple/process_parameters.csv b/examples/simple/process_parameters.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
+process_id,regions,commission_years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
 GASDRV,all,all,10.0,0.3,2.0,25,0.1
 GASPRC,all,all,7.0,0.21,0.5,25,0.1
 WNDFRM,all,all,1000.0,30.0,0.4,25,0.1
diff --git a/examples/two_outputs/agent_search_space.csv b/examples/two_outputs/agent_search_space.csv
diff --git a/examples/two_outputs/process_availabilities.csv b/examples/two_outputs/process_availabilities.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,time_slice,limit_type,value
+process_id,regions,commission_years,time_slice,limit_type,value
 GASDRV,all,all,annual,up,0.9
 OAGRSV,all,all,annual,up,0.9
 GASPRC,all,all,annual,up,0.9
diff --git a/examples/two_outputs/process_flows.csv b/examples/two_outputs/process_flows.csv
@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,coeff,type,cost
+process_id,commodity_id,regions,commission_years,coeff,type,cost
 GASDRV,GASPRD,all,all,1,fixed,
 OAGRSV,OILCRD,all,all,1,fixed,
 OAGRSV,GASPRD,all,all,0.1,fixed,
diff --git a/examples/two_outputs/process_parameters.csv b/examples/two_outputs/process_parameters.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
+process_id,regions,commission_years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
 GASDRV,GBR,all,10,0.3,2,25,0.1
 OAGRSV,GBR,all,15,0.45,3,25,0.1
 GASPRC,GBR,all,7,0.21,0.5,25,0.1
diff --git a/examples/two_regions/agent_cost_limits.csv b/examples/two_regions/agent_cost_limits.csv
diff --git a/examples/two_regions/agent_search_space.csv b/examples/two_regions/agent_search_space.csv
diff --git a/examples/two_regions/process_availabilities.csv b/examples/two_regions/process_availabilities.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,time_slice,limit_type,value
+process_id,regions,commission_years,time_slice,limit_type,value
 gassupply1,R1;R2,all,annual,up,0.9
 gasCCGT,R1;R2,all,annual,up,0.9
 windturbine,R1;R2,all,annual,up,0.4
diff --git a/examples/two_regions/process_flows.csv b/examples/two_regions/process_flows.csv
@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,coeff
+process_id,commodity_id,regions,commission_years,coeff
 gassupply1,gas,R1;R2,all,1
 gasCCGT,gas,R1;R2,all,-1.67
 gasCCGT,electricity,R1;R2,all,1
diff --git a/examples/two_regions/process_parameters.csv b/examples/two_regions/process_parameters.csv
@@ -1,4 +1,4 @@
-process_id,regions,years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
+process_id,regions,commission_years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate
 gassupply1,R1;R2,all,0,0,2.55,60,0.1
 gasCCGT,R1;R2,all,23.78234399,0,0,60,0.1
 windturbine,R1;R2,all,36.30771182,0,0,60,0.1
diff --git a/src/graph.rs b/src/graph.rs
@@ -198,11 +198,10 @@ fn prepare_commodities_graph_for_validation(
     // NOTE: we only do this for commodities with the same time_slice_level as the selection
     let demand_node_index = filtered_graph.add_node(GraphNode::Demand);
     for (commodity_id, commodity) in commodities {
-        if time_slice_selection.level() == commodity.time_slice_level
-            && commodity
-                .demand
-                .get(&(region_id.clone(), year, time_slice_selection.clone()))
-                .is_some_and(|&v| v > Flow(0.0))
+        if commodity
+            .demand
+            .get(&(region_id.clone(), year, time_slice_selection.clone()))
+            .is_some_and(|&v| v > Flow(0.0))
         {
             let commodity_node = GraphNode::Commodity(commodity_id.clone());
             let commodity_node_index = filtered_graph
diff --git a/src/input.rs b/src/input.rs
@@ -57,6 +57,10 @@ pub fn read_csv<'a, T: DeserializeOwned + 'a>(
 pub fn read_csv_optional<'a, T: DeserializeOwned + 'a>(
     file_path: &'a Path,
 ) -> Result<impl Iterator<Item = T> + 'a> {
+    if !file_path.exists() {
+        return Ok(Vec::new().into_iter());
+    }
+
     let vec = read_csv_internal(file_path)?;
     Ok(vec.into_iter())
 }
@@ -350,6 +354,19 @@ mod tests {
                 .next()
                 .is_none()
         );
+
+        // Missing file
+        let dir = tempdir().unwrap();
+        let file_path = dir.path().join("a_missing_file.csv");
+        assert!(!file_path.exists());
+        assert!(read_csv::<Record>(&file_path).is_err());
+        // optional csv's should return empty iterator
+        assert!(
+            read_csv_optional::<Record>(&file_path)
+                .unwrap()
+                .next()
+                .is_none()
+        );
     }
 
     #[test]
diff --git a/src/input/commodity/demand.rs b/src/input/commodity/demand.rs
@@ -135,8 +135,8 @@ where
         );
 
         ensure!(
-            demand.demand.is_normal() && demand.demand > Flow(0.0),
-            "Demand must be a valid number greater than zero"
+            demand.demand.is_finite() && demand.demand >= Flow(0.0),
+            "Demand must be a finite number greater than or equal to zero"
         );
 
         ensure!(
@@ -270,6 +270,12 @@ mod tests {
                 commodity_id: "commodity1".to_string(),
                 demand: Flow(11.0),
             },
+            Demand {
+                year: 2020,
+                region_id: "Spain".to_string(),
+                commodity_id: "commodity3".to_string(),
+                demand: Flow(0.0),
+            },
         ];
         assert_error!(
             read_demand_from_iter(demand.into_iter(), &svd_commodities, &region_ids, &[2020]),
@@ -334,7 +340,6 @@ mod tests {
 
     #[rstest]
     #[case(-1.0)]
-    #[case(0.0)]
     #[case(f64::NAN)]
     #[case(f64::NEG_INFINITY)]
     #[case(f64::INFINITY)]
@@ -353,7 +358,7 @@ mod tests {
         }];
         assert_error!(
             read_demand_from_iter(demand.into_iter(), &svd_commodities, &region_ids, &[2020],),
-            "Demand must be a valid number greater than zero"
+            "Demand must be a finite number greater than or equal to zero"
         );
     }
 
diff --git a/src/input/commodity/demand_slicing.rs b/src/input/commodity/demand_slicing.rs
@@ -1,7 +1,5 @@
 //! Demand slicing determines how annual demand is distributed across the year.
-use super::super::{
-    check_values_sum_to_one_approx, deserialise_proportion_nonzero, input_err_msg, read_csv,
-};
+use super::super::{check_values_sum_to_one_approx, input_err_msg, read_csv};
 use crate::commodity::CommodityID;
 use crate::id::IDCollection;
 use crate::input::commodity::demand::BorrowedCommodityMap;
@@ -22,7 +20,6 @@ struct DemandSlice {
     commodity_id: String,
     region_id: String,
     time_slice: String,
-    #[serde(deserialize_with = "deserialise_proportion_nonzero")]
     fraction: Dimensionless,
 }
 
diff --git a/src/input/process/availability.rs b/src/input/process/availability.rs
@@ -21,7 +21,7 @@ const PROCESS_AVAILABILITIES_FILE_NAME: &str = "process_availabilities.csv";
 struct ProcessAvailabilityRaw {
     process_id: String,
     regions: String,
-    years: String,
+    commission_years: String,
     time_slice: String,
     limit_type: LimitType,
     value: Dimensionless,
@@ -138,9 +138,10 @@ where
 
         // Get years
         let process_years = &process.years;
-        let record_years = parse_year_str(&record.years, process_years).with_context(|| {
-            format!("Invalid year for process {id}. Valid years are {process_years:?}")
-        })?;
+        let record_years =
+            parse_year_str(&record.commission_years, process_years).with_context(|| {
+                format!("Invalid year for process {id}. Valid years are {process_years:?}")
+            })?;
 
         // Get time slices
         let ts_selection = time_slice_info.get_selection(&record.time_slice)?;
@@ -261,7 +262,7 @@ mod tests {
         ProcessAvailabilityRaw {
             process_id: "process".into(),
             regions: "region".into(),
-            years: "2010".into(),
+            commission_years: "2010".into(),
             time_slice: "day".into(),
             limit_type,
             value,
diff --git a/src/input/process/flow.rs b/src/input/process/flow.rs
diff --git a/src/input/process/parameter.rs b/src/input/process/parameter.rs
diff --git a/src/simulation/investment.rs b/src/simulation/investment.rs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-process_id,regions,years,time_slice,limit_type,value`
	`1`	`+process_id,regions,commission_years,time_slice,limit_type,value`
`2`	`2`	`GASDRV,all,all,annual,up,0.9`
`3`	`3`	`GASPRC,all,all,annual,up,0.9`
`4`	`4`	`BIOPRO,all,all,annual,up,1.0`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-process_id,commodity_id,regions,years,coeff,type,cost`
	`1`	`+process_id,commodity_id,regions,commission_years,coeff,type,cost`
`2`	`2`	`GASDRV,GASPRD,all,all,1.0,fixed,`
`3`	`3`	`GASPRC,GASPRD,all,all,-1.05,fixed,`
`4`	`4`	`GASPRC,GASNAT,all,all,1.0,fixed,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-process_id,regions,years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate`
	`1`	`+process_id,regions,commission_years,capital_cost,fixed_operating_cost,variable_operating_cost,lifetime,discount_rate`
`2`	`2`	`GASDRV,all,all,10.0,0.3,2.0,25,0.1`
`3`	`3`	`GASPRC,all,all,7.0,0.21,0.5,25,0.1`
`4`	`4`	`BIOPRO,all,all,1.0,0.2,0.25,20,0.09`