feat: add returned_metric attribute to threshold parameter #331
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This optional attribute contains metrics to be returned by the parameter. It is equivalent to the values attribute of the v1 threshold parameters and enables conversions of v1 parameters that specify this attribute.
jetuk
requested changes
Jan 20, 2025
pywr-schema/src/parameters/mod.rs
Outdated
| @@ -191,7 +191,18 @@ impl Parameter { | |||
| Self::Min(p) => pywr_core::parameters::ParameterType::Parameter(p.add_to_model(network, args)?), | |||
| Self::Negative(p) => pywr_core::parameters::ParameterType::Parameter(p.add_to_model(network, args)?), | |||
| Self::Polynomial1D(p) => pywr_core::parameters::ParameterType::Parameter(p.add_to_model(network, args)?), | |||
| Self::Threshold(p) => pywr_core::parameters::ParameterType::Index(p.add_to_model(network, args)?), | |||
| Self::Threshold(p) => match p.add_to_model(network, args)? { | |||
There was a problem hiding this comment.
p.add_to_model already returns a ParameterType?
| @@ -54,13 +55,37 @@ impl From<Predicate> for pywr_core::parameters::Predicate { | |||
| } | |||
| } | |||
|
|
|||
| /// A parameter that compares a metric against a threshold metric | |||
| /// | |||
| /// The metrics are compared using the given predicate and the result is returned as an index. If the comparison | |||
There was a problem hiding this comment.
This needs to say that the returned metrics are used instead if given.
| /// is set as the index parameter of a [`pywr_core::parameters::IndexedArrayParameter`] containing the `returned_metrics` | ||
| /// values. | ||
| /// | ||
| /// An equivalent representation could be achieved by defining the two parameters in the schema directly: |
There was a problem hiding this comment.
Expand this to compare the approach with one parameter and two.
jetuk
requested changes
Jan 20, 2025
| @@ -472,7 +472,7 @@ impl EdgeReference { | |||
| /// This struct is the integer equivalent of [`Metric`] and is used in places where an integer | |||
| /// value is required. See [`Metric`] for more information. | |||
| #[derive(serde::Deserialize, serde::Serialize, Debug, Clone, JsonSchema, Display, PartialEq)] | |||
| #[serde(untagged)] | |||
| #[serde(tag = "type")] | |||
pywr-schema/src/parameters/mod.rs
Outdated
| let _ = serde_json::from_value::<Vec<Parameter>>(value) | ||
| .unwrap_or_else(|_| panic!("Failed to deserialize: {:?}", p)); | ||
| } | ||
| _ => panic!("Expected JSON object: {:?}", p), |
jetuk
approved these changes
Jan 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This optional attribute contains metrics to be returned by the parameter. It is equivalent to the values attribute of the v1 threshold parameters and enables conversions of v1 parameters that specify this attribute.