BaseRunReport¶
- class lsst.ctrl.bps.BaseRunReport(fields)¶
Bases:
ABC
The base class representing a run report.
- Parameters:
Attributes Summary
Extra information a method need to pass to its caller (
str
).Methods Summary
add
(run_report[, use_global_id])Add a single run info to the report.
clear
()Remove all entries from the report.
from_table
(table)Create a report from a table.
sort
(columns[, ascending])Sort the report entries according to one or more keys.
Attributes Documentation
Methods Documentation
- abstract add(run_report, use_global_id=False)¶
Add a single run info to the report.
- Parameters:
- run_report
lsst.ctrl.bps.WmsRunReport
Information for single run.
- use_global_id
bool
, optional If set, use global run id. Defaults to False which means that the local id will be used instead.
Only applicable in the context of a WMS using distributed job queues (e.g., HTCondor).
- run_report
- clear()¶
Remove all entries from the report.
- classmethod from_table(table)¶
Create a report from a table.
- Parameters:
- table
astropy.table.Table
Information about a run in a tabular form.
- table
- Returns:
- inst
lsst.ctrl.bps.bps_reports.BaseRunReport
A report created based on the information in the provided table.
- inst
- sort(columns, ascending=True)¶
Sort the report entries according to one or more keys.