feat: Add support for multi-model simulation. #60
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
Add `PywrMultiModel` schema and corresponding `MultiNetworkModel` to pywr-core. This update refactors the schema of the regular model to use a new "network" key. The schema then provides a `PywrNetwork` containing only the nodes, edges, parameters, metric sets and outputs. This is then reused by the regular model and the multi-model. A new parameter is added that can receive a parameter from another model. This is implemented via the transfers in the multi-model configuration. This is fairly generic because it uses the metric system to allowing passing of node or parameter data from one model to another. TODO: - [ ] Write some documentation on the new structs. - [ ] Check naming convention for inter-model transfers. - [ ] Add a multi-model test that uses circular inter-model transfers.
jetuk
changed the title
jetuk
changed the title
This helps support circular transfers between networks. Added a basic test model with circular transfers.
Remove the need for placeholder parameters to receive inter-model transfer values. Instead a metric is used to indicate the name of the inter-model transfer value to use at that particular location. This simplifies the configuration of inter-model transfers, but requires the build methods in the schema to recieve a reference to any transfers.
Batch21
reviewed
Jan 11, 2024
pywr-schema/src/model.rs
Outdated
| /// A Pywr model containing multiple link networks. | ||
| /// | ||
| /// This schema is used to define a model containing multiple linked networks. Each network | ||
| /// is self-contained and solve as like a single a model. However, the networks can be linked |
There was a problem hiding this comment.
should be 'solved as a single model'?
| /// Calculate inter-model parameters for the given scenario index. | ||
| /// | ||
| /// | ||
| fn compute_inter_network_transfers( |
There was a problem hiding this comment.
Might be worth adding a unit test for this func that test a multi-model with 3 or more networks
There was a problem hiding this comment.
I think I'll add this as an issue. I have a plan for a longer example that would require passing index (integer) values between models as well.
| @@ -173,48 +172,36 @@ fn run(path: &Path, solver: &Solver, data_path: Option<&Path>, output_path: Opti | |||
| let data = std::fs::read_to_string(path).unwrap(); | |||
| let schema_v2: PywrModel = serde_json::from_str(data.as_str()).unwrap(); | |||
|
|
|||
| let (model, timestepper): (Model, Timestepper) = schema_v2.build_model(data_path, output_path).unwrap(); | |||
There was a problem hiding this comment.
looks like a cmd needs adding to run a multi-model. Something woth doing in this PR?
Batch21
reviewed
Jan 12, 2024
pywr-cli/src/main.rs
Outdated
| parallel, | ||
| threads, | ||
| debug, | ||
| } => run(model, solver, data_path.as_deref(), output_path.as_deref(), *debug), |
Batch21
approved these changes
Jan 12, 2024
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.
Add
PywrMultiModelschema and correspondingMultiNetworkModelto pywr-core. This update refactors the schema of the regular model to use a new "network" key. The schema then provides aPywrNetworkcontaining only the nodes, edges, parameters, metric sets and outputs. This is then reused by the regular model and the multi-model.A new parameter is added that can receive a parameter from another model. This is implemented via the transfers in the multi-model configuration. This is fairly generic because it uses the metric system to allowing passing of node or parameter data from one model to another.
TODO: