Update .rpt and .out header to indicate different codebase about stormwater-management-model HOT 13 CLOSED

I configured cmake to create the following each time the build system is generated:

/*
 *  version.h - SWMM version information
 *
 *  Created on: Nov 2, 2021
 *
 *  Author:     Michael E. Tryby
 *              US EPA - ORD/CESER
 */

#ifndef VERSION_H_
#define VERSION_H_



#define VERSION         "5.1.14"
#define VERSION_MAJOR   5
#define VERSION_MINOR   1
#define VERSION_PATCH   14

#define GIT_HASH        "8e4610611ae3d61edac53518dc65d67108b400f3"

#define BUILD_ID        "2021-11-02T14:23:31"



#endif /* VERSION_H_ */

The variables get updated automatically. What do y'all think?

from stormwater-management-model.

@jennwuu , are our build numbers always going to match the EPA build numbers? My recommendation is to be more explicit about the build numbers. So something along the lines of the example below. A little bit of a mouthful right now but my larger point is to be more explicit.

OWA STORM WATER MANAGEMENT MODEL - VERSION 5.1 (Build 5.1.14) ADAPTED FROM EPASWMM 5.1.14 SOURCE
----------------------------------------------------------------------------------------------------------------------------------

from stormwater-management-model.

I had the same thought as @cbuahin. I was thinking we should have a version.h file that contains the version, commit number, and the build number in it. We could configure cmake to create the file automatically when generating the build system.

from stormwater-management-model.

@jennwuu I am very supportive of this change. It will consistently conflict with USEPA-SWMM as we merge in changes, however. However, this isn't a big deal

from stormwater-management-model.

@jennwuu I agree with @cbuahin. It is better to be explicit with the build numbers. I propose we use EPA first and then specify the version of OWA after that, as the EPA solver is still the base of the OWA version.

EPA STORM WATER MANAGEMENT MODEL - VERSION 5.1 (Build 5.1.14/OWA Build 5.1.15)
----------------------------------------------------------------------------------------------------------------------------------

from stormwater-management-model.

@cbuahin finished up the PR. Have a look!

from stormwater-management-model.

@cbuahin finished up the PR. Have a look!

I'll put it on my agenda to review first thing tomorrow. Nice work on this.

from stormwater-management-model.

That looks really good! What about text format for .rpt file?

from stormwater-management-model.

Theses or similar information should be in the header of the SWMM5 rpt file

from stormwater-management-model.

@jennwuu I will create a PR for this. Once we are comfortable with how it works and the variables it creates we can use it to refactor the report file, CLI, and CI build/test.

from stormwater-management-model.

@michaeltryby , I recall writing functions to grab the version number when I merged 5.1.14. We should probably make sure we are not duplicating things there.

from stormwater-management-model.

@michaeltryby Following up status of .rpt file, should I make a separate ticket for .rpt for the version numbers?

from stormwater-management-model.

@jennwuu, go ahead and make a new ticket for RPT

from stormwater-management-model.