Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

MTP 2

Jump to bottom
Mark Gray edited this page Jun 15, 2016 · 2 revisions

June 15, 2016

This page describes the contents of MTP #2, including a description of the capabilities, installation instructions, instructions for running the software, test sequences and results, and system documentation.

Description of Capabilities

This MTP (Minimum Testable Product) is released for testing of specific functionality. This is not a fully functional product and is not suitable for production use. This MTP provides user interfaces for SWMM and EPANET. Using the software, a user may open an existing SWMM or EPANET project, edit options/settings, save the project file, run the simulation, and analyze model results. In addition, the user may run Python scripts interactively and may create plug-ins which provide additional functionality and interact with the project settings and outputs.

The following new capabilities are included in this release:

  • Editing additional SWMM project sections: Aquifers, Climatology: Evaporation, Climatology: Temperature, Wind Speed, Snow Melt, Control Rules, Cross-Section, Curves, Groundwater Flow, Infiltration, Inflows, Dry Weather Inflows (Junction, Inflows, Dry Weather), RDI Inflows, Initial Buildup [LOADING], Land Uses: General, Land Uses (Buildup), Land Uses (Washoff), Land Use Assignment [COVERAGES], LID Controls, LID Usage, Pollutants, Snow Packs, Time Patterns, Time-Series, Transects, Treatment, Unit Hydrograph
  • Editing additional EPANET project sections: Time Patterns, Curves, Controls, Demands, Sources
  • Read binary output from both models
  • Reports and graphs for SWMM output:
  • Status Report
  • Summary Report
  • Table Report
  • Time-Series Graphs
  • Scatter Plot
  • Reports and graphs for EPANET output:
  • Status Report
  • Full Text Report (not yet complete, waiting for availability of energy information)
  • Table Report
  • Time-Series Graphs
  • Profile Plot
  • Frequency Plot
  • Help system is now available for both models with context-sensitive reaction to the Help key - F1, opening to the section appropriate to the current window. (Help contents to be updated to reflect the new interface in the future.)
  • Several suggested improvements from previous MTP:
  • Run EPANET model using DLL calls and providing detailed progress information instead of running EXE
  • Make sure binary and text outputs are directed to the intended files
  • Make forms look good with different user-selected system font sizes
  • Add documentation for using Inno Setup as final packaging step

Installation Instructions

Windows (64-bit) installation packages for SWMM and EPANET can be obtained from the following links:

https://github.com/USEPA/SWMM-EPANET_User_Interface/releases/download/MTP2/EPANET-UI-MTP2.exe

https://github.com/USEPA/SWMM-EPANET_User_Interface/releases/download/MTP2/SWMM-UI-MTP2.exe

Run EPANET-UI_MTP2.exe to install EPANET or run SWMM-UI-MTP2.exe to install SWMM. NOTE: Do not install in "Program Files" or "Program Files (x86)" because running the models and reading model outputs may not function properly in these folders.

Instructions for Running the Software

To run SWMM:

From the desktop shortcut or from the start menu, double-click on SWMM-UI.

The following window will appear:

From the 'File' menu, choose 'Open'. You will be prompted to open a SWMM input (.inp) file.

With a SWMM input file open, many project sections displayed in the tree diagram are available for viewing and editing. Items that are functional will either open an editing dialog when double-clicked or will populate the list in the lower-left corner.

After the desired edits are complete, the project can be saved using the 'File:Save' menu item.

The simulation can be run by clicking the lightening bolt icon or through the 'Project:Run Simulation' menu item.

The 'Plugins' menu is used for accessing scripting and plug-in options.

From 'Plugins:Scripting:IPython', the user can produce a window with an IPython prompt for running commands.

For example, the user could enter the following text to change the minimum slope to 0.05:

session.project.options.min_slope = 0.05

From 'Plugins:Scripting:Exec', the user is prompted for the name of a .py file containing a Python script. After identifying the script, the script will automatically be executed.

The 'Plugins' menu also includes a menu for selecting each of the plugins within the installation 'plugins' folder. This installation package includes a sample plugin which adds a 'Summary' menu to the user interface with several submenus.

To run EPANET:

From the desktop shortcut or from the start menu, double-click on EPANET-UI.

The following window will appear:

From the 'File' menu, choose 'Open'. You will be prompted to open an EPANET input (.inp) file.

As with the SWMM project, when an EPANET input file is open, several project sections are available for testing. Click any of these sections and an editing dialog will appear or the list of items will be populated in the lower-left corner.

Test Sequences and Results

Unit tests are provided in the folder test/core/swmm and test/core/epanet. To run these tests, run the python script test_all within each folder. User interface tests are available in test/ui. A full testing report is available at:

https://cdn.rawgit.com/USEPA/SWMM-EPANET_User_Interface/master/doc/EPATestingReport_MTP2.docx

System Documentation

System documentation including class diagrams can be found here:

https://cdn.rawgit.com/USEPA/SWMM-EPANET_User_Interface/master/doc/Doxygen/html/index.html

Known Limitations

The installation packages run only on 64-bit Windows computers.

Clone this wiki locally