rizer.spice.backend.api.results#

FastAPI router for the Results Explorer: browse/compare/tune plots of already-computed simulation runs.

Attributes#

Functions#

list_plot_kinds()

Return every selectable plot kind.

list_runs([include_archived])

Return every discovered simulation run under data/figures/.

list_experiments()

Return every parseable experiment CSV under data/experiments/.

get_plot_data(request)

Build trace/axis/annotation data for one plot kind.

get_custom_plot_data(request)

Build every custom-plot quantity's raw values for each requested run.

save_annotations(request)

Persist a tuned axes/annotations block without rendering an SVG.

export_svg(request)

Save the given config and render it into an SVG with matplotlib.

Module Contents#

rizer.spice.backend.api.results.router#
rizer.spice.backend.api.results.list_plot_kinds()#

Return every selectable plot kind.

rizer.spice.backend.api.results.list_runs(include_archived: bool = Query(False))#

Return every discovered simulation run under data/figures/.

rizer.spice.backend.api.results.list_experiments()#

Return every parseable experiment CSV under data/experiments/.

rizer.spice.backend.api.results.get_plot_data(request: Annotated[rizer.spice.backend.models.results_schemas.PlotDataRequest, Body()])#

Build trace/axis/annotation data for one plot kind.

rizer.spice.backend.api.results.get_custom_plot_data(request: Annotated[rizer.spice.backend.models.results_schemas.CustomPlotRequest, Body()])#

Build every custom-plot quantity’s raw values for each requested run.

rizer.spice.backend.api.results.save_annotations(request: Annotated[rizer.spice.backend.models.results_schemas.SaveAnnotationsRequest, Body()])#

Persist a tuned axes/annotations block without rendering an SVG.

rizer.spice.backend.api.results.export_svg(request: Annotated[rizer.spice.backend.models.results_schemas.ExportSvgRequest, Body()])#

Save the given config and render it into an SVG with matplotlib.