sbmlsim.report.experiment_report

Create report of simulation experiments.

Module Contents

Classes

ReportResults

Results for a ExperimentReport.

ExperimentReport

Report for an experiment.

Attributes

logger

TEMPLATE_PATH

sbmlsim.report.experiment_report.logger[source]
sbmlsim.report.experiment_report.TEMPLATE_PATH[source]
class sbmlsim.report.experiment_report.ReportResults[source]

Results for a ExperimentReport.

to_json(json_path)[source]

Write to JSON.

Parameters:

json_path (pathlib.Path) –

static from_json(json_path)[source]

Read from JSON.

Parameters:

json_path (pathlib.Path) –

Return type:

ReportResults

add_experiment_result(exp_result)[source]

Retrieve information for report from the ExperimentResult.

Parameters:

exp_result (sbmlsim.experiment.ExperimentResult) –

class sbmlsim.report.experiment_report.ExperimentReport(results, metadata=None, template_path=TEMPLATE_PATH)[source]

Report for an experiment.

Parameters:
class ReportType[source]

Bases: enum.Enum

Type of report.

MARKDOWN = 1[source]
HTML = 2[source]
LATEX = 3[source]
create_report(output_path, filename=None, report_type=ReportType.HTML, f_filter_context=None, **kwargs)[source]

Create report of SimulationExperiments.

Processes ExperimentResults to generate overall report.

All relative paths only can be resolved in the report if the paths are below the report or at the same level in the file hierarchy.

Parameters:
  • output_path (pathlib.Path) –

  • filename (Optional[str]) –

  • report_type (ReportType) –

  • f_filter_context (Optional[Dict]) –

Return type:

pathlib.Path