gym_anm.envs.anm6_env.rendering.py.rendering.start

gym_anm.envs.anm6_env.rendering.py.rendering.start(title, dev_type, p_max, q_max, s_rate, v_magn_min, v_magn_max, soc_max, costs_range)[source]

Start visualizing the state of the environment in a new browser window.

Parameters:

  • title (str) – The title to give to the visualization, usually the name of the environment.

  • dev_type (list of int) – The type of each device connected to the network.

  • p_max (list of float) – The maximum absolute real power injection of each device (MW).

  • q_max (list of float) – The maximum absolute reactive power injection of each device (MVAr).

  • s_rate (list of float) – The transmission line apparent power ratings (MVA).

  • v_magn_min (list of float) – The minimum voltage magnitude allowed at each bus (pu).

  • v_magn_max (list of float) – The maximum voltage magnitude allowed at each bus (pu).

  • soc_max (list of float) – The maximum state of charge of each storage unit (MWh).

  • costs_range (tuple of int) – The maximum absolute energy loss costs_clipping[0] and the maximum constraints violation penalty (parts of the reward function).

Returns:

  • http_server (HttpServer) – The HTTP server serving the visualization.

  • ws_server (WsServer) – The WebSocket server used for message exchanges between the environment and the visualization.