Merge pull request #571 from EnergySystemsModellingLab/output-dual-values-csv

Add option to write dual values to CSV files

Author: alexdewar

examples/simple/settings.toml

@@ -1,2 +1,3 @@
 # Modify this file if you want to change your program settings
 # log_level = "info"
+# debug_model = false

src/asset.rs

@@ -5,6 +5,7 @@ use crate::process::{Process, ProcessFlow, ProcessParameter};
 use crate::region::RegionID;
 use crate::time_slice::TimeSliceID;
 use anyhow::{ensure, Context, Result};
+use indexmap::IndexMap;
 use std::collections::HashSet;
 use std::ops::RangeInclusive;
 use std::rc::Rc;
@@ -108,13 +109,22 @@ impl Asset {
         self.capacity * self.process_parameter.capacity_to_activity
     }
 
-    /// Iterate over the asset's flows
-    pub fn iter_flows(&self) -> impl Iterator<Item = &ProcessFlow> {
+    /// Get a specific process flow
+    pub fn get_flow(&self, commodity_id: &CommodityID) -> Option<&ProcessFlow> {
+        self.get_flows_map().get(commodity_id)
+    }
+
+    /// Get the process flows map for this asset
+    fn get_flows_map(&self) -> &IndexMap<CommodityID, ProcessFlow> {
         self.process
             .flows
             .get(&(self.region_id.clone(), self.commission_year))
             .unwrap()
-            .values()
+    }
+
+    /// Iterate over the asset's flows
+    pub fn iter_flows(&self) -> impl Iterator<Item = &ProcessFlow> {
+        self.get_flows_map().values()
     }
 
     /// Iterate over the asset's Primary Activity Commodity flows

src/commands.rs

@@ -36,6 +36,9 @@ pub enum Commands {
         /// Directory for output files
         #[arg(short, long)]
         output_dir: Option<PathBuf>,
+        /// Whether to write additional information to CSV files
+        #[arg(long)]
+        debug_model: bool,
     },
     /// Manage example models.
     Example {
@@ -64,13 +67,25 @@ pub enum ExampleSubcommands {
         /// Directory for output files
         #[arg(short, long)]
         output_dir: Option<PathBuf>,
+        /// Whether to write additional information to CSV files
+        #[arg(long)]
+        debug_model: bool,
     },
 }
 
 /// Handle the `run` command.
-pub fn handle_run_command(model_path: &Path, output_path: Option<&Path>) -> Result<()> {
+pub fn handle_run_command(
+    model_path: &Path,
+    output_path: Option<&Path>,
+    debug_model: bool,
+) -> Result<()> {
     // Load program settings
-    let settings = Settings::from_path(model_path).context("Failed to load settings.")?;
+    let mut settings = Settings::from_path(model_path).context("Failed to load settings.")?;
+
+    // This setting can be overridden by command-line argument
+    if debug_model {
+        settings.debug_model = true;
+    }
 
     // Create output folder
     let output_path = match output_path {
@@ -90,7 +105,7 @@ pub fn handle_run_command(model_path: &Path, output_path: Option<&Path>) -> Resu
         info!("Output data will be written to {}", output_path.display());
 
         // Run the simulation
-        crate::simulation::run(model, assets, &output_path)
+        crate::simulation::run(model, assets, &output_path, settings.debug_model)
     };
 
     // Once the logger is initialised, we can write fatal errors to log
@@ -142,9 +157,13 @@ fn extract_example(name: &str, new_path: &Path) -> Result<()> {
 }
 
 /// Handle the `example run` command.
-pub fn handle_example_run_command(name: &str, output_path: Option<&Path>) -> Result<()> {
+pub fn handle_example_run_command(
+    name: &str,
+    output_path: Option<&Path>,
+    debug_model: bool,
+) -> Result<()> {
     let temp_dir = TempDir::new().context("Failed to create temporary directory.")?;
     let model_path = temp_dir.path().join(name);
     extract_example(name, &model_path)?;
-    handle_run_command(&model_path, output_path)
+    handle_run_command(&model_path, output_path, debug_model)
 }

src/fixture.rs

@@ -1,9 +1,10 @@
 //! Fixtures for tests
 
 use crate::agent::{
-    Agent, AgentCommodityPortionsMap, AgentCostLimitsMap, AgentMap, AgentObjectiveMap,
+    Agent, AgentCommodityPortionsMap, AgentCostLimitsMap, AgentID, AgentMap, AgentObjectiveMap,
     AgentSearchSpaceMap, DecisionRule,
 };
+use crate::asset::{Asset, AssetPool};
 use crate::commodity::CommodityID;
 use crate::process::{
     Process, ProcessEnergyLimitsMap, ProcessFlowsMap, ProcessMap, ProcessParameter,
@@ -29,6 +30,11 @@ macro_rules! assert_error {
 }
 pub(crate) use assert_error;
 
+#[fixture]
+pub fn region_id() -> RegionID {
+    "GBR".into()
+}
+
 #[fixture]
 pub fn commodity_ids() -> HashSet<CommodityID> {
     iter::once("commodity1".into()).collect()
@@ -39,6 +45,32 @@ pub fn region_ids() -> HashSet<RegionID> {
     ["GBR".into(), "USA".into()].into_iter().collect()
 }
 
+#[fixture]
+pub fn agent_id() -> AgentID {
+    "agent1".into()
+}
+
+#[fixture]
+pub fn commodity_id() -> CommodityID {
+    "commodity1".into()
+}
+
+#[fixture]
+pub fn asset(process: Process) -> Asset {
+    let region_id: RegionID = "GBR".into();
+    let agent_id = "agent1".into();
+    let commission_year = 2015;
+    Asset::new(agent_id, process.into(), region_id, 2.0, commission_year).unwrap()
+}
+
+#[fixture]
+pub fn assets(asset: Asset) -> AssetPool {
+    let year = asset.commission_year;
+    let mut assets = AssetPool::new(iter::once(asset).collect());
+    assets.commission_new(year);
+    assets
+}
+
 #[fixture]
 pub fn process_parameter_map(region_ids: HashSet<RegionID>) -> ProcessParameterMap {
     let parameter = Rc::new(ProcessParameter {

src/main.rs

@@ -35,16 +35,19 @@ fn execute_cli_command(command: Option<Commands>) -> Result<()> {
         Commands::Run {
             model_dir,
             output_dir,
-        } => handle_run_command(&model_dir, output_dir.as_deref())?,
+            debug_model,
+        } => handle_run_command(&model_dir, output_dir.as_deref(), debug_model)?,
         Commands::Example { subcommand } => match subcommand {
             ExampleSubcommands::List => handle_example_list_command(),
             ExampleSubcommands::Extract {
                 name,
                 new_path: dest,
             } => handle_example_extract_command(&name, dest.as_deref())?,
-            ExampleSubcommands::Run { name, output_dir } => {
-                handle_example_run_command(&name, output_dir.as_deref())?
-            }
+            ExampleSubcommands::Run {
+                name,
+                output_dir,
+                debug_model,
+            } => handle_example_run_command(&name, output_dir.as_deref(), debug_model)?,
         },
     }