ReportOptions#

module wntr.network.options

class ReportOptions[source]#

Bases: _OptionsBase

Options related to EPANET report outputs. The values in this options class do not affect the behavior of the WNTRSimulator. These only affect what is written to an EPANET INP file and the results that are in the EPANET-created report file.

Parameters:

  • report_filename (str) – Provides the filename to use for outputting an EPANET report file, by default this will be the prefix plus “.rpt”.

  • status (str) – Output solver status (“YES”, “NO”, “FULL”). “FULL” is only useful for debugging

  • summary (str) – Output summary information (“YES” or “NO”)

  • energy (str) – Output energy information

  • nodes (None, "ALL", or list) – Output node information in report file. If a list of node names is provided, EPANET only provides report information for those nodes.

  • links (None, "ALL", or list) – Output link information in report file. If a list of link names is provided, EPANET only provides report information for those links.

  • pagesize (str) – Page size for EPANET report output

__init__(pagesize=None, report_filename=None, status='NO', summary='YES', energy='NO', nodes=False, links=False, report_params=None, param_opts=None)[source]#
classmethod factory(val)#

Create an options object based on passing in an instance of the object, a dict, or a tuple