idmtools_platform_slurm.utils.status_report.status_report module¶
This is a SlurmPlatform simulation status utility.
Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
- class idmtools_platform_slurm.utils.status_report.status_report.StatusViewer(platform: IPlatform, scope: Tuple[str, ItemType] = None)[source]¶
Bases:
object
A class to wrap the functions involved in retrieving simulations status.
- initialize() None [source]¶
Determine the experiment and build dictionary with basic info. :returns: None
- apply_filters(status_filter: Tuple[str] | None = None, job_filter: Tuple[str] | None = None, sim_filter: Tuple[str] | None = None, root: str = 'sim', verbose: bool = True) None [source]¶
Filter simulations. :param status_filter: tuple with target status :param job_filter: tuple with slurm job id :param sim_filter: tuple with simulation id :param root: dictionary root key: ‘sim’ or ‘job’ :param verbose: True/False to include simulation directory
- Returns:
None
- output_summary() None [source]¶
Output slurm job id, suite/experiment id and job directory. :returns: None
- output_status_report(status_filter: Tuple[str] | None = None, job_filter: Tuple[str] | None = None, sim_filter: Tuple[str] | None = None, root: str = 'sim', verbose: bool = True, display: bool = True, display_count: int = 20) None [source]¶
Output simulations status with possible override parameters. :param status_filter: tuple with target status :param job_filter: tuple with slurm job id :param sim_filter: tuple with simulation id :param root: dictionary root key: ‘sim’ or ‘job’ :param verbose: True/False to include simulation directory :param display: True/False to print the searched results :param display_count: how many to print
- Returns:
None
- idmtools_platform_slurm.utils.status_report.status_report.generate_status_report(platform: IPlatform, scope: Tuple[str, ItemType] = None, status_filter: Tuple[str] = None, job_filter: Tuple[str] = None, sim_filter: Tuple[str] = None, root: str = 'sim', verbose: bool = True, display: bool = True, display_count: int = 20) None [source]¶
The entry point of status viewer. :param platform: idmtools Platform :param scope: the search base :param status_filter: tuple with target status :param job_filter: tuple with slurm job id :param sim_filter: tuple with simulation id :param root: dictionary with root key: ‘sim’ or ‘job’ :param verbose: True/False to include simulation directory :param display: True/False to print the search results :param display_count: how many to print
- Returns:
None