sbmlsim.report.experiment_report
¶
Create report of simulation experiments.
Module Contents¶
Classes¶
Results for a ExperimentReport. |
|
Report for an experiment. |
Attributes¶
- class sbmlsim.report.experiment_report.ReportResults[source]¶
Results for a ExperimentReport.
- static from_json(json_path)[source]¶
Read from JSON.
- Parameters:
json_path (pathlib.Path) –
- Return type:
- 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:
results (ReportResults) –
metadata (Dict) –
- 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