Found something not working as expected in epanet-js? Reporting bugs helps us improve the tool for everyone. Thank you for taking the time to help!

Where to report

There are a few ways to let us know about problems:

1. GitHub Issues (Recommended for All Users): The best place to formally report bugs is our epanet-js GitHub Issues tracker. This allows us to track problems efficiently and is monitored closely by our development team.
2. Email (Professional & teams users only): If you have an active Professional or Teams subscription, you can report issues directly by emailing us at [email protected].
3. Community Forum (All users): If you're unsure if something is a bug, want to discuss a potential issue first, or have a general question, feel free to post on our community forum.

What to include in your report

To help us understand and fix the issue quickly, please include as much detail as possible:

• Be descriptive: Clearly explain what happened and what you expected to happen. Include any error messages you saw.
• Steps to reproduce: Provide the exact steps needed to make the bug occur reliably. This is crucial for us to diagnose the problem.
• Context: Mentioning your web browser (e.g., Chrome, Firefox) and operating system (e.g., Windows 11, macOS) can be useful.

Providing model files (.inp)

If the bug seems specific to a particular model file:

• GitHub issues / Community forum: You will generally need to upload or attach your .inp model file to the public issue or forum post so we can reproduce the problem. Please be aware that files attached here are publicly visible.
• Paid users (Email / private Support): If you are a paid user reporting via email or through dedicated support channels, you can provide your model file privately. We won’t every publish this data and will delete it once we have fix the issue and/or can replicate it without your data.

Your detailed bug reports are invaluable for making epanet-js more robust and reliable. Thanks again for your contribution!