WaterSums 1.1 Release Notes

Changes in the WaterSums 1.1 release family

WaterSums 1.1.2 26 January 2012

This release was not originally planned, but the release of WaterSums 2.0 continues to be delayed, so some of the bug fixes and very simple new features have been included in a special release.

New features

  • Allow creation and validation of object IDs up to 31 characters (EPANET 2.0.12 supports 31 characters).  Limited rule names to 31 characters (was 32).
  • Allow IDs to contain other characters as well as the previously supported alphanumeric characters.  In particular, this allows underscores and hyphens which are in common use.  The only characters not supported are the space, the comma (,), the equals sign (=) and the pipe symbol (|).  In general it is still recommended that alphanumeric characters be used as this maximises interchangeability of models.
  • Network object IDs cannot be edited in WaterSums.  In previous releases, the text could not be copied.  In this release the field can be selected, copied, etc. but the value still cannot be edited.

Bugs fixed

  • Various internal changes (functions always returning values, ensure setting of (correct) error arguments, removal of unused variables in network objects, setting default values when loading projects, etc.)
  • Fix problem with reading curve label during EPANET input file import (used to specify curve type)
  • Fix bug in colour specification for Silverlight display client
  • Fix bug in syntax checking of simple rules where link status value was only accepted as a single digit.  This caused any pump speed or control valve settings with more than one digit or a decimal point to be considered invalid in the control editor.
  • Fix bug with enabling/disabling of control editor button on the Network toolbar
  • Fix bug in which WaterSums did not know which network to add new objects to in some cases.
  • Fix bugs in Licence Tool when running in Virtualbox and in some other hardware configurations.  The new version of the Licence Tool is 1.0.2.
  • Fix problem where ID was not always set when editing first entity of a type (junction, reservoir, tank, etc.)
  • Remove some unnecessary operations at shut down to reduce shut down time.

WaterSums 1.1.1 12 November 2009

New features in WaterSums 1.1.1

  • Automatic background analysis is now provided and enabled by default.   Whenever a network is modified, auto-analysis is triggered and a summary or the results (number of errors/warnings) is displayed in the analysis result summary area at the left hand end of the status bar at the bottom of the main window.
  • After analysis has been performed once in a network, right-clicking in the analysis result summary area will display a context menu which allows you to disable/enable auto-analysis or display the result file.
  • The network analysis output file from the latest analysis (requested interactively or triggered automatically by network editing) is displayed if you click in the analysis result summary area.
  • Network analysis result output files are now displayed in a customised file viewer panel which highlights errors and warnings.  References to network objects are displayed with hyperlinks. Clicking on the hyperlink selects the object referred to in the Project tree and map window. Double-clicking selects the object and displays the object property editor to allow editing. Right-clicking on the link displays a context menu allowing the object to be selected, edited or deleted.
  • If the network analysis output file is displayed in the file viewer when an automatic or interactive analysis is performed, the new output file is loaded into file viewer so that the results are not out of date.
  • When objects are selected in the map, the branch in the Project Tree is now expanded to show the details of the object.
  • Contours are now drawn on network maps by default.  A new toolbar button toggles the display and a stored preference controls whether or not new maps are drawn with contours.  Note that contours are currently not updated when the network changes.  You will need to update them manually by removing and redisplaying them with the the toolbar button.
  • Some of the functionality available when using the Silverlight plugin has been added for use with the Adobe SVG Viewer (supported on Windows 2000 and XP):
    • Display and removal of contours
    • Use of the mouse wheel to zoom in and out
    • Zoom In and Zoom Out toolbar buttons now zoom in or out based on the centre of the current map view
    • The Original View toolbar button now correctly restores the original view, rather than just setting the original zoom level
    • Map labels are now red and underlined when selected
    • Hovering over network objects in the map now gives a visible indication: the colour of lines (Pipes/Pumps/Valves) change to fuchsia, the colour of Map Label text changes to fuchsia with underlining and overlining and symbols become a little transparent.  Moving away from the object restores them to their original appearance.
    • 'Yellow flash' when simulation playback restarts while looping
    • Simulation progress and clock display at top left of map window
    • Replay speed can be controlled with toolbar buttons
    • Speed setting sticks between analysis replays (which is currently not true for the Silverlight plugin)
  • The Load and Save buttons on the Curve editor now allow the user to load or save a curve. When editing a curve, only curves with the same curve type can be loaded. For example, if a pump curve is being edited, only pump curves can be loaded from file.
  • The Load and Save buttons on Pattern editor now allow the user to load or save a pattern.
  • Support for editing Simple and Rule-based controls has been significantly enhanced.  See on-line help for more details, but in summary:
    • Controls are now included in the Project tree.
    • New Control Editor provided with:
      • syntax highlighting
      • auto-completion
      • control syntax validation as you edit
      • control reference validation as you edit: make sure a network object exists when it is referred to in a control
    • Editing of controls can also be initiated from the tree by double-clicking on the rule text.
    • Control Properties help page added with details of Control syntax, shortcut keys, keyword expansion and some examples.
    • Add Network > Add/Edit Controls… and update Network Menu help
    • Add Add/Edit Controls button to Network toolbar and update the Network Object Toolbar help page.
    • Add Add/Edit Controls option to right-click menu for network heading
    • Add Add/Edit Controls option to right-click menu for Controls heading
    • Add context menu with Edit and Delete options when right-clicking on Control text.
    • Show Help on Control Editor is a stored preference.
    • Note that Rule-based Controls cannot currently contain comments.
  • If using coordinates with negative values (for example latitude/longitude), the map would always be drawn so that the extents included (0,0). This has now been fixed.
  • Tooltips have been enhanced to include more information about the object. eg. length and diameter of pipes.
  • Added checking of tank levels in property editor to make sure that the minimum level is less than the initial and maximum levels and that the initial level is less than the maximum level.
  • Swapped order of initial and minimum levels in tank properties editor so that values in the fields will be increasing in order.
  • Added Reverse option to context menu displayed when right-clicking on Pipes, Pumps or Valves in the Project Tree.
  • Speed of loading larger projects has been significantly improved.
  • Moving the mouse over the map no longer slows down the system so much.
  • Return values from commands are now displayed in the command window.

Bugs fixed in WaterSums 1.1.1

  • Using the Revert option would sometimes cause subsequent errors when adding/deleting network objects.
  • If using lat/long with negative coordinates, the map would always be drawn so that the extents include (0,0).  This has now been fixed.
  • Unused Node View and Link View branches have been removed from the network settings branch of the Project tree.
  • Deleting objects did not delete associated controls.  This has now been fixed.  Deleting a network object will delete all simple or rule-based controls that relate to the object.
  • Map labels were placed with the text aligned differently for the two different presentation plugins.  With the Silverlight plugin, the text was centred vertically about the specified label location and in the Adobe SVG Viewer plugin, the map label location was at the bottom left of the label text.  These have now both been changed so that the map label location is at the top left of the label text.

Bugs fixed in WaterSums 1.1.0.11

  • An error was displayed when opening the Curve Editor for the first time if it was being used to open an existing curve having one point. This has now been fixed.
  • An error was displayed if an empty curve was created with the Curve Editor and then edited. This has now been fixed.
  • Reservoirs and Tanks could be deleted without connected links (pipes, pumps or valves) being deleted as well. This left the links invalid, but has now been fixed.
  • Double-clicking on the flow direction arrow displayed on a pipe, pump or valve after analysing the network generated an error "Sorry, but this functionality is not yet available!" This has now been fixed so that the property panel for the pipe, pump or valve is displayed.

Bugs fixed in WaterSums 1.1.0.10

  • There has been long-standing problem where clicking in the new row area, clicking back on an earlier row and then clicking in the new row would cause WaterSums to terminate due to a problem within the .Net 2.0 Framework. This problem has now been worked around with a minor drawback that in some situations the scrollbar will be disabled until the panel is resized vertically!
  • In some situations, edits to junction demands were ignored. This has now been fixed.
  • Edits to the description field in the Curve and Pattern editors were ignored. This has now been fixed.
  • Pressing OK on the Curve and Pattern editors always created an Undo entry in the Edit menu, even if nothing had been changed. This has now been fixed.
  • Various problems with the input of data when creating or editing Curves or Patterns have been fixed. For example, creating a new Pattern when the panel had not been used before in a session made adding new rows difficult; the first row had to be edited before new rows could be added. Usage is now more consistent and easier.
  • If all the rows in a Pattern were deleted in the Pattern Editor and then the user clicked in the graph area, WaterSums generated an unhandled exception. This has now been fixed.

Bugs fixed in WaterSums 1.1.0.9

  • In previous releases, WaterSums project files that included imported networks would display an error about a missing file if the imported file was not available in the original location from which it was imported. This limited the portability of project files and has now been fixed. The imported files are not required after the import is completed.
  • Opening some projects gave an error "Object reference not set to an instance of an object". This has now been fixed.
  • If a pipe was added to a newly created network in an existing project, an error "value cannot be null". This has now been fixed.
  • The scaling of newly added objects has been changed a little to make it work better.

WaterSums 1.1.0

With this release, the following changes have been made since WaterSums 1.0.13.

New features in WaterSums 1.1

  • WaterSums now supports Microsoft Windows Vista 32/64 and Windows 7 32/64 Release Candidate. Windows Vista is not supported for use with the Adobe SVG Viewer.
  • WaterSums can now be used on a computer with Microsoft Internet Explorer 8 installed.
  • Maps are displayed using the Microsoft Silverlight 2.0 plugin by defaults. When using this plugin, the following new features are available:
    • Significantly improved view control (pan and zoom).
    • Pumps and valves now display a symbol as well as a line.
    • Selecting the pump or valve symbol selects the pump or valve they relate to.
    • Tanks now show the initial level relative to the minimum and maximum levels.
    • Tank level is now set in the tank symbol to reflect the specified tank initial level when tanks are added or edited. The level varies during simulation to indicate the tank level. A full tank indicates that the level has reached the specified maximum for the tank, while an empty tank shows that the water level has gone down to the minimum specified level in the tank.
    • Centre section of pumps now rotate during simulation whenever the pump is rotating (in reverse if the pump is rotating backwards).
    • When the network simulation is running, a digital clock shows the current time in the simulation and what proportion of the simulation is complete through a progress monitor in the background.
    • When the simulation is looping, the map background 'flashes' yellow whenever the simulation restarts.
    • Flow animation arrows are scaled in the same way as link selection arrows.
    • Selecting the flow arrows selects the pipe, pump or valve they relate to.
    • Mouse pointer now changes to a hand when moving over network objects.
    • Pressing F1 when the map is active now displays help about Map view control.
    • Several new controls have been added to the Network toolbar to control the playback of analysis results including a new combo-box allowing the timestep number to be typed in or selected from the pulldown. The new buttons also have keyboard shortcuts as detailed below.
    • After analysis has been performed on a network, the following function keys will control the replay of the simulation:
      • Shift-F4 Move to the start of simulation report time
      • F4 Single step backwards
      • F5 Play/pause simulation
      • F6 Single step forward
      • Shift-F6 Move to the end of simulation report time
      • F7 Slow simulation replay down to 2/3 of the speed
      • F8 Set simulation speed to the default speed (1 second per timestep)
      • F9 Speed up simulation replay by 50%
  • A 64-bit build is now available which uses 64-bit processing for network analysis. The main application still loads as a 32-bit application because neither Silverlight nor the Adobe SVG Viewer have a 64-bit version. Only the analysis uses 64-bit code.
  • New context menu options for adding a Pump, Pipe or Valve are displayed when right-clicking on node objects (Junctions, Reservoirs and Tanks).
  • Pressing F2 now performs analysis on the current network and Shift-F2 deletes the analysis results and the animations.
  • If warnings are generated during the analysis, the output file containing the warnings is displayed.
  • Pump properties panel now requires either pump curve or pump power to be set. Previously the panel would allow both to be blank which would generate an analysis error 200 about invalid numeric input for the pump.
  • Undo and Redo and other edits now remove analysis results since the network will no longer be the same.
  • Network Options (times, etc.) can now be set in the Project tree with other attributes of networks. Each network can have different option settings.
  • New menu option Help > Report an issue... added which links to the WaterSums issue tracking system at www.WaterSums.com/project/issues/watersums.
  • Various improvements in Help:
    • The help page displayed by pressing F1 is now context sensitive in the Project tree.
    • New help pages have been added for networks, relationships and delete behaviour.
  • EPANET version 2.0.12 is now used for network analysis.
  • If the map for a network has been closed, it can now be re-opened using a new menu option Network > Map.

Bugs fixed in WaterSums 1.1

  • When a project with more than one network was saved, the network options of all networks were modified to match the network options of the last network that was opened. This has now been fixed.
  • Various errors in the help file have been fixed.
  • If an error occurs during analysis, WaterSums now checks that the output file exists before trying to display it.
  • Creating a new network would create a network with most options (times, hydraulics, quality, etc.) not set. This has now been fixed.
  • Undo after deleting a Label displayed an error. This has now been fixed.
  • Search for an empty string in the Find box and everything in the Project tree is expanded. This has now been fixed.
  • If a link (Pipe, Pump or Valve) was created with an empty Description or Tag and then edited in a subsequent WaterSums session, an error icon was displayed on the panel indicating that an attribute was not known. This has now been fixed.
  • An error was displayed in some cases when generating new network IDs. This has now been fixed.
  • Network objects that had been deleted or whose creation had been undone were still included in the pulldowns for nodes, links, curves and patterns when creating or editing network objects that have relationships to these objects. This has now been fixed.
  • When switching map tabs, the status bar continued to show the location of the last mouse position in the previous tab. The status bar message is now cleared when the user changes tabs.
  • When exporting the EPANET input files, the Accuracy entry in the OPTIONS section was exported twice. This has now been fixed.

Known issues in WaterSums 1.1

  • In the Silverlight plugin, using the mouse wheel for zooming requires you to click in the map area first.
  • Valves are not yet shown closed/open during simulation.