Stormwater-Management-Model icon indicating copy to clipboard operation
Stormwater-Management-Model copied to clipboard

Published 20 hours ago • verified publisher icon USEPA

Documentation issues

Open MitchHeineman opened this issue 2 years ago • 4 comments

Swmm5_API_Guide.chm: Under "Output File - Reporting Variables", the file reads "Number of system-wide variables (currently 14)". However, there are 15 variables, as they're indexed from 0 to "14 for potential evaporation rate (PET) (in/day or mm/day" (closing parenthesis missing). This discrepancy has likely been present since PET was added to the system variable list in version 5.1.010 (08/05/15).

MitchHeineman avatar Nov 17 '22 17:11 MitchHeineman

Section D.2 of the User's Manual describing the Input File Format lacks an entry for the [EVENTS] section.

Similarly, Section D.3 describing the mapping components used by the EPA GUI does not mention the [PROFILES] and [TAGS] sections.

MitchHeineman avatar Aug 08 '23 18:08 MitchHeineman

Thanks for the heads up @MitchHeineman. I will work on addressing it in the next release.

cbuahin avatar Aug 08 '23 18:08 cbuahin

[EVENTS] is relatively new and the user manual is somewhat older. All all new features added back into the user manual?

dickinsonre avatar Aug 08 '23 20:08 dickinsonre

The manual was updated in 2022 and includes STREETS, INLETS, and INLET_USAGE; EVENTS were added in 2016! The functionality is discussed in the manual; it's just missing from the Command Line presentation in Appendix D.

MitchHeineman avatar Aug 08 '23 20:08 MitchHeineman