Tidy-ups

Author: tsmbland

src/cli.rs

@@ -27,7 +27,7 @@ struct Cli {
     markdown_help: bool,
 }
 
-/// Options for the run command
+/// Options for the `run` command
 #[derive(Args)]
 pub struct RunOpts {
     /// Directory for output files
@@ -41,6 +41,17 @@ pub struct RunOpts {
     pub debug_model: bool,
 }
 
+/// Options for the `graph` command
+#[derive(Args)]
+pub struct GraphOpts {
+    /// Directory for graph files
+    #[arg(short, long)]
+    pub output_dir: Option<PathBuf>,
+    /// Whether to overwrite the output directory if it already exists
+    #[arg(long)]
+    pub overwrite: bool,
+}
+
 /// The available commands.
 #[derive(Subcommand)]
 enum Commands {
@@ -64,12 +75,12 @@ enum Commands {
         model_dir: PathBuf,
     },
     /// Build and output commodity flow graphs for a model.
-    BuildCommodityGraphs {
+    Graph {
         /// The path to the model directory.
         model_dir: PathBuf,
-        /// Other options (uses the same settings as the `run` command)
+        /// Other options
         #[command(flatten)]
-        opts: RunOpts,
+        opts: GraphOpts,
     },
     /// Manage settings file.
     Settings {
@@ -86,9 +97,7 @@ 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, opts } => {
-                handle_build_commodity_graphs_command(&model_dir, &opts, None)
-            }
+            Self::Graph { model_dir, opts } => handle_graph_command(&model_dir, &opts, None),
             Self::Settings { subcommand } => subcommand.execute(),
         }
     }
@@ -191,10 +200,10 @@ 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(
+/// Handle the `graph` command.
+pub fn handle_graph_command(
     model_path: &Path,
-    opts: &RunOpts,
+    opts: &GraphOpts,
     settings: Option<Settings>,
 ) -> Result<()> {
     // Load program settings, if not provided
@@ -205,9 +214,6 @@ pub fn handle_build_commodity_graphs_command(
     };
 
     // These settings can be overridden by command-line arguments
-    if opts.debug_model {
-        settings.debug_model = true;
-    }
     if opts.overwrite {
         settings.overwrite = true;
     }
@@ -224,24 +230,23 @@ pub fn handle_build_commodity_graphs_command(
     let overwrite =
         create_output_directory(output_path, settings.overwrite).with_context(|| {
             format!(
-                "Failed to create commodity flow graphs directory: {}",
+                "Failed to create graphs directory: {}",
                 output_path.display()
             )
         })?;
 
-    // Initialise program logger (we won't save log files when running this command
+    // Initialise program logger (we won't save log files when running this command)
     log::init(&settings.log_level, None).context("Failed to initialise logging.")?;
 
     // NB: We have to wait until the logger is initialised to display this warning
     if overwrite {
-        warn!("Commodity flow graphs directory will be overwritten");
+        warn!("Graphs directory will be overwritten");
     }
 
     // Load commodity flow graphs and save to file
-    let commodity_graphs =
-        load_commodity_graphs(model_path).context("Failed to build commodity flow graphs.")?;
+    let commodity_graphs = load_commodity_graphs(model_path).context("Failed to build graphs.")?;
     save_commodity_graphs_for_model(&commodity_graphs, output_path)?;
-    info!("Commodity flow graphs saved to file");
+    info!("Graphs saved to file");
 
     Ok(())
 }

src/input.rs

@@ -243,13 +243,8 @@ pub fn load_model<P: AsRef<Path>>(model_dir: P) -> Result<(Model, AssetPool)> {
 
 /// Load commodity flow graphs for a model.
 ///
-/// This begins by reading time slice, region, year, commodity and process data which is necessary
-/// to build the graphs. Other model data (agents and assets) that is not necessary for graph
-/// building is not read.
-///
-/// Once data is loaded (and assuming the validation checks for this data pass), this will create a
-/// graph of commodity flows for each region and year, where nodes are commodities and edges are
-/// processes.
+/// Loads necessary input data and creates a graph of commodity flows for each region and year,
+/// where nodes are commodities and edges are processes.
 ///
 /// Graphs validation is NOT performed. This ensures that graphs can be generated even when
 /// validation would fail, which may be helpful for debugging.

src/output.rs

@@ -71,19 +71,14 @@ pub fn get_output_dir(model_dir: &Path) -> Result<PathBuf> {
 
 /// Get the default output directory for commodity flow graphs for the model
 pub fn get_graphs_dir(model_dir: &Path) -> Result<PathBuf> {
-    // Get the model name from the dir path. This ends up being convoluted because we need to check
-    // for all possible errors. Ugh.
     let model_dir = model_dir
         .canonicalize() // canonicalise in case the user has specified "."
         .context("Could not resolve path to model")?;
-
     let model_name = model_dir
         .file_name()
         .context("Model cannot be in root folder")?
         .to_str()
         .context("Invalid chars in model dir name")?;
-
-    // Construct path
     Ok([GRAPHS_DIRECTORY_ROOT, model_name].iter().collect())
 }