Rename settings object from Data to Settings

Renaming Data to Settings, which is more intuitive

src/algorithms.rs

@@ -1,4 +1,4 @@
-use crate::prelude::{self, settings::run::Data};
+use crate::prelude::{self, settings::run::Settings};
 
 use output::NPResult;
 use prelude::{datafile::Scenario, *};
@@ -22,7 +22,7 @@ pub trait Algorithm {
 
 pub fn initialize_algorithm<S>(
     engine: Engine<S>,
-    settings: Data,
+    settings: Settings,
     scenarios: Vec<Scenario>,
     tx: mpsc::UnboundedSender<Comm>,
 ) -> Box<dyn Algorithm>

src/algorithms/npag.rs

@@ -7,7 +7,7 @@ use crate::{
         output::NPResult,
         output::{CycleLog, NPCycle},
         prob, qr,
-        settings::run::Data,
+        settings::run::Settings,
         simulation::predict::Engine,
         simulation::predict::{sim_obs, Predict},
     },
@@ -49,7 +49,7 @@ where
     scenarios: Vec<Scenario>,
     c: (f64, f64, f64, f64),
     tx: UnboundedSender<Comm>,
-    settings: Data,
+    settings: Settings,
 }
 
 impl<S> Algorithm for NPAG<S>
@@ -99,7 +99,7 @@ where
         scenarios: Vec<Scenario>,
         c: (f64, f64, f64, f64),
         tx: UnboundedSender<Comm>,
-        settings: Data,
+        settings: Settings,
     ) -> Self
     where
         S: Predict<'static> + std::marker::Sync,

src/algorithms/npod.rs

@@ -9,7 +9,7 @@ use crate::{
         output::NPResult,
         output::{CycleLog, NPCycle},
         prob, qr,
-        settings::run::Data,
+        settings::run::Settings,
         simulation::predict::Engine,
         simulation::predict::{sim_obs, Predict},
     },
@@ -45,7 +45,7 @@ where
     scenarios: Vec<Scenario>,
     c: (f64, f64, f64, f64),
     tx: UnboundedSender<Comm>,
-    settings: Data,
+    settings: Settings,
 }
 
 impl<S> Algorithm for NPOD<S>
@@ -95,7 +95,7 @@ where
         scenarios: Vec<Scenario>,
         c: (f64, f64, f64, f64),
         tx: UnboundedSender<Comm>,
-        settings: Data,
+        settings: Settings,
     ) -> Self
     where
         S: Predict<'static> + std::marker::Sync,

src/algorithms/postprob.rs

@@ -6,7 +6,7 @@ use crate::{
         ipm,
         output::NPResult,
         prob,
-        settings::run::Data,
+        settings::run::Settings,
         simulation::predict::Engine,
         simulation::predict::{sim_obs, Predict},
     },
@@ -35,7 +35,7 @@ where
     c: (f64, f64, f64, f64),
     #[allow(dead_code)]
     tx: UnboundedSender<Comm>,
-    settings: Data,
+    settings: Settings,
 }
 
 impl<S> Algorithm for POSTPROB<S>
@@ -69,7 +69,7 @@ where
         scenarios: Vec<Scenario>,
         c: (f64, f64, f64, f64),
         tx: UnboundedSender<Comm>,
-        settings: Data,
+        settings: Settings,
     ) -> Self
     where
         S: Predict<'static> + std::marker::Sync,

src/entrypoints.rs

@@ -5,7 +5,7 @@ use crate::prelude::{
     *,
 };
 use crate::routines::datafile::Scenario;
-use crate::routines::settings::run::Data;
+use crate::routines::settings::run::Settings;
 
 use csv::{ReaderBuilder, WriterBuilder};
 use eyre::Result;
@@ -150,7 +150,7 @@ where
 /// Returns an NPresult object
 pub fn start_internal<S>(
     engine: Engine<S>,
-    settings: Data,
+    settings: Settings,
     scenarios: Vec<Scenario>,
 ) -> Result<NPResult>
 where

src/logger.rs

@@ -1,4 +1,4 @@
-use crate::routines::settings::run::Data;
+use crate::routines::settings::run::Settings;
 use crate::tui::ui::Comm;
 use std::io::{self, Write};
 use tokio::sync::mpsc::UnboundedSender;
@@ -9,7 +9,7 @@ use tracing_subscriber::registry::Registry;
 use tracing_subscriber::util::SubscriberInitExt;
 use tracing_subscriber::EnvFilter;
 
-pub fn setup_log(settings: &Data, ui_tx: UnboundedSender<Comm>) {
+pub fn setup_log(settings: &Settings, ui_tx: UnboundedSender<Comm>) {
     // Use the log level defined in configuration file, or default to info
     let log_level = settings
         .parsed

src/routines/initialization.rs

@@ -2,11 +2,11 @@ use std::fs::File;
 
 use ndarray::Array2;
 
-use crate::prelude::settings::run::Data;
+use crate::prelude::settings::run::Settings;
 
 pub mod sobol;
 
-pub fn sample_space(settings: &Data, ranges: &Vec<(f64, f64)>) -> Array2<f64> {
+pub fn sample_space(settings: &Settings, ranges: &Vec<(f64, f64)>) -> Array2<f64> {
     match &settings.parsed.paths.prior_dist {
         Some(prior_path) => {
             let file = File::open(prior_path).unwrap();

src/routines/output.rs

@@ -4,7 +4,7 @@ use datafile::Scenario;
 use ndarray::parallel::prelude::*;
 use ndarray::{Array, Array1, Array2, Axis};
 use predict::{post_predictions, sim_obs, Engine, Predict};
-use settings::run::Data;
+use settings::run::Settings;
 use std::fs::File;
 
 /// Defines the result objects from an NPAG run
@@ -19,7 +19,7 @@ pub struct NPResult {
     pub cycles: usize,
     pub converged: bool,
     pub par_names: Vec<String>,
-    pub settings: Data,
+    pub settings: Settings,
 }
 
 impl NPResult {
@@ -32,7 +32,7 @@ impl NPResult {
         objf: f64,
         cycles: usize,
         converged: bool,
-        settings: Data,
+        settings: Settings,
     ) -> Self {
         // TODO: Add support for fixed and constant parameters
 

src/routines/settings/run.rs

@@ -5,7 +5,7 @@ use toml::value::Array;
 use toml::{self, Table};
 
 #[derive(Deserialize, Clone, Debug)]
-pub struct Data {
+pub struct Settings {
     pub computed: Computed,
     pub parsed: Parsed,
 }
@@ -68,7 +68,7 @@ pub struct Config {
     pub log_level: Option<String>,
 }
 
-pub fn read(filename: String) -> Data {
+pub fn read(filename: String) -> Settings {
     let contents = match fs::read_to_string(&filename) {
         Ok(c) => c,
         Err(e) => {
@@ -122,7 +122,7 @@ pub fn read(filename: String) -> Data {
         }
     }
 
-    Data {
+    Settings {
         computed: Computed {
             random: Range {
                 names: pn,

src/routines/settings/simulator.rs

@@ -4,7 +4,7 @@ use std::process::exit;
 use toml;
 
 #[derive(Deserialize, Clone, Debug)]
-pub struct Data {
+pub struct Settings {
     pub paths: Paths,
     pub config: Config,
 }
@@ -21,7 +21,7 @@ pub struct Config {
     pub tad: Option<f64>,
 }
 
-pub fn read(filename: String) -> Data {
+pub fn read(filename: String) -> Settings {
     let contents = match fs::read_to_string(&filename) {
         Ok(c) => c,
         Err(e) => {
@@ -30,15 +30,15 @@ pub fn read(filename: String) -> Data {
             exit(1);
         }
     };
-    let parse: Data = match toml::from_str(&contents) {
+    let parse: Settings = match toml::from_str(&contents) {
         Ok(d) => d,
         Err(e) => {
             eprintln!("{}", e);
             eprintln!("ERROR: Unable to load data from {}", &filename);
             exit(1);
         }
     };
-    Data {
+    Settings {
         paths: Paths {
             data: parse.paths.data,
             theta: parse.paths.theta,

src/tui/components.rs

@@ -15,7 +15,7 @@ use ratatui::{
 
 use super::App;
 
-use crate::prelude::settings::run::Data;
+use crate::prelude::settings::run::Settings;
 
 pub fn draw_title<'a>() -> Paragraph<'a> {
     Paragraph::new("NPcore Execution")
@@ -75,7 +75,7 @@ pub fn draw_status<'a>(app: &App, elapsed_time: Duration) -> Table<'a> {
         .column_spacing(1)
 }
 
-pub fn draw_options<'a>(settings: &Data) -> Table<'a> {
+pub fn draw_options<'a>(settings: &Settings) -> Table<'a> {
     // Define the table data
 
     let cycles = settings.parsed.config.cycles.to_string();
@@ -255,7 +255,7 @@ pub fn draw_tabs<'a>(app: &App) -> Tabs<'a> {
     tabs
 }
 
-fn get_computed_settings(settings: &Data) -> Vec<Row> {
+fn get_computed_settings(settings: &Settings) -> Vec<Row> {
     let computed = settings.computed.clone();
     let mut rows = Vec::new();
     let key_style = Style::default().fg(Color::LightCyan);
@@ -299,7 +299,7 @@ fn get_computed_settings(settings: &Data) -> Vec<Row> {
     rows
 }
 
-pub fn draw_parameter_bounds(settings: &Data) -> Table {
+pub fn draw_parameter_bounds(settings: &Settings) -> Table {
     let rows = get_computed_settings(&settings);
     Table::default()
         .rows(rows)

src/tui/ui.rs

@@ -27,10 +27,10 @@ pub enum Comm {
     LogMessage(String),
 }
 
-use crate::prelude::{output::NPCycle, settings::run::Data};
+use crate::prelude::{output::NPCycle, settings::run::Settings};
 use crate::tui::components::*;
 
-pub fn start_ui(mut rx: UnboundedReceiver<Comm>, settings: Data) -> Result<()> {
+pub fn start_ui(mut rx: UnboundedReceiver<Comm>, settings: Settings) -> Result<()> {
     let stdout = stdout();
     crossterm::terminal::enable_raw_mode()?;
     let backend = CrosstermBackend::new(stdout);
@@ -131,7 +131,7 @@ pub fn draw(
     app: &App,
     cycle_history: &CycleHistory,
     elapsed_time: Duration,
-    settings: &Data,
+    settings: &Settings,
     log_history: &Vec<String>,
 ) {
     let size = rect.size();