Add units column to commodities input file

examples/circularity/commodities.csv

@@ -1,13 +1,13 @@
-id,description,type,time_slice_level
-OILCRD,Crude oil,sed,season
-GASPRD,Gas produced,sed,season
-GASOLI,Gasoline,sed,season
-DIESEL,Diesel,sed,season
-GASNAT,Natural gas,sed,season
-ELCTRI,Electricity,sed,daynight
-H2YPRD,Hydrogen,sed,season
-TPASKM,Passenger kms,svd,daynight
-RSHEAT,Residential heating,svd,daynight
-CO2EMT,CO2 emitted,oth,annual
-BIOPRD,Biomass produced,sed,season
-BIOPEL,Biomass pellets,sed,season
+id,description,type,time_slice_level,units
+OILCRD,Crude oil,sed,season,NOUNIT
+GASPRD,Gas produced,sed,season,NOUNIT
+GASOLI,Gasoline,sed,season,NOUNIT
+DIESEL,Diesel,sed,season,NOUNIT
+GASNAT,Natural gas,sed,season,NOUNIT
+ELCTRI,Electricity,sed,daynight,NOUNIT
+H2YPRD,Hydrogen,sed,season,NOUNIT
+TPASKM,Passenger kms,svd,daynight,NOUNIT
+RSHEAT,Residential heating,svd,daynight,NOUNIT
+CO2EMT,CO2 emitted,oth,annual,NOUNIT
+BIOPRD,Biomass produced,sed,season,NOUNIT
+BIOPEL,Biomass pellets,sed,season,NOUNIT

examples/missing_commodity/commodities.csv

@@ -1,8 +1,8 @@
-id,description,type,time_slice_level
-GASPRD,Gas produced,sed,season
-GASNAT,Natural gas,sed,season
-BIOPRD,Biomass produced,sed,season
-BIOPEL,Biomass pellets,sed,season
-ELCTRI,Electricity,sed,daynight
-RSHEAT,Residential heating,svd,daynight
-CO2EMT,CO2 emitted,oth,annual
+id,description,type,time_slice_level,units
+GASPRD,Gas produced,sed,season,NOUNIT
+GASNAT,Natural gas,sed,season,NOUNIT
+BIOPRD,Biomass produced,sed,season,NOUNIT
+BIOPEL,Biomass pellets,sed,season,NOUNIT
+ELCTRI,Electricity,sed,daynight,NOUNIT
+RSHEAT,Residential heating,svd,daynight,NOUNIT
+CO2EMT,CO2 emitted,oth,annual,NOUNIT

examples/muse1_default/commodities.csv

@@ -1,6 +1,6 @@
-id,description,type,time_slice_level
-electricity,Electricity,sed,daynight
-gas,Gas,sed,daynight
-heat,Heat,svd,daynight
-wind,Wind,oth,daynight
-CO2f,Carbon dioxide,oth,daynight
+id,description,type,time_slice_level,units
+electricity,Electricity,sed,daynight,PJ
+gas,Gas,sed,daynight,PJ
+heat,Heat,svd,daynight,PJ
+wind,Wind,oth,daynight,PJ
+CO2f,Carbon dioxide,oth,daynight,kt

examples/simple/commodities.csv

@@ -1,6 +1,6 @@
-id,description,type,time_slice_level
-GASPRD,Gas produced,sed,season
-GASNAT,Natural gas,sed,season
-ELCTRI,Electricity,sed,daynight
-RSHEAT,Residential heating,svd,daynight
-CO2EMT,CO2 emitted,oth,annual
+id,description,type,time_slice_level,units
+GASPRD,Gas produced,sed,season,NOUNIT
+GASNAT,Natural gas,sed,season,NOUNIT
+ELCTRI,Electricity,sed,daynight,NOUNIT
+RSHEAT,Residential heating,svd,daynight,NOUNIT
+CO2EMT,CO2 emitted,oth,annual,NOUNIT

examples/two_outputs/commodities.csv

@@ -1,12 +1,12 @@
-id,description,type,time_slice_level
-OILCRD,Crude oil,sed,season
-GASPRD,Gas produced,sed,season
-GASOLI,Gasoline,sed,season
-DIESEL,Diesel,sed,season
-GASNAT,Natural gas,sed,season
-ELCTRI,Electricity,sed,daynight
-TPASKM,Passenger kms,svd,daynight
-RSHEAT,Residential heating,svd,daynight
-CO2EMT,CO2 emitted,oth,annual
-BIOPRD,Biomass produced,sed,season
-BIOPEL,Biomass pellets,sed,season
+id,description,type,time_slice_level,units
+OILCRD,Crude oil,sed,season,NOUNIT
+GASPRD,Gas produced,sed,season,NOUNIT
+GASOLI,Gasoline,sed,season,NOUNIT
+DIESEL,Diesel,sed,season,NOUNIT
+GASNAT,Natural gas,sed,season,NOUNIT
+ELCTRI,Electricity,sed,daynight,NOUNIT
+TPASKM,Passenger kms,svd,daynight,NOUNIT
+RSHEAT,Residential heating,svd,daynight,NOUNIT
+CO2EMT,CO2 emitted,oth,annual,NOUNIT
+BIOPRD,Biomass produced,sed,season,NOUNIT
+BIOPEL,Biomass pellets,sed,season,NOUNIT

examples/two_regions/commodities.csv

@@ -1,6 +1,6 @@
-id,description,type,time_slice_level
-electricity,Electricity,sed,daynight
-gas,Gas,sed,daynight
-heat,Heat,svd,daynight
-wind,Wind,oth,daynight
-CO2f,Carbon dioxide,oth,daynight
+id,description,type,time_slice_level,units
+electricity,Electricity,sed,daynight,PJ
+gas,Gas,sed,daynight,PJ
+heat,Heat,svd,daynight,PJ
+wind,Wind,oth,daynight,PJ
+CO2f,Carbon dioxide,oth,daynight,kt

schemas/input/commodities.yaml

@@ -42,3 +42,11 @@ fields:
 
       If unspecified, the commodity will use the default pricing strategy according to the commodity
       type: `shadow` for `svd` and `sed` commodities, and `unpriced` for `oth` commodities.
+  - name: units
+    type: string
+    description: The units of measurement for this commodity
+    notes: |
+      This field is used for validation only and is not used for internal unit conversions. MUSE
+      will validate that all SED/SVD output flows from the same process have the same units,
+      as the annual fixed costs are distributed proportionally between outputs based on flow coefficients.
+      E.g. `Petajoules`, `Tonnes`.

src/commodity.rs

@@ -54,6 +54,9 @@ pub struct Commodity {
     /// `time_slice_level` field. E.g. if the `time_slice_level` is seasonal, then there will be
     /// keys representing each season (and not e.g. individual time slices).
     pub demand: DemandMap,
+    /// Units for this commodity represented as a string e.g Petajoules, Tonnes
+    /// This is only used for validation purposes.
+    pub units: String,
 }
 define_id_getter! {Commodity, CommodityID}
 

src/fixture.rs

@@ -150,6 +150,7 @@ pub fn svd_commodity() -> Commodity {
         levies_prod: CommodityLevyMap::new(),
         levies_cons: CommodityLevyMap::new(),
         demand: DemandMap::new(),
+        units: "PJ".into(),
     }
 }
 
@@ -164,6 +165,7 @@ pub fn sed_commodity() -> Commodity {
         levies_prod: CommodityLevyMap::new(),
         levies_cons: CommodityLevyMap::new(),
         demand: DemandMap::new(),
+        units: "PJ".into(),
     }
 }
 
@@ -178,6 +180,37 @@ pub fn other_commodity() -> Commodity {
         levies_prod: CommodityLevyMap::new(),
         levies_cons: CommodityLevyMap::new(),
         demand: DemandMap::new(),
+        units: "PJ".into(),
+    }
+}
+
+#[fixture]
+pub fn sed_commodity_pj() -> Commodity {
+    Commodity {
+        id: "sed_pj".into(),
+        description: "Test SED commodity (PJ)".into(),
+        kind: CommodityType::SupplyEqualsDemand,
+        time_slice_level: TimeSliceLevel::DayNight,
+        pricing_strategy: PricingStrategy::Shadow,
+        levies_prod: CommodityLevyMap::new(),
+        levies_cons: CommodityLevyMap::new(),
+        demand: DemandMap::new(),
+        units: "PJ".into(),
+    }
+}
+
+#[fixture]
+pub fn sed_commodity_tonnes() -> Commodity {
+    Commodity {
+        id: "sed_tonnes".into(),
+        description: "Test SED commodity (tonnes)".into(),
+        kind: CommodityType::SupplyEqualsDemand,
+        time_slice_level: TimeSliceLevel::DayNight,
+        pricing_strategy: PricingStrategy::Shadow,
+        levies_prod: CommodityLevyMap::new(),
+        levies_cons: CommodityLevyMap::new(),
+        demand: DemandMap::new(),
+        units: "tonnes".into(),
     }
 }
 
@@ -415,14 +448,14 @@ mod tests {
     #[test]
     fn patch_and_validate_simple_fail() {
         let patch = FilePatch::new("commodities.csv")
-            .with_deletion("RSHEAT,Residential heating,svd,daynight");
+            .with_deletion("RSHEAT,Residential heating,svd,daynight,NOUNIT");
         assert!(patch_and_validate_simple!(vec![patch]).is_err());
     }
 
     #[test]
     fn patch_and_run_simple_fail() {
         let patch = FilePatch::new("commodities.csv")
-            .with_deletion("RSHEAT,Residential heating,svd,daynight");
+            .with_deletion("RSHEAT,Residential heating,svd,daynight,NOUNIT");
         assert!(patch_and_run_simple!(vec![patch]).is_err());
     }
 }

src/input/agent/commodity_portion.rs

@@ -226,6 +226,7 @@ mod tests {
                 levies_prod: CommodityLevyMap::new(),
                 levies_cons: CommodityLevyMap::new(),
                 demand: DemandMap::new(),
+                units: "PJ".into(),
             }),
         )]);
 
@@ -269,6 +270,7 @@ mod tests {
                 levies_prod: CommodityLevyMap::new(),
                 levies_cons: CommodityLevyMap::new(),
                 demand: DemandMap::new(),
+                units: "PJ".into(),
             }),
         );
         assert!(

src/input/commodity.rs

@@ -30,6 +30,7 @@ struct CommodityRaw {
     pub kind: CommodityType,
     pub time_slice_level: TimeSliceLevel,
     pub pricing_strategy: Option<PricingStrategy>,
+    pub units: String,
 }
 
 /// Read commodity data from the specified model directory.
@@ -119,6 +120,7 @@ where
             levies_prod: CommodityLevyMap::default(),
             levies_cons: CommodityLevyMap::default(),
             demand: DemandMap::default(),
+            units: commodity_raw.units,
         };
 
         validate_commodity(&commodity)?;
@@ -200,6 +202,7 @@ mod tests {
             levies_prod: CommodityLevyMap::default(),
             levies_cons: CommodityLevyMap::default(),
             demand: DemandMap::default(),
+            units: "PJ".into(),
         }
     }