feat: add timeseries section to model schema

pywr-schema/Cargo.toml

@@ -15,7 +15,7 @@ categories = ["science", "simulation"]
 
 [dependencies]
 svgbobdoc = { version = "0.3.0", features = ["enable"]  }
-polars = {  workspace = true }
+polars = {  workspace = true, features = ["csv"] }
 pyo3 = {  workspace = true }
 pyo3-polars = {  workspace = true }
 strum = "0.26"

pywr-schema/src/error.rs

@@ -1,5 +1,6 @@
 use crate::data_tables::TableError;
 use crate::nodes::NodeAttribute;
+use polars::error::PolarsError;
 use pyo3::exceptions::PyRuntimeError;
 use pyo3::PyErr;
 use thiserror::Error;
@@ -28,6 +29,16 @@ pub enum SchemaError {
     PywrCore(#[from] pywr_core::PywrError),
     #[error("data table error: {0}")]
     DataTable(#[from] TableError),
+    #[error("Timeseries '{0} not found")]
+    TimeseriesNotFound(String),
+    #[error("Column '{col}' not found in timeseries input '{name}'")]
+    ColumnNotFound { col: String, name: String },
+    #[error("Timeseries provider '{provider}' does not support '{fmt}' file types")]
+    TimeseriesUnsupportedFileFormat { provider: String, fmt: String },
+    #[error("Timeseries provider '{provider}' cannot parse file: '{path}'")]
+    TimeseriesUnparsableFileFormat { provider: String, path: String },
+    #[error("Polars error: {0}")]
+    PolarsError(#[from] PolarsError),
     #[error("Circular node reference(s) found.")]
     CircularNodeReference,
     #[error("Circular parameters reference(s) found.")]

pywr-schema/src/lib.rs

@@ -12,6 +12,7 @@ pub mod model;
 pub mod nodes;
 pub mod outputs;
 pub mod parameters;
+pub mod timeseries;
 
 pub use error::{ConversionError, SchemaError};
 pub use model::PywrModel;

pywr-schema/src/model.rs

@@ -6,6 +6,7 @@ use crate::error::{ConversionError, SchemaError};
 use crate::metric_sets::MetricSet;
 use crate::outputs::Output;
 use crate::parameters::{MetricFloatReference, TryIntoV2Parameter};
+use crate::timeseries::{LoadedTimeseriesCollection, Timeseries};
 use pywr_core::models::ModelDomain;
 use pywr_core::PywrError;
 use std::path::{Path, PathBuf};
@@ -91,6 +92,7 @@ pub struct PywrNetwork {
     pub edges: Vec<Edge>,
     pub parameters: Option<Vec<Parameter>>,
     pub tables: Option<Vec<DataTable>>,
+    pub timeseries: Option<Vec<Timeseries>>,
     pub metric_sets: Option<Vec<MetricSet>>,
     pub outputs: Option<Vec<Output>>,
 }
@@ -139,6 +141,9 @@ impl PywrNetwork {
         // Load all the data tables
         let tables = LoadedTableCollection::from_schema(self.tables.as_deref(), data_path)?;
 
+        // Load all timeseries data
+        let timeseries = LoadedTimeseriesCollection::from_schema(self.timeseries.as_deref(), domain, data_path)?;
+
         // Create all the nodes
         let mut remaining_nodes = self.nodes.clone();
 
@@ -153,6 +158,7 @@ impl PywrNetwork {
                     &tables,
                     data_path,
                     inter_network_transfers,
+                    &timeseries,
                 ) {
                     // Adding the node failed!
                     match e {
@@ -211,6 +217,7 @@ impl PywrNetwork {
                         &tables,
                         data_path,
                         inter_network_transfers,
+                        &timeseries,
                     ) {
                         // Adding the parameter failed!
                         match e {
@@ -244,6 +251,7 @@ impl PywrNetwork {
                 &tables,
                 data_path,
                 inter_network_transfers,
+                &timeseries,
             )?;
         }
 
@@ -382,13 +390,15 @@ impl TryFrom<pywr_v1_schema::PywrModel> for PywrModel {
 
         // TODO convert v1 tables!
         let tables = None;
+        let timeseries = None;
         let outputs = None;
         let metric_sets = None;
         let network = PywrNetwork {
             nodes,
             edges,
             parameters,
             tables,
+            timeseries,
             metric_sets,
             outputs,
         };

pywr-schema/src/nodes/annual_virtual_storage.rs

@@ -4,6 +4,7 @@ use crate::model::PywrMultiNetworkTransfer;
 use crate::nodes::core::StorageInitialVolume;
 use crate::nodes::{NodeAttribute, NodeMeta};
 use crate::parameters::{DynamicFloatValue, TryIntoV2Parameter};
+use crate::timeseries::LoadedTimeseriesCollection;
 use pywr_core::derived_metric::DerivedMetric;
 use pywr_core::metric::Metric;
 use pywr_core::models::ModelDomain;
@@ -53,24 +54,49 @@ impl AnnualVirtualStorageNode {
         tables: &LoadedTableCollection,
         data_path: Option<&Path>,
         inter_network_transfers: &[PywrMultiNetworkTransfer],
+        timeseries: &LoadedTimeseriesCollection,
     ) -> Result<(), SchemaError> {
         let cost = match &self.cost {
             Some(v) => v
-                .load(network, schema, domain, tables, data_path, inter_network_transfers)?
+                .load(
+                    network,
+                    schema,
+                    domain,
+                    tables,
+                    data_path,
+                    inter_network_transfers,
+                    timeseries,
+                )?
                 .into(),
             None => ConstraintValue::Scalar(0.0),
         };
 
         let min_volume = match &self.min_volume {
             Some(v) => v
-                .load(network, schema, domain, tables, data_path, inter_network_transfers)?
+                .load(
+                    network,
+                    schema,
+                    domain,
+                    tables,
+                    data_path,
+                    inter_network_transfers,
+                    timeseries,
+                )?
                 .into(),
             None => ConstraintValue::Scalar(0.0),
         };
 
         let max_volume = match &self.max_volume {
             Some(v) => v
-                .load(network, schema, domain, tables, data_path, inter_network_transfers)?
+                .load(
+                    network,
+                    schema,
+                    domain,
+                    tables,
+                    data_path,
+                    inter_network_transfers,
+                    timeseries,
+                )?
                 .into(),
             None => ConstraintValue::None,
         };