oopnet.utils package

Subpackages

• oopnet.utils.adders package
  • Submodules
  • oopnet.utils.adders.add_element module
    • add_curve()
    • add_junction()
    • add_link()
    • add_node()
    • add_pattern()
    • add_pipe()
    • add_pump()
    • add_reservoir()
    • add_rule()
    • add_tank()
    • add_valve()
  • Module contents
• oopnet.utils.getters package
  • Submodules
  • oopnet.utils.getters.element_lists module
    • get_controls()
    • get_curve_ids()
    • get_curves()
    • get_energy_entries()
    • get_inflow_node_ids()
    • get_inflow_nodes()
    • get_junction_ids()
    • get_junctions()
    • get_link_ids()
    • get_links()
    • get_node_ids()
    • get_nodes()
    • get_pattern_ids()
    • get_patterns()
    • get_pipe_ids()
    • get_pipes()
    • get_pump_ids()
    • get_pumps()
    • get_reservoir_ids()
    • get_reservoirs()
    • get_rule_ids()
    • get_rules()
    • get_tank_ids()
    • get_tanks()
    • get_valve_ids()
    • get_valves()
  • oopnet.utils.getters.get_by_id module
    • get_curve()
    • get_junction()
    • get_link()
    • get_node()
    • get_pattern()
    • get_pipe()
    • get_pump()
    • get_reservoir()
    • get_rule()
    • get_tank()
    • get_valve()
  • oopnet.utils.getters.property_getters module
    • get_basedemand()
    • get_coordinates()
    • get_diameter()
    • get_elevation()
    • get_endnodes()
    • get_length()
    • get_link_comment()
    • get_linkcenter_coordinates()
    • get_minorloss()
    • get_node_comment()
    • get_roughness()
    • get_setting()
    • get_startendcoordinates()
    • get_startendnodes()
    • get_startnodes()
    • get_status()
    • get_xcoordinate()
    • get_ycoordinate()
  • oopnet.utils.getters.topology_getters module
    • get_adjacent_links()
    • get_inflow_neighbor_nodes()
    • get_neighbor_links()
    • get_neighbor_nodes()
    • get_next_neighbor_links()
    • get_next_neighbor_nodes()
  • oopnet.utils.getters.vectors module
    • v_demand()
    • v_diameter()
    • v_elevation()
    • v_emittercoefficient()
    • v_head()
    • v_initlevel()
    • v_length()
    • v_maxlevel()
    • v_minlevel()
    • v_minorloss()
    • v_minvolume()
    • v_roughness()
    • v_tankdiameter()
  • Module contents
• oopnet.utils.removers package
  • Submodules
  • oopnet.utils.removers.remove_element module
    • remove_junction()
    • remove_link()
    • remove_node()
    • remove_pipe()
    • remove_pump()
    • remove_reservoir()
    • remove_tank()
    • remove_valve()
  • Module contents

Submodules

oopnet.utils.oopnet_logging module

oopnet.utils.oopnet_logging.logging_decorator(logger)

Decorates a function to log exceptions.

Parameters:

logger (Logger) – logger to be used for logging

Returns:

decorated function

oopnet.utils.oopnet_logging.start_logger(level=20)

Initializes a RotatingFileHanlder and a StreamHandler for logging.

This function creates a logger with two handlers (RotatingFileHandler and StreamHandler) that can come in handy, if no other logging handlers are being used. The RotatingFileHandler writes it’s output to ‘oopnet.log’ and rotates the file when it reaches a size of 5 MB.

Parameters:

level (Union[int, str]) – logging level (e.g., logging.DEBUG)

Return type:

Logger

Returns:

logger object

oopnet.utils.timer module

oopnet.utils.timer.tic()

Start stopwatch timer.

oopnet.utils.timer.time_it(func)

Decorates a function to measure its execution time.

Parameters:

func – callable to time

Returns:

decorated function

oopnet.utils.timer.toc()

Read elapsed time from stopwatch.

oopnet.utils.utils module

oopnet.utils.utils.copy(network)

This function makes a deepcopy of an OOPNET network object

Parameters:

network – OOPNET network object

Returns:

deepcopy of OOPNET network object

oopnet.utils.utils.make_measurement(report, sensors, precision=None)

This function simulates a measurement in the system at predefined sensorpositions and returns a measurement vector

Parameters:

• report (SimulationReport) – OOPNET report object

• sensors (dict) – dict with keys ‘Flow’ and/or ‘Pressure’ containing the node- resp. linkids as list

-> {‘Flow’:[‘flowsensor1’, ‘flowsensor2], ‘Pressure’:[‘sensor1’, ‘sensor2’, ‘sensor3’]}

precision: dict with keys ‘Flow’ and/or ‘Pressure’ and number of decimals -> {‘Flow’:3, ‘Pressure’:2} report: SimulationReport: sensors: dict: precision: Optional[dict]: (Default value = None)

Returns:

numpy vector containing the measurements

oopnet.utils.utils.mkdir(newdir)

Creates a new directory.

• already exists, silently complete

• regular file in the way, raise an exception

• parent directory(ies) does not exist, make them as well

Parameters:

newdir (str) – path to be created

Returns:

Module contents