run_candidate
Evaluate network modifications by applying edits to a copy, validating, simulating, and returning results while preserving the original model.
Instructions
Evaluate a scenario: apply a batch of edits (pipe diameters, junction demands, pump speeds) to a COPY of a loaded network, validate the copy against the EPANET engine, run a simulation, and return the aggregate results (same shape as run_simulation). The base model and its stored results are NEVER modified, so candidates can be compared freely and previous runs stay valid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| edits | Yes | The edits to evaluate. They are applied to a COPY of the model and simulated; the base model and its stored results are never modified. | |
| quality | No | Also run water-quality analysis. Requires the model to have quality configured ([OPTIONS] Quality). | |
| networkId | Yes | The network id returned by load_network. |