Skip to content

Commit

Permalink
Add modal issue
Browse files Browse the repository at this point in the history 
- add function to stop computation if any alarm is raised
- add modal triggered when any alarm is raised
- fix logger level and add --logging_level to app arguments
- add --test_alarms as temporary test mode to force all alarms to trigger at any step
  • Loading branch information
@praffi-systemx
praffi-systemx committed Jul 7, 2022
1 parent d54084d commit 2d4b123
Show file tree
Hide file tree
Showing 5 changed files with 224 additions and 79 deletions.
155 changes: 100 additions & 55 deletions grid2game/VizServer.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
import dash_bootstrap_components as dbc
from dash import html, dcc

from grid2game._utils import (add_callbacks_temporal,
setupLayout_temporal,
add_callbacks,
from grid2game._utils import (add_callbacks_temporal,
setupLayout_temporal,
add_callbacks,
setupLayout,
add_callbacks_action_search,
setupLayout_action_search,
add_callbacks_action_search,
setupLayout_action_search,
)
from grid2game.envs import Env
from grid2game.plot import PlotGrids, PlotTemporalSeries
Expand Down Expand Up @@ -82,6 +82,20 @@ def __init__(self,
os.path.join(os.path.dirname(__file__), "assets")
)

# create the dash app
self.my_app = dash.Dash(__name__,
server=server if server is not None else True,
meta_tags=meta_tags,
assets_folder=assets_dir,
external_stylesheets=external_stylesheets,
external_scripts=external_scripts)

# Configure logging after dash initialization.
# Otherwise dash is resetting logging level to INFO

if not logging_level and build_args.logging_level:
logging_level = build_args.logging_level

if logger is None:
import logging
self.logger = logging.getLogger(__name__)
Expand All @@ -94,19 +108,14 @@ def __init__(self,
if logging_level is not None:
fh.setLevel(logging_level)
ch.setLevel(logging_level)
self.logger.setLevel(logging_level)
self.logger.addHandler(fh)
self.logger.addHandler(ch)
else:
self.logger = logger.getChild("VizServer")

# create the dash app
self.my_app = dash.Dash(__name__,
server=server if server is not None else True,
meta_tags=meta_tags,
assets_folder=assets_dir,
external_stylesheets=external_stylesheets,
external_scripts=external_scripts)
self.logger.info("Dash app initialized")

# self.app.config.suppress_callback_exceptions = True

# create the grid2op related things
Expand All @@ -125,8 +134,14 @@ def __init__(self,
# read the right config
g2op_config = self._make_glop_env_config(build_args)

if build_args.test_alarms:
test_alarms = True
else:
test_alarms = False

self.env = Env(build_args.env_name,
test=build_args.is_test,
test_alarms=test_alarms,
assistant_path=self.assistant_path,
assistant_seed=int(build_args.assistant_seed) if build_args.assistant_seed is not None else None,
logger=self.logger,
Expand Down Expand Up @@ -187,37 +202,37 @@ def __init__(self,
self.plot_grids.init_figs(self.env.obs, self.env.sim_obs)
self.real_time = self.plot_grids.figure_rt
self.forecast = self.plot_grids.figure_forecat

# initialize the layout
self._layout_temporal = html.Div(setupLayout_temporal(self),
id="all_temporal")
self._layout_temporal_tab = dcc.Tab(label='Temporal view',
value=f'tab-temporal-view',
children=self._layout_temporal)

self._layout_action_search = html.Div(setupLayout_action_search(self),
id="all_action_search")
self._layout_action_search_tab = dcc.Tab(label='Explore actions',
value='tab-explore-action',
children=self._layout_action_search)

tmp_ = setupLayout(self,
self._layout_temporal_tab,
self._layout_action_search_tab)

self.my_app.layout = tmp_

add_callbacks_temporal(self.my_app, self)
add_callbacks_action_search(self.my_app, self)
add_callbacks(self.my_app, self)

self.logger.info("Viz server initialized")

# last node id (to not plot twice the same stuff to gain time)
self._last_node_id = -1

# last action taken
self._last_action = "assistant"
self._last_action = "assistant"
self._do_display_action = True
self._dropdown_value = "assistant"

Expand Down Expand Up @@ -254,11 +269,11 @@ def run_server(self, debug=False):

def change_nb_step_go_fast(self, nb_step_go_fast):
if nb_step_go_fast is None:
return dash.no_update,
return dash.no_update,

nb = int(nb_step_go_fast)
self.nb_step_gofast = nb
return f"+ {self.nb_step_gofast}",
return f"+ {self.nb_step_gofast}",

def unit_clicked(self, line_unit, line_side, load_unit, gen_unit, stor_unit,
trigger_rt_graph, trigger_for_graph):
Expand Down Expand Up @@ -296,22 +311,24 @@ def unit_clicked(self, line_unit, line_side, load_unit, gen_unit, stor_unit,
def _reset_action_to_assistant_if_not_prev(self):
if self._last_action != "prev" :
self._next_action_is_assistant()

# handle the interaction with the grid2op environment
def handle_act_on_env(self,
step_butt,
simulate_butt,
back_butt,
reset_butt,
go_butt,
gofast_clicks,
until_game_over,
untilgo_butt,
self_loop,
state_trigger_rt,
state_trigger_for,
state_trigger_self_loop,
timer):
def handle_act_on_env(
self,
step_butt,
simulate_butt,
back_butt,
reset_butt,
go_butt,
gofast_clicks,
until_game_over,
untilgo_butt,
self_loop,
state_trigger_rt,
state_trigger_for,
state_trigger_self_loop,
timer
):
"""
dash do not make "synch" callbacks (two callbacks can be called at the same time),
however, grid2op environments are not "thread safe": accessing them from different "thread"
Expand Down Expand Up @@ -344,18 +361,21 @@ def handle_act_on_env(self,
self._go_till_go_button_shape = "btn btn-secondary"
change_graph_title = dash.no_update
update_progress_bar = 1
check_issue = dash.no_update

# now register the next computation to do, based on the button triggerd
if button_id == "step-button":
self.env.start_computation()
self.env.next_computation = "step"
self.env.next_computation_kwargs = {}
self.need_update_figures = False
check_issue = 1
elif button_id == "go_till_game_over-button":
self.env.start_computation()
self.env.next_computation = "step_end"
self.env.next_computation_kwargs = {}
self.need_update_figures = True
check_issue = 1
elif button_id == "reset-button":
self.env.start_computation()
self.env.next_computation = "reset"
Expand All @@ -378,6 +398,7 @@ def handle_act_on_env(self,
self.env.start_computation()
self.env.next_computation = "step_rec_fast"
self.env.next_computation_kwargs = {"nb_step_gofast": self.nb_step_gofast}
check_issue = 1
elif button_id == "go-button":
self.go_clicks += 1
if self.go_clicks % 2:
Expand All @@ -390,6 +411,7 @@ def handle_act_on_env(self,
self.env.start_computation()
self._button_shape = "btn btn-secondary"
self._gofast_button_shape = "btn btn-secondary"
check_issue = 1
self.env.next_computation = "step_rec"
self.env.next_computation_kwargs = {}
self.need_update_figures = False
Expand Down Expand Up @@ -434,7 +456,7 @@ def handle_act_on_env(self,
self._go_till_go_button_shape = "btn btn-secondary"
self._gofast_button_shape = "btn btn-secondary"
self._button_shape = "btn btn-secondary"

return [display_new_state,
self._button_shape,
self._button_shape,
Expand All @@ -446,7 +468,8 @@ def handle_act_on_env(self,
i_am_computing_state,
i_am_computing_state,
change_graph_title,
update_progress_bar]
update_progress_bar,
check_issue]

def _wait_for_computing_over(self):
i = 0
Expand All @@ -458,6 +481,28 @@ def _wait_for_computing_over(self):
# in this case the user should probably call reset another time !
raise dash.exceptions.PreventUpdate

def check_issue(self, n1, n_clicks):
# make sure the environment has nothing to compute
while self.env.needs_compute():
time.sleep(0.1)

issues = self.env._current_issues
if issues:
len_issues = len(issues)
if len_issues == 1:
issue_text = f"There is {len_issues} issue: "
else:
issue_text = f"There are {len_issues} issues: "
for issue in issues:
issue_text += f"{issue}, "
# Replace last ', ' by '.' to end the sentence
issue_text = '.'.join(issue_text.rsplit(', ', 1))
is_open = True
else:
is_open = False

return [is_open, issue_text]

def change_graph_title(self, change_graph_title):
# make sure that the environment has done computing
self._wait_for_computing_over()
Expand All @@ -483,7 +528,7 @@ def computation_wrapper(self, display_new_state, recompute_rt_from_timeline):
# simulate a "state" of the application that depends on the computation
if not self.env.is_computing():
self.env.heavy_compute()

if self.env.is_computing() and display_new_state != type(self).GO_MODE:
# environment is computing I do not update anything
raise dash.exceptions.PreventUpdate
Expand Down Expand Up @@ -513,7 +558,7 @@ def update_rt_fig(self, env_act):
trigger_for_graph = 1
else:
raise dash.exceptions.PreventUpdate

if trigger_rt_graph == 1:
self.fig_timeline = self.env.get_timeline_figure()

Expand Down Expand Up @@ -661,7 +706,7 @@ def _next_action_is_assistant(self):
self._last_action = "assistant"
self._do_display_action = True
self._dropdown_value = "assistant"

def display_action_fun(self,
which_action_button,
do_display,
Expand Down Expand Up @@ -712,7 +757,7 @@ def display_action_fun(self,
# i should not display the action
res = [f"{self.env.current_action}", dropdown_value, update_substation_layout_clicked_from_sub]
return res

# i need to display the action
# self._last_action = "manual"
# dropdown_value = "manual"
Expand Down Expand Up @@ -748,7 +793,7 @@ def display_action_fun(self,

if not is_modif:
raise dash.exceptions.PreventUpdate

# TODO optim here to save that if not needed because nothing has changed
res = [f"{self.env.current_action}", self._dropdown_value, update_substation_layout_clicked_from_sub]
return res
Expand Down Expand Up @@ -821,7 +866,7 @@ def display_click_data(self,
button_id == "go-button" or button_id == "gofast-button" or\
button_id == "back-button":
# i never clicked on simulate, step, go, gofast or back
do_display_action = 0
do_display_action = 0
self._last_sub_id = None
else:
# I clicked on the graph of the grid
Expand Down Expand Up @@ -980,7 +1025,7 @@ def timeline_set_time(self, time_line_graph_clicked):

def tab_content_display(self, tab):
res = [self._layout_temporal]

if tab == 'tab-temporal-view':
self.need_update_figures = True
return [self._layout_temporal]
Expand All @@ -991,13 +1036,13 @@ def tab_content_display(self, tab):
msg_ = f"Unknown tab {tab}"
self.logger.error(msg_)
return res

def _aux_tab_as_retrieve_updated_figs(self):
progress_pct = 100. * self._last_step / self._last_max_step
progress_label = f"{self._last_step} / {self._last_max_step}"
self.fig_timeline = self.env.get_timeline_figure()
self.update_obs_fig()

pbar_value = progress_pct
pbar_label = progress_label
pbar_color = self._progress_color
Expand All @@ -1006,7 +1051,7 @@ def _aux_tab_as_retrieve_updated_figs(self):
fig_rt = self.real_time
return (pbar_value, pbar_label, pbar_color, fig_timeline,
dt_label, fig_rt)

def main_action_search(self,
refresh_button,
explore_butt_pressed,
Expand All @@ -1017,9 +1062,9 @@ def main_action_search(self,
raise dash.exceptions.PreventUpdate
else:
button_id = ctx.triggered[0]['prop_id'].split('.')[0]

something_clicked = True

# TODO button color here too !
i_am_computing_state = {'display': 'block'}
pbar_value = dash.no_update
Expand All @@ -1029,25 +1074,25 @@ def main_action_search(self,
dt_label = dash.no_update
fig_rt = dash.no_update
start_computation = 1

if button_id == "refresh-button_as":
# (pbar_value, pbar_label, pbar_color, fig_timeline,
# dt_label, fig_rt) = self._aux_tab_as_retrieve_updated_figs()
start_computation = dash.no_update
# hack for it to resynch everything
self.need_update_figures = True
elif button_id == "explore-button_as":
elif button_id == "explore-button_as":
self.env.next_computation = "explore"
self.need_update_figures = True
self.env.start_computation()
else:
something_clicked = False

if not self.env.needs_compute():
# don't start the computation if not needed
i_am_computing_state = {'display': 'none'} # deactivate the "i am computing button"
start_computation = dash.no_update # I am NOT computing I DO update the graphs

if not self.env.needs_compute() and self.need_update_figures and not something_clicked:
# in this case, this should be the last call to this function after the "explore"
# function is finished
Expand All @@ -1058,7 +1103,7 @@ def main_action_search(self,

(pbar_value, pbar_label, pbar_color, fig_timeline,
dt_label, fig_rt) = self._aux_tab_as_retrieve_updated_figs()

return [start_computation,
pbar_value,
pbar_label,
Expand Down
Loading

0 comments on commit 2d4b123

Please sign in to comment.