Apply suggestions

Author: tsmbland

src/cli.rs

@@ -1,7 +1,7 @@
 //! The command line interface for the simulation.
+use crate::graph::save_commodity_graphs_for_model;
 use crate::input::{load_commodity_graphs, load_model};
 use crate::log;
-use crate::output::graph::save_commodity_graphs_for_model;
 use crate::output::{create_output_directory, get_graphs_dir, get_output_dir};
 use crate::settings::Settings;
 use ::log::{info, warn};
@@ -207,17 +207,12 @@ pub fn handle_graph_command(
     settings: Option<Settings>,
 ) -> Result<()> {
     // Load program settings, if not provided
-    let mut settings = if let Some(settings) = settings {
+    let settings = if let Some(settings) = settings {
         settings
     } else {
         Settings::load().context("Failed to load settings.")?
     };
 
-    // These settings can be overridden by command-line arguments
-    if opts.overwrite {
-        settings.overwrite = true;
-    }
-
     // Get path to output folder
     let pathbuf: PathBuf;
     let output_path = if let Some(p) = opts.output_dir.as_deref() {
@@ -246,7 +241,7 @@ pub fn handle_graph_command(
     // Load commodity flow graphs and save to file
     let commodity_graphs = load_commodity_graphs(model_path).context("Failed to build graphs.")?;
     save_commodity_graphs_for_model(&commodity_graphs, output_path)?;
-    info!("Graphs saved to file");
+    info!("Graphs saved to: {}", output_path.display());
 
     Ok(())
 }

src/graph.rs

@@ -9,9 +9,13 @@ use indexmap::IndexSet;
 use itertools::{Itertools, iproduct};
 use petgraph::Directed;
 use petgraph::algo::toposort;
+use petgraph::dot::Dot;
 use petgraph::graph::Graph;
 use std::collections::HashMap;
 use std::fmt::Display;
+use std::fs::File;
+use std::io::Write as IoWrite;
+use std::path::Path;
 use strum::IntoEnumIterator;
 
 /// A graph of commodity flows for a given region and year
@@ -127,7 +131,7 @@ fn create_commodities_graph_for_region_year(
     graph
 }
 
-/// Prepares a graph for validation with `validate_commodities_graph`.
+/// Prepares a graph for validation with [`validate_commodities_graph`].
 ///
 /// It takes a base graph produced by `create_commodities_graph_for_region_year`, and modifies it to
 /// account for process availabilities and commodity demands within the given time slice selection,
@@ -205,7 +209,7 @@ fn prepare_commodities_graph_for_validation(
 /// The validation is only performed for commodities with the specified time slice level. For full
 /// validation of all commodities in the model, we therefore need to run this function for all time
 /// slice selections at all time slice levels. This is handled by
-/// `validate_commodity_graphs_for_model`.
+/// [`validate_commodity_graphs_for_model`].
 fn validate_commodities_graph(
     graph: &CommoditiesGraph,
     commodities: &CommodityMap,
@@ -409,6 +413,21 @@ 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 {
+        let dot = Dot::new(&graph);
+        let mut file = File::create(output_path.join(format!("{region_id}_{year}.dot")))?;
+        write!(file, "{dot}")?;
+    }
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/output.rs

@@ -17,7 +17,6 @@ use std::fs;
 use std::fs::File;
 use std::path::{Path, PathBuf};
 
-pub mod graph;
 pub mod metadata;
 use metadata::write_metadata;
 

src/output/graph.rs

@@ -21,12 +21,14 @@ fn test_handle_graph_command() {
 
     // Save results to non-existent directory to check that directory creation works
     let tempdir = tempdir().unwrap();
-    let output_dir = tempdir.path().join("results");
+    let output_dir = tempdir.path().join("graphs");
     let opts = GraphOpts {
-        output_dir: Some(output_dir),
+        output_dir: Some(output_dir.clone()),
         overwrite: false,
     };
     handle_graph_command(&get_model_dir(), &opts, Some(Settings::default())).unwrap();
-
     assert!(is_logger_initialised());
+
+    // Check that at least one DOT file was created
+    assert!(output_dir.join("GBR_2020.dot").exists());
 }