Add cli command (not yet implemented)

Author: tsmbland

src/cli.rs

@@ -1,4 +1,5 @@
 //! The command line interface for the simulation.
+use crate::graph::save_commodity_graphs_for_model;
 use crate::input::load_model;
 use crate::log;
 use crate::output::{create_output_directory, get_output_dir};
@@ -62,6 +63,13 @@ enum Commands {
         /// The path to the model directory.
         model_dir: PathBuf,
     },
+    /// Build and output commodity flow graphs for a model.
+    BuildCommodityGraphs {
+        /// The path to the model directory.
+        model_dir: PathBuf,
+        /// Output path
+        output_dir: PathBuf,
+    },
     /// Manage settings file.
     Settings {
         /// The subcommands for managing the settings file.
@@ -77,6 +85,10 @@ impl Commands {
             Self::Run { model_dir, opts } => handle_run_command(&model_dir, &opts, None),
             Self::Example { subcommand } => subcommand.execute(),
             Self::Validate { model_dir } => handle_validate_command(&model_dir, None),
+            Self::BuildCommodityGraphs {
+                model_dir,
+                output_dir,
+            } => handle_build_commodity_graphs_command(&model_dir, &output_dir, None),
             Self::Settings { subcommand } => subcommand.execute(),
         }
     }
@@ -178,3 +190,30 @@ pub fn handle_validate_command(model_path: &Path, settings: Option<Settings>) ->
 
     Ok(())
 }
+
+/// Handle the `build-commodity-graphs` command.
+pub fn handle_build_commodity_graphs_command(
+    model_path: &Path,
+    output_path: &Path,
+    settings: Option<Settings>,
+) -> Result<()> {
+    // Load program settings, if not provided
+    let settings = if let Some(settings) = settings {
+        settings
+    } else {
+        Settings::load().context("Failed to load settings.")?
+    };
+
+    // Initialise program logger (we won't save log files when running the validate command)
+    log::init(&settings.log_level, None).context("Failed to initialise logging.")?;
+
+    // Load/validate the model
+    let (model, _) = load_model(model_path).context("Failed to load model.")?;
+    info!("Loaded model from {}", model_path.display());
+
+    // Save commodity flow graphs to file
+    save_commodity_graphs_for_model(&model.commodity_graphs, output_path)?;
+    info!("Commodity flow graphs saved to file");
+
+    Ok(())
+}

src/graph.rs

@@ -12,6 +12,7 @@ use petgraph::algo::toposort;
 use petgraph::graph::Graph;
 use std::collections::HashMap;
 use std::fmt::Display;
+use std::path::Path;
 use strum::IntoEnumIterator;
 
 /// A graph of commodity flows for a given region and year
@@ -400,6 +401,19 @@ pub fn validate_commodity_graphs_for_model(
     Ok(commodity_order)
 }
 
+/// Saves commodity graphs to file
+///
+/// The graphs are saved as DOT files to the specified output path
+pub fn save_commodity_graphs_for_model(
+    commodity_graphs: &HashMap<(RegionID, u32), CommoditiesGraph>,
+    _output_path: &Path,
+) -> Result<()> {
+    for ((_region_id, _year), _graph) in commodity_graphs {
+        todo!()
+    }
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/input.rs

@@ -233,6 +233,7 @@ pub fn load_model<P: AsRef<Path>>(model_dir: P) -> Result<(Model, AssetPool)> {
         processes,
         time_slice_info,
         regions,
+        commodity_graphs,
         commodity_order,
     };
     Ok((model, AssetPool::new(assets)))

src/model.rs

@@ -1,6 +1,7 @@
 //! The model represents the static input data provided by the user.
 use crate::agent::AgentMap;
 use crate::commodity::{CommodityID, CommodityMap};
+use crate::graph::CommoditiesGraph;
 use crate::process::ProcessMap;
 use crate::region::{RegionID, RegionMap};
 use crate::time_slice::TimeSliceInfo;
@@ -26,6 +27,8 @@ pub struct Model {
     pub time_slice_info: TimeSliceInfo,
     /// Regions for the simulation
     pub regions: RegionMap,
+    /// Commodity flow graphs for each region and year
+    pub commodity_graphs: HashMap<(RegionID, u32), CommoditiesGraph>,
     /// Commodity ordering for each region and year
     pub commodity_order: HashMap<(RegionID, u32), Vec<CommodityID>>,
 }