added SWMM5 engine selector #78

bemcdonnell · 2017-03-12T05:09:03Z

Covers Issue #77

So put your DLL in the lib folder and run the following:

>>> import pyswmm
>>> pyswmm.lib.use("YourDllHere") # <-- Not a path 
>>>
>>> from pyswmm import Simulation
...

bemcdonnell · 2017-03-12T05:23:46Z

Also Covers #74

goanpeca · 2017-03-12T07:30:17Z

I think that this is not really a good solution in general :-\

The real need here is that people need to have the correct vs runtime. This is out of the scope for a python package, so this should be fixed by telling people on the readme to install the correct runtime for the specific version.

bemcdonnell · 2017-03-12T14:11:30Z

@goanpeca, I'm not sure what you mean by correct vs runtime. Could you elaborate?

This is sort of like matplotlib giving you the option to select a backend. My company has a version of swmm that has expanded capability beyond standard EPASWMM. I want the option to use either the SWMM that gets distributed with pyswmm or my company's version of swmm.

bemcdonnell · 2017-03-12T14:21:31Z

Maybe I didn't describe what this is doing well enough.

This let's you choose what swmm dll you want to use... Maybe you interpreted this as adding runtime libs to support the swmm.dll? Nope :-)

If the user has a special version of swmm, they drop their version in the lib/windows folder and then call the

'pyswmm.lib.use("swmm5-extended")'

bemcdonnell · 2017-03-12T15:13:23Z

@goanpeca this feature has lots of uses too. We can use pyswmm to run regression tests to compare old swmm engine output to new. The ability to choose an engine was an original request of @michaeltryby.

dickinsonre · 2017-03-12T15:52:02Z

@bemcdonnell One problem with using older engines of SWMM5 is that in some but not many cases the data on the line that has to be parsed is different. I do have good success with newer SWMM5 models in older versions but the SWMM5 inp file usually has to pass through the older version GUI to iron out inp problems.

bemcdonnell · 2017-03-12T16:27:13Z

@dickinsonre, you certainly raise a good point. In your experience, how many versions back to SWMM5.0 would you say there has been consistency in the structure? Assuming we can get the correct structure in place for each respective model, unless the inflow equations change fundamentally, we should be able to understand and quantify the changes in engine behavior. At the same time, that might be a "risky" exercise. This discussion might be better suited for the SWMM repo

dickinsonre · 2017-03-12T17:10:05Z

I just tried a few of the older versions with a new inp file and you are okay going back to 5.0.020 at least but older version of SWMM5 had problems with the INFIL section and other sections and did run. The pascal uexport.pas code is available for all all versions so a universal exporter may be possible (if desired).

goanpeca · 2017-03-12T17:56:50Z

@bemcdonnell I still don't understand how

If the user has a special version of swmm, they drop their version in the lib/windows folder and then call the
'pyswmm.lib.use("swmm5-extended")'

If it is special and adds extra methods, well then the whole pyswmm needs to account for these extra stuff. For older versions, its similar but I can understand this use case better.

bemcdonnell · 2017-03-12T18:27:52Z

@goanpeca, pyswmm is independent. No features will be added to pyswmm that will not work with the "common" distributed version of swmm with pyswmm. We have compiled the toolkit API into previous versions of swmm and want to take advantage of that. I see lots of value to this feature. This is also for the "power users".

The discussion is not so much on "does this add value" but more so does the implementation fit with the project. Having moved most of the Mechanics to pyswmm.lib.init.py, I have enabled us to be able to plan for future OS/ARCH and Thererin allows you to use your version of swmm.

One other great point. If you want to run your project in an older version of EPASWMM that does not have the toolkit API, the basic functionally will still work. "swmm_open" "swmm_run" have been standard entry points since swmm 5.0.

My implementation here provides a much cleaner way to select which engine you want to use. All the paths are handled automagicaly as long as your version of swmm is sitting next to the binaries that come with pyswmm.

goanpeca · 2017-03-12T18:32:11Z

Sure go ahead, was just asking to understand better ;-)

goanpeca · 2017-03-12T18:33:05Z

pyswmm/lib/__init__.py

+
+# Platform Detection
+def _platform():
+ """ Folder based on platform """


"""Folder based on platform."""

goanpeca · 2017-03-12T18:33:24Z

pyswmm/lib/__init__.py

+class _DllPath(object):
+ """
+ DllPath Object.
+ """


"""DllPath Object."""

goanpeca · 2017-03-12T18:33:33Z

pyswmm/lib/__init__.py

+ def dll_loc(self):
+ """Get/set DLL Name """
+ return self._dll_loc
+ @dll_loc.setter


Add a space here

goanpeca · 2017-03-12T18:33:38Z

pyswmm/lib/__init__.py

+ """
+ def __init__(self):
+ self._dll_loc = LIB_SWMM
+ @property


Add a space here

goanpeca · 2017-03-12T18:33:47Z

pyswmm/lib/__init__.py

+ self._dll_loc = LIB_SWMM
+ @property
+ def dll_loc(self):
+ """Get/set DLL Name """


"""Get/set DLL Name."""

goanpeca · 2017-03-12T18:33:59Z

pyswmm/lib/__init__.py

+ return self._dll_loc
+ @dll_loc.setter
+ def dll_loc(self, value):
+ """Set DLL Name """


"""Set DLL Name."""

goanpeca · 2017-03-12T18:34:03Z

pyswmm/lib/__init__.py

+ """Set DLL Name """
+ self._dll_loc = value
+ def __call__(self):
+ """ """


goanpeca · 2017-03-12T18:34:12Z

pyswmm/lib/__init__.py

+
+def use(arg):
+ """
+ Set the SWMM5 DLL


Set the SWMM5 DLL. (the period!)

added dll selector

43a1ccc

bemcdonnell added the type:enhancement label Mar 12, 2017

bemcdonnell added this to the v0.3.2 milestone Mar 12, 2017

bemcdonnell self-assigned this Mar 12, 2017

bemcdonnell requested review from goanpeca and michaeltryby March 12, 2017 05:09

bemcdonnell added 2 commits March 12, 2017 00:11

add platform check to use WinDLL

9491133

clean up

c864ab5

bemcdonnell added 2 commits March 12, 2017 00:24

clean up

ebf0b32

clean up

b55e16c

bemcdonnell changed the title ~~added dll selector~~ added SWMM5 engine selector Mar 12, 2017

goanpeca suggested changes Mar 12, 2017

View reviewed changes

bemcdonnell added 2 commits March 12, 2017 17:26

Updates to layout

cc5ad75

Updates to layout

06c26ae

bemcdonnell merged commit fca7b4b into pyswmm:master Mar 13, 2017

bemcdonnell deleted the selectdll branch March 13, 2017 13:49

openSourcerer9000 mentioned this pull request Aug 19, 2021

Problem with SWMM5 engine selector #290

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added SWMM5 engine selector #78

added SWMM5 engine selector #78

bemcdonnell commented Mar 12, 2017 •

edited

Loading

bemcdonnell commented Mar 12, 2017

goanpeca commented Mar 12, 2017

bemcdonnell commented Mar 12, 2017 •

edited

Loading

bemcdonnell commented Mar 12, 2017 •

edited

Loading

bemcdonnell commented Mar 12, 2017

dickinsonre commented Mar 12, 2017

bemcdonnell commented Mar 12, 2017

dickinsonre commented Mar 12, 2017

goanpeca commented Mar 12, 2017

bemcdonnell commented Mar 12, 2017 •

edited

Loading

goanpeca commented Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

goanpeca Mar 12, 2017

added SWMM5 engine selector #78

added SWMM5 engine selector #78

Conversation

bemcdonnell commented Mar 12, 2017 • edited Loading

bemcdonnell commented Mar 12, 2017

goanpeca commented Mar 12, 2017

bemcdonnell commented Mar 12, 2017 • edited Loading

bemcdonnell commented Mar 12, 2017 • edited Loading

bemcdonnell commented Mar 12, 2017

dickinsonre commented Mar 12, 2017

bemcdonnell commented Mar 12, 2017

dickinsonre commented Mar 12, 2017

goanpeca commented Mar 12, 2017

bemcdonnell commented Mar 12, 2017 • edited Loading

goanpeca commented Mar 12, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bemcdonnell commented Mar 12, 2017 •

edited

Loading

bemcdonnell commented Mar 12, 2017 •

edited

Loading

bemcdonnell commented Mar 12, 2017 •

edited

Loading

bemcdonnell commented Mar 12, 2017 •

edited

Loading