Version 0.4.1 Release

What's Changed

• Added pattern start to the WNTRSimulator by @kaklise in #225
• Update to EPANET rules parsing by @dbhart in #228
• Added modified resilience index and tank capacity metrics by @kaklise in #226
• Min timestep by @dbhart in #229
• Added jupyter notebook test script by @jckett in #237
• Model JSON format by @dbhart in #232
• Update elements.py:TimeSeries.repr by @dbhart in #238
• Added ability to easily update Control/Rule parameters by @this-josh in #241
• Added seed to sample damage state by @kaklise in #246
• Toolkit update by @dbhart in #236
• Split/break taking vertices into account by @pahbloo in #248
• Fix assert statement in add_tank by @dbhart in #251
• Distribute inp files used for testing by @michaelbynum in #253

New Contributors

• @jckett made their first contribution in #237
• @this-josh made their first contribution in #241
• @pahbloo made their first contribution in #248

Full Changelog: 0.4.0...0.4.1

Version 0.4.0 Release

• Changed network component attribute names related to initial status and initial setting and made simulation results read-only
• Added slots to water network model options to define available option names
• Removed custom handlers from the EPANET bin filer reader
• Added a metric to compute pump energy
• Added type checking for methods used to build water network models
• Updated the WNTRSimulator link results to include setting
• Updated the WNTRSimulator to use start clocktime
• Updated documentation and tests

See Release Notes for more details.

Version 0.3.1 Release

• Added option to define convergence error behavior.
• Updated method to add power outage to pumps.
• Added a method to convert controls to rules.
• Updated the expected demand metrics to optionally specify a demand category.
• Added a function to compute valve segment attributes from a valve layer.
• Added a function to generate a randomly ordered colormap.
• Added the ability to define pressure exponents that vary throughout the network (used only by the WNTRSimulator).
• Updated controls to create speed rules for pumps.
• Bug fixes related to the pump energy calculation, value controls read in from EPANET INP files, plotting directed networks with a colorbar, and pattern start time.
• Added NotImplementedError for D-W and C-M headloss when using the WNTRSimulator.
• Updated network component attributes that store simulation results to be read-only.
• Changed results object names for friction factor, link quality, and reaction rate to match names used in EPANET.
• Updated API documentation to include a table of class properties for each network class (Junction, Tank, Pipe, etc.).
• Added support for Python 3.9

See Release Notes for more details.

Version 0.3.0 Release

• Added EPANET 2.2 as the default engine in WNTR's EpanetSimulator. EPANET 2.00.12 can still be used for backward compatibility.
  WNTR can now run PDD hydraulic simulation using EPANET or using the custom WNTRSimulator. This update also allows users to simulate tank overflow using the EpanetSimulator.
• Model options have been updated to better align with EPANET nomenclature.
• Added support for multi-point pump curves in the WNTRSimulator.
• Added support for tank volume curves in the WNTRSimulator.
• Updated tests
• Updated documentation

See Release Notes for more details.

Version 0.2.3 Release

• Fixed bug in reset_initial_values. The method now resets controls and additional network attributes needed to reset the model to initial conditions.
• Fixed bug for valve settings in the EPANET INP file writer
• Fixed bug in emitter coefficient unit conversion
• Included conda install instructions
• Added methods to add and remove fire fighting demand to a junction
• Added pipe criticality and fire flow examples
• Minor updates to support NetworkX 2.5
• Added binaries for Python 3.8
• Added testing capabilities through GitHub Actions. This includes a quick check run on Linux using Python 3.8 and a complete build run on Windows, Linux, and MacOS using Python 3.6, 3.7 and 3.8. The GitHub Action tests are initiated after push and pull requests to the master and dev branches.
• Updated tests
• Updated documentation

Version 0.2.2.1 Release

This is a bug-fix release and includes updates to assign demand and WNTRSimulator controls, see WNTR version 0.2.2.1 Release Notes for more details.

Version 0.2.2 Release

• Updated the use of NetworkX MultiDiGraph class and topographic metrics
• Added methods to groups links and nodes into segments based on the location of isolation valves
• Updated several graphics functions
• Updated the mass consumed water security metric to include a detection limit
• Updated skeletonize and other network morphology functions to be more efficient when using large networks
• Added a sensor placement optimization example
• Updated documentation and testing

See WNTR version 0.2.2 Release Notes for more details.