experimentum.WebGUI.views package

Submodules

experimentum.WebGUI.views.dashboard module

Contains all views/routes for the dashboard.

The dashboard lists: * all available experiments * all migrations and their status

  • Upgrade migrations
  • Downgrade migrations
  • Refresh Migrations
experimentum.WebGUI.views.dashboard.dashboard()

Displays the dashboard template.

Returns:HTML Template
Return type:str

experimentum.WebGUI.views.experiments module

Contains all views/routes for the experiments.

It should call experiments:run to run an experiment, show the ouput log and performance table, and show the generated plots and charts if available.

Available Routes for:
  • Running Experiments
  • Showing Plots and Charts of experiments
experimentum.WebGUI.views.experiments.plots(experiment)

Show plots and charts for experiment.

Parameters:experiment (str) – Name of experiment
Returns:HTML template
Return type:str
experimentum.WebGUI.views.experiments.run(experiment)

Run an experiment.

Parameters:experiment (str) – Name of the experiment
Returns:HTML template, or event stream for experiment log
Return type:str|Response
experimentum.WebGUI.views.experiments.run_experiment(exp_thread, capturer, experiment)

Experiment runner, which monitors and yields the thread output.

Parameters:
  • exp_thread (Thread) – Thread which runs the experiment.
  • capturer (CapturedContent) – Capturer the capture the thread output.
  • experiment (Experiment) – experiment measurement.

experimentum.WebGUI.views.migrations module

Contains all views/routes for the migrations.

Available Routes for:
  • Upgrading Migrations
  • Downgrading Migrations
  • Refreshing Migrations
  • Getting Migration Status
experimentum.WebGUI.views.migrations.downgrade()

Downgrade the migration and send a json status message.

Returns:json status message
Return type:Response
experimentum.WebGUI.views.migrations.get_migration_status()

Get the current migration status.

Returns:list of migrations with their status (i.e. migrated or not)
Return type:list
experimentum.WebGUI.views.migrations.make()

Make a new migration.

Returns:json status message
Return type:Response
experimentum.WebGUI.views.migrations.refresh()

Refresh all migrations and send a json status message.

Returns:json status message
Return type:Response
experimentum.WebGUI.views.migrations.status()

Return the migration status as an html template.

Returns:HTML migration status template
Return type:Response
experimentum.WebGUI.views.migrations.upgrade()

Upgrade the migration and send a json status message.

Returns:json status message
Return type:Response

experimentum.WebGUI.views.plots module

Contains all views/routes for the plots.

Available Routes for:
  • Generating plots of an experiment
  • Exporting plots of an experiment
  • Serving plot image files
experimentum.WebGUI.views.plots.export(experiment)

Download all plots for an experiment.

Parameters:experiment (str) – Name of the experiment.
Returns:File Download
Return type:Response
experimentum.WebGUI.views.plots.generate(experiment)

Generate all plots for an experiment.

Parameters:experiment (str) – Name of the experiment.
Returns:Redirects to plot overview.
Return type:Response
experimentum.WebGUI.views.plots.generate_ajax(experiment)

Genereate all plots for an experiment.

Parameters:experiment (str) – Name of the experiment.
Returns:JSON with status messages
Return type:str
experimentum.WebGUI.views.plots.generate_plots(directory, container, experiment)

Generate all plots for an experiment.

Parameters:
  • directory (str) – Plot Upload directory.
  • container (App) – Service Container.
  • experiment (str) – Name of the experiment.
Returns:

list of status messages.
Return type:

list
experimentum.WebGUI.views.plots.image(experiment, filename)

Serve plot images from the plot graphics directory.

Parameters:
  • experiment (str) – Name of the experiment.
  • filename (str) – Name of the plot.
Returns:

Plot graphics
Return type:

obj

Module contents

Contains routes and views for the web server.