Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is to create a discussion around an approach to address #382
The changes in this PR at the time of its submission restore the EPA version management approach (constant int defined in consts.h). The EPA versioning is maintained to define the EPA engine upon which the pyswmm-SWMM code is based. When changes are made in EPA code, they (along with the version definition) will be merged into this fork without updating the version defined in the swmm-solver cmake project.
The swmm-solver version that is defined in the CMakeLists.txt file is repurposed to define the version of the toolkit API. As changes are made to the toolkit api, the swmm-solver version should be incremented accordingly.
The EPA report file header is restored to document the EPA engine version that was used to run the simulation. A second header line is added to the report file to document the pyswmm toolkit version included in the engine used to run the simulation. Restoring the EPA header to the first line of the rpt file has the added benefit of making it compatible with PCSWMM gui software, where as previously the OWA header would prevent the PCSWMM from parsing the rpt file properly.
In addition to these changes, I'd like to discuss revising code annotations in the source code. Previously the SWMM model was defined as OWA SWMM. Since the project has migrated away from OWA, I am wondering if we should rebrand the source code accordingly. I propose instances of "OWA" or "Open Water Analytics" in the source code by replaced with "pyswmm". Thoughts?
Since the rpt file header has changed, regression tests will fail until this new engine is used to generate new benchmark files with the updated rpt header.
@bemcdonnell @abhiramm7 @michaeltryby