-
Notifications
You must be signed in to change notification settings - Fork 77
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update .rpt text to indicate OWA SWMM codebase #365
Comments
We should close this issue in the next release since #352 is closed. Can we decide on the header text for the .rpt file? |
@jennwuu and @michaeltryby, How about this?
|
This is what is in there now. It seems fine.
I don't think we should add another line to the header as that may throw off someone parsing the report. |
@michaeltryby I agree. adding the SHA is probably redundant. |
@michaeltryby PCSWMM parses text between brackets to relay build information from .rpt. Can we add OWA in the bracket to something like this?
|
@michaeltryby i think we are converging
|
We are moving to semantic version standard - major, minor, patch. Previously, patch was being referred to as build but technically that's not accurate. In the version header I created BUILD_ID is a time stamp. |
so @michaeltryby, for example....
|
Why does OWA need to be in there twice? In case they don't see it the first time? |
@michaeltryby PCSWMM parses text between brackets to relay build information from .rpt. Can we include additional OWA text in the bracket? |
Let's go with your choice for now:
|
We have new variables in the swmm.dll that encode more version and build information than ever before. We should get away from parsing the report file for information and create and use APIs. |
@michaeltryby, we can circle back before the next release. |
This issue is resolved in #372 |
Related to discussion from #352
It is important user understands the source of model results [re-replicating results, documentation, etc]. When a user views .rpt, the header is not descriptive to indicate which source of engine used. I think this is important as we add more features in the api.
At the moment, the .rpt file shows:
The text was updated successfully, but these errors were encountered: