peal.teachers.virelay_teacher.run_virelay

peal.teachers.virelay_teacher.run_virelay(project_path, output_path, port)[source]

Serve a ViReLay project until the user has saved their feedback file.

The ViReLay server runs in a separate process bound to 0.0.0.0; the function polls once per second for output_path and terminates the server once the file exists.

Parameters:
  • project_path (str) – The project yaml written by make_project().

  • output_path (str) – JSON file the user exports from the GUI; must contain selectedDataPointIndices.

  • port (int) – Port to serve on.

Returns:

The parsed contents of output_path.

Return type:

dict