User Programmable Controls (UPC) Scripts in InfoWorks WS Pro - UPC Scripts for Pump Station Control in InfoWorks WS Pro

Tutorial resources

These downloadable resources will be used to complete this tutorial:

iwsp2023M21U02_Pmp_Sttn_UPC.zip - (798 kb)

Step-by-step guide

UPC scripts allow you to represent the valves and pump stations within a water supply system that may be controlled by a more complex set of rules with multiple conditions. This example uses a UPC script to set two different types of pump controls, depending on the time of day.

From the Model Group window, expand the UPC Model group.
Double-click the UPC Network to open the UPC Network and UPC Control.

It is best practice to test UPC scripts in a scenario first, before altering a base model. To create a new scenario:

In the Scenarios toolbar, click Create scenario.
In the Create New Scenario dialog box, in the New Scenario Name field, type “Pump UPC”.
Enable Create matching scenario in the Control.
Click OK.

In the InfoWorks WS Pro interface, the Create New Scenario dialog box with options configured for the Pump UPC scenario; and in the GeoPlan, the UPC Network and UPC Control open.

In the Scenarios toolbar, the Pump UPC scenario now appears selected in the drop-down.

From the Model Group, drag the Pump Station selection list and drop it onto the GeoPlan to identify the pump station with asset ID 595311.
In the Tools toolbar, click the Properties tool.
On the GeoPlan, select asset ID 595311 to open the Properties window.

In the Scenarios toolbar, Pump UPC appears and is highlighted, the Properties tool is highlighted, and on the GeoPlan, the pump station is being selected.

Next, create a UPC script that sets two rules for this pump—one to turn the pump on and off to maintain a pressure between 31 and 33 meters at the hospital between 06:00 and 22:00; and another to maintain a pressure of 27 m at the furthest node in the network (END) between 22:00 and 06:00.

In the Properties window, expand UPC script.
In the UPC Script field, click the More (…) button to open the UPC Script window.

In the Properties window of the pump station, the UPC script menu is expanded, and More is highlighted.

From the dataset provided for this tutorial, open the Pump UPC.txt file.
Copy the lines of code provided.
In the UPC script dialog box, Paste the code into the text field.
Click Test to check for errors or syntax warnings.

The UPC script dialog box with the lines of code added, and the Test button called out.

When the message reports no warnings or errors, click OK.
Click OK again to close the UPC Script window.
Commit the changes to the database.

To run both scenarios:

In the Model Group, right-click the Run Group and select New > Run.
In the Schedule Hydraulic Run dialog box, in the Title field, enter “Pump UPC”.
Enable Experimental.
From the Model Group, drag the UPC Network into the Schedule Hydraulic Run dialog box and drop it into the Network group box.
Click the Scenarios tab.
Enable the Base and Pump UPC scenarios.
Click Save.
Click Run.

In the Schedule Hydraulic Run dialog box, the Base and Pump UPC scenarios are enabled, Run is selected, and a notification popup appears.

In the notification, click Yes.
When it finishes, from the Model Group drag the Base simulation into the GeoPlan.

To create a graph to visualize the results:

In the Model Group, right-click the Pump UPC simulation and select Open as.
In the Select Results popup, select As Alternate Results For Comparison.
Click OK.
On the Operations toolbar, click Graph selected objects.
In the GeoPlan, zoom in and select the pump station.
In the dialog box, select State.
Enable Graph alternate results.
Click OK.

In the Results window, State is selected and Graph alternate results is enabled.

A graph window opens, showing the state of the pump in the different scenarios.

A graph window showing the state of the pump in the two scenarios over a 24-hour period.

The base simulation pump remains on for the whole simulation, since its state is continuously set to 1. In the Pump UPC scenario, the pump turns on (1) and off (0) as the pressure at the specified control points change. Also note that a pump turning on and off with this frequency in reality could damage the distribution infrastructure, so the scheduling in this UPC might need to be refined.

Was this information helpful?

Cookie preferences

Your privacy is important to us and so is an optimal experience. To help us customize information and build applications, we collect data about your use of this site.

May we collect and use your data?

Learn more about the Third Party Services we use and our Privacy Statement.

Are you sure you want a less customized experience?

We can access your data only if you select "yes" for the categories on the previous screen. This lets us tailor our marketing so that it's more relevant for you. You can change your settings at any time by visiting our privacy statement

Your experience. Your choice.

We care about your privacy. The data we collect helps us understand how you use our products, what information you might be interested in, and what we can improve to make your engagement with Autodesk more rewarding.

May we collect and use your data to tailor your experience?

Explore the benefits of a customized experience by managing your privacy settings for this site or visit our Privacy Statement to learn more about your options.

UPC Scripts for Pump Station Control in InfoWorks WS Pro

Step-by-step guide

Cookie preferences

Strictly necessary – required for our site to work and to provide services to you

Improve your experience – allows us to show you what is relevant to you

Customize your advertising – permits us to offer targeted advertising to you

Strictly necessary – required for our site to work and to provide services to you

Improve your experience – allows us to show you what is relevant to you

Customize your advertising – permits us to offer targeted advertising to you

Are you sure you want a less customized experience?

Your experience. Your choice.

Cookie preferences

Strictly necessary – required for our site to work and to provide services to you

Improve your experience – allows us to show you what is relevant to you

Customize your advertising – permits us to offer targeted advertising to you

THIRD PARTY SERVICES

Strictly necessary – required for our site to work and to provide services to you

Improve your experience – allows us to show you what is relevant to you

Customize your advertising – permits us to offer targeted advertising to you

Are you sure you want a less customized experience?

Your experience. Your choice.