Skip to content
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

wntr.network.options has some abnormal annotation contents #398

Open
yandongfei opened this issue Dec 19, 2023 · 1 comment
Open

wntr.network.options has some abnormal annotation contents #398

yandongfei opened this issue Dec 19, 2023 · 1 comment
Assignees

Comments

@yandongfei
Copy link

Summary
I found a possible minor error while reading the WNTR source code, so I would like to ask if it belongs to a clerical error or has other meanings. I would greatly appreciate receiving your reply.

The problem is as follows:
(Error in Version 0.4.2) There is a TimeOpiton Class in wntr.network.options Module, the comment for the timestamp parameter states that the default value is 360 seconds, but the parentheses indicate 5 minutes later. We can see in the code that the initial value of this parameter is set to 360 (seconds).
(Error in Version 1.10) There are two parameters in Class TimeOpiton , named quality Timestep_ and rule Timestep_. It was mentioned in the comment that the default value for this parameter is 360 (seconds), but the parentheses in the comment state 5 minutes.
Are there any errors in this?

Example
[Optional] Include an example. The example can use INP files from the examples folder.

Environment
[Optional] Provide information on your computing environment.

  • Operating system:
  • Python version: 3.7 / 3.9
  • WNTR version: 0.4.2 / 1.1.0
@kaklise
Copy link
Collaborator

kaklise commented Jan 2, 2024

Thanks for catching this. These values should match the EPANET default values of 6 minutes (1/10 of the hydraulic timestep). The values are correct, but we need to update the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants