Include information about program run in metadata

Author: alexdewar

src/output.rs

@@ -236,9 +236,10 @@ impl DataWriter {
     /// # Arguments
     ///
     /// * `output_path` - Folder where files will be saved
+    /// * `model_path` - Path to input model
     /// * `save_debug_info` - Whether to include extra CSV files for debugging model
-    pub fn create(output_path: &Path, save_debug_info: bool) -> Result<Self> {
-        write_metadata(output_path).context("Failed to save metadata")?;
+    pub fn create(output_path: &Path, model_path: &Path, save_debug_info: bool) -> Result<Self> {
+        write_metadata(output_path, model_path).context("Failed to save metadata")?;
 
         let new_writer = |file_name| {
             let file_path = output_path.join(file_name);
@@ -345,7 +346,7 @@ mod tests {
 
         // Write an asset
         {
-            let mut writer = DataWriter::create(dir.path(), false).unwrap();
+            let mut writer = DataWriter::create(dir.path(), dir.path(), false).unwrap();
             writer.write_assets(milestone_year, assets.iter()).unwrap();
             writer.flush().unwrap();
         }
@@ -372,7 +373,7 @@ mod tests {
         // Write a flow
         let dir = tempdir().unwrap();
         {
-            let mut writer = DataWriter::create(dir.path(), false).unwrap();
+            let mut writer = DataWriter::create(dir.path(), dir.path(), false).unwrap();
             writer.write_flows(milestone_year, &flow_map).unwrap();
             writer.flush().unwrap();
         }
@@ -403,7 +404,7 @@ mod tests {
 
         // Write a price
         {
-            let mut writer = DataWriter::create(dir.path(), false).unwrap();
+            let mut writer = DataWriter::create(dir.path(), dir.path(), false).unwrap();
             writer.write_prices(milestone_year, &prices).unwrap();
             writer.flush().unwrap();
         }

src/output/metadata.rs

@@ -1,5 +1,6 @@
 //! Code for writing metadata to file
 use anyhow::Result;
+use chrono::prelude::*;
 use platform_info::{PlatformInfo, PlatformInfoAPI, UNameAPI};
 use serde::Serialize;
 use std::fs;
@@ -27,13 +28,32 @@ fn get_git_hash() -> String {
     }
 }
 
-#[derive(Serialize, Default)]
+#[derive(Serialize)]
 struct Metadata<'a> {
+    run: RunMetadata<'a>,
     program: ProgramMetadata<'a>,
     platform: PlatformMetadata,
 }
 
-/// Information about the version and build of MUSE
+/// Information about the model run
+#[derive(Serialize)]
+struct RunMetadata<'a> {
+    /// Path to the model which was run
+    model_path: &'a Path,
+    /// The date and time on which the run started
+    datetime: String,
+}
+
+impl<'a> RunMetadata<'a> {
+    fn new(model_path: &'a Path) -> Self {
+        let dt = Local::now();
+        Self {
+            model_path,
+            datetime: dt.to_rfc2822(),
+        }
+    }
+}
+
 #[derive(Serialize)]
 struct ProgramMetadata<'a> {
     /// The program name
@@ -94,8 +114,12 @@ impl Default for PlatformMetadata {
 }
 
 /// Write metadata to the specified output path in TOML format
-pub fn write_metadata(output_path: &Path) -> Result<()> {
-    let metadata = Metadata::default();
+pub fn write_metadata(output_path: &Path, model_path: &Path) -> Result<()> {
+    let metadata = Metadata {
+        run: RunMetadata::new(model_path),
+        program: ProgramMetadata::default(),
+        platform: PlatformMetadata::default(),
+    };
     let file_path = output_path.join(METADATA_FILE_NAME);
     fs::write(&file_path, toml::to_string(&metadata)?)?;
 

src/simulation.rs

@@ -27,7 +27,7 @@ pub fn run(
     output_path: &Path,
     debug_model: bool,
 ) -> Result<()> {
-    let mut writer = DataWriter::create(output_path, debug_model)?;
+    let mut writer = DataWriter::create(output_path, &model.model_path, debug_model)?;
 
     // Iterate over milestone years
     let mut year_iter = model.iter_years();