Add process_investment_constraints input file

schemas/input/process_investment_constraints.yaml

@@ -0,0 +1,29 @@
+$schema: https://specs.frictionlessdata.io/schemas/table-schema.json
+description: |
+  Constraints on the amount agents can invest in processes.
+
+notes: |
+  Not implemented yet! This file is reserved for future use.
+
+fields:
+  - name: process_id
+    type: string
+    description: The process to which this entry applies
+  - name: regions
+    type: string
+    description: The region(s) to which this entry applies
+    notes: |
+      One or more region IDs, separated by semicolons or the string `all`. Must be regions in which
+      the process operates.
+  - name: commission years
+    type: string
+    description: The milestone year(s) to which this entry applies
+    notes: One or more milestone years separated by semicolons, `all` to select all years or a year
+      range in the form 'start..end' to select all valid years within range, inclusive. Either 'start'
+      'end' or both can be omitted, which will set the corresponding limit to the minimum or maximum
+      valid year, respectively. Must be within the process's year range.
+  - name: addition limit
+    type: number
+    description: Yearly constraint on the amount agents can invest in the process
+    notes: The addition limit is allocated evenly between all agents using their proportion
+      of the processes primary commodity demand.

src/fixture.rs

@@ -7,8 +7,8 @@ use crate::agent::{
 use crate::asset::{Asset, AssetPool, AssetRef};
 use crate::commodity::{Commodity, CommodityID, CommodityLevyMap, CommodityType, DemandMap};
 use crate::process::{
-    ActivityLimits, Process, ProcessActivityLimitsMap, ProcessFlow, ProcessFlowsMap, ProcessMap,
-    ProcessParameter, ProcessParameterMap,
+    ActivityLimits, Process, ProcessActivityLimitsMap, ProcessFlow, ProcessFlowsMap,
+    ProcessInvestmentConstraintsMap, ProcessMap, ProcessParameter, ProcessParameterMap,
 };
 use crate::region::RegionID;
 use crate::simulation::investment::appraisal::{
@@ -173,6 +173,13 @@ pub fn process_activity_limits_map(
         .collect()
 }
 
+#[fixture]
+/// Create an empty set of ProcessInvestmentConstraints for a given region/year
+/// Returns a HashMap keyed by (RegionID, year) with empty Rc<ProcessInvestmentConstraint>
+pub fn process_investment_constraints() -> ProcessInvestmentConstraintsMap {
+    HashMap::new()
+}
+
 #[fixture]
 /// Create an empty set of ProcessFlows for a given region/year
 pub fn process_flows() -> Rc<IndexMap<CommodityID, ProcessFlow>> {
@@ -199,6 +206,7 @@ pub fn process(
     process_parameter_map: ProcessParameterMap,
     process_activity_limits_map: ProcessActivityLimitsMap,
     process_flows_map: ProcessFlowsMap,
+    process_investment_constraints: ProcessInvestmentConstraintsMap,
 ) -> Process {
     Process {
         id: "process1".into(),
@@ -210,6 +218,7 @@ pub fn process(
         regions: region_ids,
         primary_output: None,
         capacity_to_activity: ActivityPerCapacity(1.0),
+        investment_constraints: process_investment_constraints,
     }
 }
 

src/input/agent/search_space.rs

@@ -203,7 +203,8 @@ mod tests {
     use super::*;
     use crate::fixture::{agents, assert_error, region_ids};
     use crate::process::{
-        ProcessActivityLimitsMap, ProcessFlowsMap, ProcessID, ProcessParameterMap,
+        ProcessActivityLimitsMap, ProcessFlowsMap, ProcessID, ProcessInvestmentConstraintsMap,
+        ProcessParameterMap,
     };
     use crate::region::RegionID;
     use crate::units::ActivityPerCapacity;
@@ -226,6 +227,7 @@ mod tests {
                     regions: region_ids.clone(),
                     primary_output: None,
                     capacity_to_activity: ActivityPerCapacity(1.0),
+                    investment_constraints: ProcessInvestmentConstraintsMap::new(),
                 };
                 (id, process.into())
             })

src/input/process.rs

@@ -3,7 +3,8 @@ use super::{input_err_msg, read_csv};
 use crate::commodity::CommodityMap;
 use crate::id::IDCollection;
 use crate::process::{
-    Process, ProcessActivityLimitsMap, ProcessFlowsMap, ProcessID, ProcessMap, ProcessParameterMap,
+    Process, ProcessActivityLimitsMap, ProcessFlowsMap, ProcessID, ProcessInvestmentConstraintsMap,
+    ProcessMap, ProcessParameterMap,
 };
 use crate::region::{RegionID, parse_region_str};
 use crate::time_slice::TimeSliceInfo;
@@ -22,6 +23,8 @@ use flow::read_process_flows;
 mod parameter;
 use crate::id::define_id_getter;
 use parameter::read_process_parameters;
+mod investment_constraints;
+use investment_constraints::read_process_investment_constraints;
 
 const PROCESSES_FILE_NAME: &str = "processes.csv";
 
@@ -61,6 +64,8 @@ pub fn read_processes(
     let mut activity_limits = read_process_availabilities(model_dir, &processes, time_slice_info)?;
     let mut flows = read_process_flows(model_dir, &mut processes, commodities, milestone_years)?;
     let mut parameters = read_process_parameters(model_dir, &processes, milestone_years)?;
+    let mut investment_constraints =
+        read_process_investment_constraints(model_dir, &processes, milestone_years)?;
 
     // Add data to Process objects
     for (id, process) in &mut processes {
@@ -71,6 +76,7 @@ pub fn read_processes(
         process.activity_limits = activity_limits.remove(id).unwrap();
         process.flows = flows.remove(id).unwrap();
         process.parameters = parameters.remove(id).unwrap();
+        process.investment_constraints = investment_constraints.remove(id).unwrap_or_default();
     }
 
     Ok(processes)
@@ -156,6 +162,7 @@ where
             regions,
             primary_output,
             capacity_to_activity,
+            investment_constraints: ProcessInvestmentConstraintsMap::new(),
         };
 
         ensure!(