adding new from_github vehicle method

rust/fastsim-core/src/cycle.rs

@@ -726,6 +726,19 @@ impl SerdeAPI for RustCycle {
             ),
         }
     }
+
+    /// takes an object from a url and saves it in the fastsim data directory in a rust_objects folder
+    /// WARNING: if there is a file already in the data subdirectory with the same name, it will be replaced by the new file
+    fn to_cache<S: AsRef<str>>(url: S) {
+        let url = url.as_ref();
+        let url_parts: Vec<&str> = url.split("/").collect();
+        let file_name = url_parts.last().unwrap_or_else(||panic!("Could not determine file name/type."));
+        let data_subdirectory = create_project_subdir("cycles").unwrap_or_else(|_|panic!("Could not find or create Fastsim data subdirectory."));
+        let file_path = data_subdirectory.join(file_name);
+        // I believe this will overwrite any existing files with the same name -- is this preferable, or should we add
+        // a bool argument so user can determine whether the file should overwrite an existing file or not
+        download_file_from_url(url, &file_path);
+    }
 }
 
 impl TryFrom<HashMap<String, Vec<f64>>> for RustCycle {

rust/fastsim-core/src/imports.rs

@@ -13,3 +13,4 @@ pub(crate) use std::path::PathBuf;
 
 pub(crate) use crate::traits::*;
 pub(crate) use crate::utils::*;
+pub(crate) use crate::vehicle_utils::*;

rust/fastsim-core/src/lib.rs

@@ -29,6 +29,7 @@
 //! ```
 
 extern crate ndarray;
+extern crate tempfile;
 
 #[macro_use]
 pub mod macros;

rust/fastsim-core/src/traits.rs

@@ -1,5 +1,6 @@
 use crate::imports::*;
 use std::collections::HashMap;
+use tempfile::tempdir;
 
 pub trait SerdeAPI: Serialize + for<'a> Deserialize<'a> {
     const ACCEPTED_BYTE_FORMATS: &'static [&'static str] = &["yaml", "json", "bin"];
@@ -154,6 +155,44 @@ pub trait SerdeAPI: Serialize + for<'a> Deserialize<'a> {
     fn from_bincode(encoded: &[u8]) -> anyhow::Result<Self> {
         Ok(bincode::deserialize(encoded)?)
     }
+
+    /// instantiates an object from a url
+    fn from_url<S: AsRef<str>>(url: S) -> anyhow::Result<Self> {
+        let url = url.as_ref();
+        let temp_dir = tempdir()?;
+        let mut file_path = PathBuf::new();
+        // do these file types need to be specific to the object?
+        // TODO: either make funciton work for csv files, or remove from supported file list
+        if url.ends_with("yaml"){
+            let file_path = temp_dir.path().join("temporary_object.yaml");
+        } else if url.ends_with("csv"){
+            let file_path = temp_dir.path().join("temporary_object.csv");
+        } else if url.ends_with("json"){
+            let file_path = temp_dir.path().join("temporary_object.json");
+        } else {
+            bail!("Unsupported file type, must be a yaml, json, or csv file.");
+        }
+        download_file_from_url(url, &file_path);
+        // only works for json and yaml
+        // seems like I might also be able to use from_reader instead -- which one is preferable?
+        Self::from_file(file_path)
+    }
+
+    /// takes an object from a url and saves it in the fastsim data directory in a rust_objects folder
+    /// WARNING: if there is a file already in the data subdirectory with the same name, it will be replaced by the new file
+    /// to save to a folder other than rust_objects for a specific object type, override this default
+    /// implementation for the Rust object, and in the object-specific implementation, replace
+    /// "rust_objects" with your choice of folder name
+    fn to_cache<S: AsRef<str>>(url: S) {
+        let url = url.as_ref();
+        let url_parts: Vec<&str> = url.split("/").collect();
+        let file_name = url_parts.last().unwrap_or_else(||panic!("Could not determine file name/type."));
+        let data_subdirectory = create_project_subdir("rust_objects").unwrap_or_else(|_|panic!("Could not find or create Fastsim data subdirectory."));
+        let file_path = data_subdirectory.join(file_name);
+        // I believe this will overwrite any existing files with the same name -- is this preferable, or should we add
+        // a bool argument so user can determine whether the file should overwrite an existing file or not
+        download_file_from_url(url, &file_path);
+    }
 }
 
 pub trait ApproxEq<Rhs = Self> {

rust/fastsim-core/src/vehicle.rs

@@ -6,6 +6,7 @@ use crate::params::*;
 use crate::proc_macros::{add_pyo3_api, doc_field, ApproxEq};
 #[cfg(feature = "pyo3")]
 use crate::pyo3imports::*;
+use crate::utils::create_project_subdir;
 
 use lazy_static::lazy_static;
 use regex::Regex;
@@ -1033,6 +1034,23 @@ impl RustVehicle {
         v.set_derived().unwrap();
         v
     }
+    /// Downloads specified vehicle from vehicle repo into fastsim/python/fastsim/resources/vehdb.
+    /// 
+    /// Arguments:
+    /// ----------
+    /// vehicle (string): name of the vehicle to be downloaded
+
+    // make separate function that gets list of yaml files off of github, then user can choose from that for input -- Rust function
+    // exposed to python, put in utilities
+    pub fn from_github(vehicle_file_name: String) {
+        let mut vehicle_url: String = "https://github.com/NREL/fastsim-vehicles/blob/main/public/".to_string();
+        vehicle_url.push_str(&vehicle_file_name);
+        // find or create fastsim data directory with subdirectory "vehicles" and return path
+        let data_directory: Option<PathBuf> = create_project_subdir("vehicles");
+        // see if you can find file_name in vehicle data
+        // if file doesn't already exist in directory, and once we have file path to directory:
+        // download_file_from_url(vehicle_url, data_directory)
+    }
 }
 
 impl Default for RustVehicle {
@@ -1064,6 +1082,18 @@ impl SerdeAPI for RustVehicle {
     fn init(&mut self) -> anyhow::Result<()> {
         self.set_derived()
     }
+    /// takes an object from a url and saves it in the fastsim data directory in a rust_objects folder
+    /// WARNING: if there is a file already in the data subdirectory with the same name, it will be replaced by the new file
+    fn to_cache<S: AsRef<str>>(url: S) {
+        let url = url.as_ref();
+        let url_parts: Vec<&str> = url.split("/").collect();
+        let file_name = url_parts.last().unwrap_or_else(||panic!("Could not determine file name/type."));
+        let data_subdirectory = create_project_subdir("vehicles").unwrap_or_else(|_|panic!("Could not find or create Fastsim data subdirectory."));
+        let file_path = data_subdirectory.join(file_name);
+        // I believe this will overwrite any existing files with the same name -- is this preferable, or should we add
+        // a bool argument so user can determine whether the file should overwrite an existing file or not
+        download_file_from_url(url, &file_path);
+    }
 }
 
 #[cfg(test)]