Merge pull request #37 from SWMM-Project/dev

Merge OWA/swmm-python <- SWMM-Project/swmm-python

Author: michaeltryby

.gitignore

@@ -2,27 +2,24 @@
 #  .gitignore for swmm-python repo
 #
 
+
 .*
 !.gitignore
+!.gitmodules
+.DS_Store
 
-*.py[ocd]
+*.pyc
 
-*.dll
-*.lib
-*.exp
-*.so
-*.h
-buildlib/
+_skbuild/
+_cmake_test_compile
 
-build/
 dist/
+MANIFEST
 .pytest_cache/
+__pycache__/
 *.egg-info/
 
-output.py
-output_wrap.c
-
-toolkit.py
-toolkit_wrap.c
+swmm-toolkit/docs/_build
 
-swmm_python/toolkit/tests/data/test.*
+swmm-toolkit/tests/data/*
+!test_*.*

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "swmm-toolkit/swmm-solver"]
+	path = swmm-toolkit/swmm-solver
+	url = https://github.com/SWMM-Project/swmm-solver.git

README.md

@@ -1,16 +1,7 @@
 # swmm-python
 
 
-## Build Status
-[![Build status](https://ci.appveyor.com/api/projects/status/g13vapirwhinmtob/branch/dev?svg=true)](https://ci.appveyor.com/project/michaeltryby/swmm-python/branch/dev)
-
-[![Coverage Status](https://coveralls.io/repos/github/michaeltryby/swmm-python/badge.svg)](https://coveralls.io/github/michaeltryby/swmm-python)
-
-
 ## Contents
-* swmm-python - SWIG based wrappers for the SWMM Toolkit and Output libraries.
+* nrtest-swmm  - Plugin for performing numerical regression testing on swmm-solver.
+* swmm-toolkit - SWIG based wrappers for the swmm-solver and swmm-output libraries.
 * ...
-
-
-## Build Notes
-Note that swmm-python wraps the feature-wrapper branch of SWMM v5.1.12.  

appveyor.yml

@@ -37,4 +37,4 @@ artifacts:
 cache:
   - C:\ProgramData\chocolatey\bin -> appveyor.yml
   - C:\ProgramData\chocolatey\lib -> appveyor.yml
-  - C:\projects\swmm-python\.tox -> tox.ini
+#  - C:\projects\swmm-python\.tox -> tox.ini

before_build.bat

@@ -0,0 +1,150 @@
+# -*- coding: utf-8 -*-
+
+#
+#  main.py
+#
+#  Author:     Michael E. Tryby
+#              US EPA - ORD/NRMRL
+#
+'''
+Provides entry point main. Useful for development and testing purposes.
+'''
+
+import cStringIO
+
+import time
+
+import header_detail_footer as hdf
+import numpy as np
+
+import nrtest_swmm.output_reader as ordr
+
+def result_compare(path_test, path_ref, comp_args):
+
+    isclose = True
+    close = 0
+    notclose = 0
+    equal = 0
+    total = 0
+    output = cStringIO.StringIO()
+    eps =  np.finfo(float).eps
+
+    start = time.time()
+
+    test_reader = ordr.output_generator(path_test)
+    ref_reader = ordr.output_generator(path_ref)
+
+    for test, ref in _zip(test_reader, ref_reader):
+        total += 1
+        if total%100000 == 0:
+        print(total)
+
+        if len(test) != len(ref):
+            raise ValueError('Inconsistent lengths')
+
+        # Skip results if they are zero or equal
+        if np.array_equal(test, ref):
+            equal += 1
+            continue
+        else:
+            try:
+                np.testing.assert_allclose(test, ref, comp_args[0], comp_args[1])
+                close += 1
+
+            except AssertionError as ae:
+                notclose += 1
+                output.write(str(ae))
+                output.write('\n\n')
+                continue
+
+    stop = time.time()
+
+    print(output.getvalue())
+    output.close()
+
+    print('equal: %d  close: %d  notclose: %d  total: %d  in %f (sec)\n' %
+          (equal, close, notclose, total, (stop - start)))
+
+    if notclose > 0:
+        print('%d differences found\n' % notclose)
+        isclose = False
+
+    return isclose
+
+def array_zero(test, ref):
+    if not test.any() and not ref.any():
+        return True
+    return False
+
+def report_compare(path_test, path_ref, (comp_args)):
+    '''
+    Compares results in two report files ignoring contents of header and footer.
+    '''
+    with open(path_test ,'r') as ftest, open(path_ref, 'r') as fref:
+        for (test_line, ref_line) in zip(hdf.parse(ftest, 4, 4)[1],
+                                         hdf.parse(fref, 4, 4)[1]):
+            if test_line != ref_line:
+                return False
+
+    return True
+
+
+import logging
+from os import listdir
+from os.path import exists, isfile, isdir, join
+
+from nrtest.testsuite import TestSuite
+from nrtest.compare import compare_testsuite, validate_testsuite
+from nrtest.execute import execute_testsuite
+
+def nrtest_compare(path_test, path_ref, rtol, atol):
+
+    ts_new = TestSuite.read_benchmark(path_test)
+    ts_old = TestSuite.read_benchmark(path_ref)
+
+    if not validate_testsuite(ts_new) or not validate_testsuite(ts_old):
+        exit(1)
+
+    try:
+        logging.info('Found %i tests' % len(ts_new.tests))
+        compatible = compare_testsuite(ts_new, ts_old, rtol, atol)
+    except KeyboardInterrupt:
+        logging.warning('Process interrupted by user')
+        compatible = False
+    else:
+        logging.info('Finished')
+
+    # Non-zero exit code indicates failure
+    exit(not compatible)
+
+def nrtest_execute(app_path, test_path, output_path):
+
+
+    for p in test_path + [app_path]:
+        if not exists(p):
+            logging.error('Could not find path: "%s"' % p)
+
+    test_dirs = [p for p in test_path if isdir(p)]
+    test_files = [p for p in test_path if isfile(p)]
+    test_files += [join(d, p) for d in test_dirs for p in listdir(d)
+                   if p.endswith('.json')]
+
+    test_files = list(set(test_files))  # remove duplicates
+
+    ts = TestSuite.read_config(app_path, test_files, output_path)
+
+    if not validate_testsuite(ts):
+        exit(1)
+
+    try:
+        logging.info('Found %i tests' % len(test_files))
+        success = execute_testsuite(ts)
+        ts.write_manifest()
+    except KeyboardInterrupt:
+        logging.warning('Process interrupted by user')
+        success = False
+    else:
+        logging.info('Finished')
+
+    # Non-zero exit code indicates failure
+    exit(not success)

nrtest-swmm/main.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+
+#
+#  __init__.py - nrtest_swmm module
+#
+#  Author:     Michael E. Tryby
+#              US EPA - ORD/NRMRL
+#
+
+'''
+Numerical regression testing (nrtest) plugin for comparing SWMM binary results
+files and SWMM text based report files.
+'''
+
+# third party imports
+import header_detail_footer as hdf
+import numpy as np
+
+# project imports
+import nrtest_swmm.output_reader as ordr
+
+
+__author__ = "Michael E. Tryby"
+__copyright__ = "None"
+__credits__ = "Colleen Barr, Maurizio Cingi, Mark Gray, David Hall, Bryant McDonnell"
+__license__ = "CC0 1.0 Universal"
+
+__version__ = "0.6.0"
+__date__ = "May 8, 2020"
+
+__maintainer__ = "Michael E. Tryby"
+__email__ = "[email protected]"
+__status  = "Development"
+
+
+def swmm_allclose_compare(path_test, path_ref, rtol, atol):
+    '''
+    Compares results in two SWMM binary files. Using the comparison criteria
+    described in the numpy assert_allclose documentation.
+
+        (test_value - ref_value) <= atol + rtol * abs(ref_value)
+
+    Returns true if all of the results in the two binary files meet the
+    comparison criteria; otherwise, an AssertionError is thrown.
+
+    Numpy allclose is quite expensive to evaluate. Test and reference results
+    are checked to see if they are equal before being compared using the
+    allclose criteria. This reduces comparison times significantly.
+
+    Arguments:
+        path_test - path to result file being tested
+        path_ref  - path to reference result file
+        rtol - relative tolerance
+        atol - absolute tolerance
+
+    Returns:
+        True or raises an error
+
+    Raises:
+        ValueError()
+        AssertionError()
+        ...
+    '''
+
+    for (test, ref) in zip(ordr.output_generator(path_test),
+                           ordr.output_generator(path_ref)):
+
+        if len(test[0]) != len(ref[0]):
+            raise ValueError('Inconsistent lengths')
+
+        # Skip over results if they are equal
+        if (np.array_equal(test[0], ref[0])):
+            continue
+
+        else:
+            np.testing.assert_allclose(test[0], ref[0], rtol, atol)
+
+    return True
+
+#def swmm_better_compare():
+#    '''
+#    If for some reason you don't like numpy.testing.assert_allclose() add a
+#    better function here. Be sure to add the entry point to the setup file so
+#    nrtest can find it at runtime.
+#    '''
+#    pass
+
+def swmm_report_compare(path_test, path_ref, rtol, atol):
+    '''
+    Compares results in two report files ignoring contents of header and footer.
+
+    Arguments:
+        path_test - path to result file being tested
+        path_ref  - path to reference result file
+        rtol - ignored
+        atol - ignored
+
+    Returns:
+        True or False
+
+    Raises:
+        HeaderError()
+        FooterError()
+        RunTimeError()
+        ...
+    '''
+
+    HEADER = 4
+    FOOTER = 4
+
+    with open(path_test ,'r') as ftest, open(path_ref, 'r') as fref:
+
+        for (test_line, ref_line) in zip(hdf.parse(ftest, HEADER, FOOTER)[1],
+                                         hdf.parse(fref, HEADER, FOOTER)[1]):
+
+            if test_line != ref_line:
+                return False
+
+    return True