feat: add method to check progress of ongoing simulation

[jenhagg]

Purpose

Add a method to check the status endpoint in the reisejl api. This is provided for docker users to get more detailed output without having a separate shell in the server container.

What the code is doing

Other than the new method, added some basic validation on the deployment mode in the extract call since we have it defaulted to automatic when launched via the api.

Testing

Manual testing. Built the containers, launched a simulation, called check_progress.

Time estimate

5 min

Note: I am not that excited to have the environment dependent functionality here, but plan on consolidating it in the future, and keeping it limited.

[rouille]

It looks good

[jenhagg]

Some selected output from testing, for completeness

In [14]: scenario.state.check_progress()
Out[14]: {'errors': [], 'output': [], 'scenario_id': 1, 'status': 'running'}


In [16]: scenario.state.check_progress()
Out[16]:
{'errors': [],
 'output': ['Validation complete! Launching scenario with parameters:',
  "{'interval': 24, 'n_interval': 2, 'start_index': 5113, 'input_dir': '/mnt/bes/pcm/tmp/scenario_1', 'execute_dir': '/mnt/bes/pcm/tmp/scenario_1/output', 'threads': None}"],
 'scenario_id': 1,
 'status': 'running'}


In [18]: scenario.state.check_progress()
Out[18]:
{'errors': [],
 'output': ['Validation complete! Launching scenario with parameters:',
  "{'interval': 24, 'n_interval': 2, 'start_index': 5113, 'input_dir': '/mnt/bes/pcm/tmp/scenario_1', 'execute_dir': '/mnt/bes/pcm/tmp/scenario_1/output', 'threads': None}",
  'Compute Server job ID: 10e19636-8ae2-4a35-afb3-9a8a2509d173',
  "Capacity available on 'https://ip-10-0-67-145:61000' - connecting...",
  'Established HTTPS encrypted connection',
  'Reading from folder: /mnt/bes/pcm/tmp/scenario_1',
  '...loading case.mat',
  '...loading demand.csv',
  '...loading hydro.csv',
  '...loading wind.csv',
  '...loading solar.csv',
  'File case_storage.mat not found in /mnt/bes/pcm/tmp/scenario_1',
  'All scenario files loaded!',
  'linearizing'],
 'scenario_id': 1,
 'status': 'running'}

[rouille]

Some selected output from testing, for completeness

In [14]: scenario.state.check_progress()
Out[14]: {'errors': [], 'output': [], 'scenario_id': 1, 'status': 'running'}


In [16]: scenario.state.check_progress()
Out[16]:
{'errors': [],
 'output': ['Validation complete! Launching scenario with parameters:',
  "{'interval': 24, 'n_interval': 2, 'start_index': 5113, 'input_dir': '/mnt/bes/pcm/tmp/scenario_1', 'execute_dir': '/mnt/bes/pcm/tmp/scenario_1/output', 'threads': None}"],
 'scenario_id': 1,
 'status': 'running'}


In [18]: scenario.state.check_progress()
Out[18]:
{'errors': [],
 'output': ['Validation complete! Launching scenario with parameters:',
  "{'interval': 24, 'n_interval': 2, 'start_index': 5113, 'input_dir': '/mnt/bes/pcm/tmp/scenario_1', 'execute_dir': '/mnt/bes/pcm/tmp/scenario_1/output', 'threads': None}",
  'Compute Server job ID: 10e19636-8ae2-4a35-afb3-9a8a2509d173',
  "Capacity available on 'https://ip-10-0-67-145:61000' - connecting...",
  'Established HTTPS encrypted connection',
  'Reading from folder: /mnt/bes/pcm/tmp/scenario_1',
  '...loading case.mat',
  '...loading demand.csv',
  '...loading hydro.csv',
  '...loading wind.csv',
  '...loading solar.csv',
  'File case_storage.mat not found in /mnt/bes/pcm/tmp/scenario_1',
  'All scenario files loaded!',
  'linearizing'],
 'scenario_id': 1,
 'status': 'running'}

That is nice