API Documentation
- Command Arguments and Base Configuration
- Pavilion Builder Objects
- pavilion.pav_test module
TestBuilderTestBuilder.BUILD_HASH_BYTESTestBuilder.DEPRECATEDTestBuilder.DOWNLOAD_HASH_SIZETestBuilder.FINISHED_SUFFIXTestBuilder.LOG_NAMETestBuilder.TAR_SUBTYPESTestBuilder.build()TestBuilder.build_hashTestBuilder.copy_build()TestBuilder.create_spack_env()TestBuilder.deprecate()TestBuilder.exists()TestBuilder.log_updated()TestBuilder.name_build()TestBuilder.rehash_name()TestBuilder.rename_build()TestBuilder.suite_subdir
- pavilion.pav_test module
- Command Plugins
- pavilion.commands module
- Included Command Plugins
- cancel command
- clean command
- log command
- result command
- run command
- set_status command
- show command
ShowCommandShowCommand.BUILD_KEYSShowCommand.DOC_KEYSShowCommand.INHERITANCE_KEYSShowCommand.PERMUTATION_KEYSShowCommand.RESULT_KEYSShowCommand.RUN_KEYSShowCommand.SCHEDULING_KEYSShowCommand.SUMMARY_SIZE_LIMITShowCommand.run()ShowCommand.show_configs_table()ShowCommand.show_full_config()ShowCommand.show_vars()
- status command
- view command
- wait command
- Dir Database
- Expression Function Plugins
get_plugin()list_plugins()register_core_plugins()- FunctionPlugin Base Classes
num()flag()sopt()opt()OptMaybeListFunctionPluginFunctionPlugin.VALID_SPEC_TYPESFunctionPlugin.NAME_REFunctionPlugin.PRIO_COREFunctionPlugin.PRIO_COMMONFunctionPlugin.PRIO_USERFunctionPlugin.coreFunctionPlugin.pathFunctionPlugin.signatureFunctionPlugin.long_descriptionFunctionPlugin.activate()FunctionPlugin.deactivate()FunctionPlugin.register_core_plugins()
- Core Function Plugins
AllPluginAnyPluginAvgPluginCeilPluginCoreFunctionPluginFactorsPluginFlagPluginFloorPluginHighPassFilterIntPluginKeysPluginLenPluginLogPluginLowPassFilterMaxPluginMidFactorsPluginMinPluginMultipleOfTwoPluginOptPluginOutliersRandomPluginRangeRegexSearchReplaceRoundDigPluginRoundPluginSoptPluginSqrtSumPlugin
- Pavilion Job Objects
- Logging
- Miscellaneous Modules
- Module Wrapper Plugins
- pavilion.module_wrapper module
ModuleWrapperModuleWrapper.EMODModuleWrapper.LMODModuleWrapper.NAME_VERS_REModuleWrapper.NONEModuleWrapper.PRIO_COMMONModuleWrapper.PRIO_COREModuleWrapper.PRIO_USERModuleWrapper.activate()ModuleWrapper.deactivate()ModuleWrapper.get_version()ModuleWrapper.load()ModuleWrapper.pathModuleWrapper.swap()ModuleWrapper.unload()
ModuleWrapperErrorModuleWrapperViaConfigadd_wrapped_module()get_module_wrapper()list_module_wrappers()parse_module()remove_wrapped_module()
- pavilion.module_actions module
- pavilion.module_wrapper module
- Utilities
- Parser Components
- Pavilion Parsing (test_config.parsers)
- Shared Parser Components
- The String Parser
- The Expression Parser
BaseExprTransformerBaseExprTransformer.BOOL()BaseExprTransformer.ESCAPED_STRING()BaseExprTransformer.FLOAT()BaseExprTransformer.INTEGER()BaseExprTransformer.NUM_TYPESBaseExprTransformer.add_expr()BaseExprTransformer.and_expr()BaseExprTransformer.compare_expr()BaseExprTransformer.conc_expr()BaseExprTransformer.expr()BaseExprTransformer.function_call()BaseExprTransformer.list_()BaseExprTransformer.literal()BaseExprTransformer.math_expr()BaseExprTransformer.mult_expr()BaseExprTransformer.negative()BaseExprTransformer.not_expr()BaseExprTransformer.or_expr()BaseExprTransformer.paren_expr()BaseExprTransformer.pow_expr()BaseExprTransformer.primary()BaseExprTransformer.start()
EvaluationExprTransformerExprTransformerVarRefVisitorget_expr_parser()
- Results
check_config()prune_result_log()remove_temp_results()- Base Results
- Result Parsers
ResultParserResultParser.FORCE_DEFAULTSResultParser.GLOBAL_CONFIG_ELEMSResultParser.PRIO_COMMONResultParser.PRIO_COREResultParser.PRIO_USERResultParser._DEFAULTSResultParser.__annotations__ResultParser.__call__()ResultParser.__init__()ResultParser.__module__ResultParser._check_args()ResultParser.activate()ResultParser.check_args()ResultParser.check_config()ResultParser.deactivate()ResultParser.doc()ResultParser.get_config_items()ResultParser.pathResultParser.register_core_plugins()ResultParser.set_parser_defaults()
register_core_plugins()
- Result Evaluation
- Schedulers
- Scheduler Module
- Scheduler Plugin Class
SchedulerPluginSchedulerPlugin.ISOLATE_KICKOFF_SUFFIXSchedulerPlugin.JOB_SHARE_KEY_ATTRSSchedulerPlugin.JOB_STATUS_TIMEOUTSchedulerPlugin.KICKOFF_FNSchedulerPlugin.KICKOFF_LOG_DEFAULT_FNSchedulerPlugin.KICKOFF_SCRIPT_HEADER_CLASSSchedulerPlugin.NODE_SELECTIONSchedulerPlugin.PRIO_COMMONSchedulerPlugin.PRIO_CORESchedulerPlugin.PRIO_USERSchedulerPlugin.SCHED_DATA_FNSchedulerPlugin.VAR_CLASSSchedulerPlugin.__annotations__SchedulerPlugin.__init__()SchedulerPlugin.__module__SchedulerPlugin._add_schedule_script_body()SchedulerPlugin._available()SchedulerPlugin._create_kickoff_script_stub()SchedulerPlugin._get_alloc_nodes()SchedulerPlugin._get_config_elems()SchedulerPlugin._get_initial_vars()SchedulerPlugin._get_kickoff_script_header()SchedulerPlugin._job_name()SchedulerPlugin._job_status()SchedulerPlugin._kickoff()SchedulerPlugin._make_kickoff_error()SchedulerPlugin.activate()SchedulerPlugin.available()SchedulerPlugin.cancel()SchedulerPlugin.create_kickoff_script()SchedulerPlugin.deactivate()SchedulerPlugin.gen_job_share_key()SchedulerPlugin.get_conf()SchedulerPlugin.get_final_vars()SchedulerPlugin.get_initial_vars()SchedulerPlugin.job_status()SchedulerPlugin.refresh()SchedulerPlugin.register_core_plugins()SchedulerPlugin.schedule_tests()
- Scheduler Plugin Basic Class
SchedulerPluginBasicSchedulerPluginBasic.IS_CONCURRENTSchedulerPluginBasic.__abstractmethods__SchedulerPluginBasic.__annotations__SchedulerPluginBasic.__module__SchedulerPluginBasic._abc_implSchedulerPluginBasic._get_alloc_node_info()SchedulerPluginBasic._get_initial_vars()SchedulerPluginBasic._job_name()SchedulerPluginBasic.create_kickoff_script()SchedulerPluginBasic.get_final_vars()SchedulerPluginBasic.schedule_tests()
- Scheduler Plugin Advanced Class
SchedulerPluginAdvancedSchedulerPluginAdvanced.JOB_SHARE_KEY_ATTRSSchedulerPluginAdvanced.__abstractmethods__SchedulerPluginAdvanced.__annotations__SchedulerPluginAdvanced.__init__()SchedulerPluginAdvanced.__module__SchedulerPluginAdvanced._abc_implSchedulerPluginAdvanced._filter_custom()SchedulerPluginAdvanced._filter_nodes()SchedulerPluginAdvanced._get_chunks()SchedulerPluginAdvanced._get_initial_vars()SchedulerPluginAdvanced._get_raw_node_data()SchedulerPluginAdvanced._get_system_inventory()SchedulerPluginAdvanced._job_name()SchedulerPluginAdvanced._make_chunk_group_id()SchedulerPluginAdvanced._schedule_chunk()SchedulerPluginAdvanced._schedule_indi_chunk()SchedulerPluginAdvanced._schedule_indi_flex()SchedulerPluginAdvanced._schedule_shared()SchedulerPluginAdvanced._transform_raw_node_data()SchedulerPluginAdvanced.create_kickoff_script()SchedulerPluginAdvanced.get_final_vars()SchedulerPluginAdvanced.refresh()SchedulerPluginAdvanced.schedule_tests()
- Scheduler Variables
SchedulerVariablesSchedulerVariables.DEFER_ERRORSSchedulerVariables.EXAMPLESchedulerVariables.NO_EXAMPLESchedulerVariables.__abstractmethods__SchedulerVariables.__annotations__SchedulerVariables.__init__()SchedulerVariables.__module__SchedulerVariables.__repr__()SchedulerVariables._abc_implSchedulerVariables._get_min()SchedulerVariables._test_cmd()SchedulerVariables.account()SchedulerVariables.chunk_ids()SchedulerVariables.chunk_size()SchedulerVariables.concurrent_default()SchedulerVariables.info()SchedulerVariables.min_cpus()SchedulerVariables.min_mem()SchedulerVariables.mpirun_opts()SchedulerVariables.node_list()SchedulerVariables.node_list_id()SchedulerVariables.nodes()SchedulerVariables.partition()SchedulerVariables.qos()SchedulerVariables.requested_nodes()SchedulerVariables.reservation()SchedulerVariables.srun_args()SchedulerVariables.tasks_per_node()SchedulerVariables.tasks_total()SchedulerVariables.test_cmd()SchedulerVariables.test_min_cpus()SchedulerVariables.test_min_mem()SchedulerVariables.test_node_list()SchedulerVariables.test_nodes()
- Scheduler Plugin Class
- Scheduler Plugins
- Slurm
- Slurm Variables
- Slurm Scheduler Plugin
SbatchHeaderSlurmSlurm.JOB_SHARE_KEY_ATTRSSlurm.KICKOFF_SCRIPT_HEADER_CLASSSlurm.MPIRUN_BIND_OPTSSlurm.MPI_CMD_MPIRUNSlurm.MPI_CMD_OPTIONSSlurm.MPI_CMD_SRUNSlurm.NODE_BRACKET_FORMAT_RESlurm.NODE_LIST_RESlurm.NODE_SEQ_REGEX_STRSlurm.SCHED_CANCELLEDSlurm.SCHED_ERRORSlurm.SCHED_OTHERSlurm.SCHED_RUNSlurm.SCHED_WAITINGSlurm.SCONTROL_KEY_RESlurm.SCONTROL_WS_RESlurm.VAR_CLASSSlurm.__abstractmethods__Slurm.__annotations__Slurm.__init__()Slurm.__module__Slurm._abc_implSlurm._available()Slurm._filter_custom()Slurm._get_alloc_nodes()Slurm._get_config_elems()Slurm._get_raw_node_data()Slurm._job_status()Slurm._kickoff()Slurm._scontrol_parse()Slurm._scontrol_show()Slurm._transform_raw_node_data()Slurm.cancel()Slurm.parse_node_list()
- Raw
- Raw Variables
- Raw Scheduler
RawRaw.CANCEL_TIMEOUTRaw.KICKOFF_SCRIPT_HEADER_CLASSRaw.UNIQ_ID_LENRaw.VAR_CLASSRaw.__abstractmethods__Raw.__annotations__Raw.__init__()Raw.__module__Raw._abc_implRaw._available()Raw._get_alloc_node_info()Raw._get_alloc_nodes()Raw._job_status()Raw._kickoff()Raw._pid_running()Raw.available()Raw.cancel()
- Slurm
- Scheduler Module
- Test Series
- Status Files
- Status Files
SeriesStatesStructSeriesStatesStruct.ABORTEDSeriesStatesStruct.ALL_STARTEDSeriesStatesStruct.BUILD_ERRORSeriesStatesStruct.CANCELEDSeriesStatesStruct.COMPLETESeriesStatesStruct.CREATEDSeriesStatesStruct.CREATION_ERRORSeriesStatesStruct.ERRORSeriesStatesStruct.KICKOFF_ERRORSeriesStatesStruct.RUNSeriesStatesStruct.SET_BUILDSeriesStatesStruct.SET_CANCELEDSeriesStatesStruct.SET_CREATEDSeriesStatesStruct.SET_KICKOFFSeriesStatesStruct.SET_MAKESeriesStatesStruct.SET_SKIPPEDSeriesStatesStruct.TESTS_SKIPPED
SeriesStatusFileSeriesStatusInfoStatesStructStatusErrorTestStatesStructTestStatesStruct.ABORTEDTestStatesStruct.BUILDINGTestStatesStruct.BUILD_COPIEDTestStatesStruct.BUILD_CREATEDTestStatesStruct.BUILD_DEFERREDTestStatesStruct.BUILD_DONETestStatesStruct.BUILD_ERRORTestStatesStruct.BUILD_FAILEDTestStatesStruct.BUILD_REUSEDTestStatesStruct.BUILD_SKIPPEDTestStatesStruct.BUILD_SUCCESSTestStatesStruct.BUILD_TIMEOUTTestStatesStruct.BUILD_WAITTestStatesStruct.CANCELLEDTestStatesStruct.COMPLETETestStatesStruct.CREATEDTestStatesStruct.CREATION_ERRORTestStatesStruct.ENV_FAILEDTestStatesStruct.FINALIZEDTestStatesStruct.INFOTestStatesStruct.PREPPING_RUNTestStatesStruct.RESULTSTestStatesStruct.RESULTS_ERRORTestStatesStruct.RUNNINGTestStatesStruct.RUN_DONETestStatesStruct.RUN_ERRORTestStatesStruct.RUN_READYTestStatesStruct.RUN_TIMEOUTTestStatesStruct.RUN_USERTestStatesStruct.SCHEDULEDTestStatesStruct.SCHED_CANCELLEDTestStatesStruct.SCHED_ERRORTestStatesStruct.SCHED_RUNNINGTestStatesStruct.SCHED_STARTUPTestStatesStruct.SCHED_WARNINGTestStatesStruct.SKIPPED
TestStatusFileTestStatusInfo
- Status Files
- Test Configuration
- Pavilion Test Run Objects
- UnitTests
PavTestCasePavTestCase.DEFAULT_LOCK_LIFETIMEPavTestCase.DEFAULT_PAV_CONFIG_PATHPavTestCase.DEFAULT_TIMEOUTSPavTestCase.PAV_LIB_DIRPavTestCase.PAV_ROOT_DIRPavTestCase.PAV_TEST_DIRPavTestCase.QUICK_TEST_BASE_CFGPavTestCase.TEST_DATA_DIRPavTestCase.TEST_DATA_PAV_CONFIG_DIRPavTestCase.TEST_OUTPUT_DIRPavTestCase.TEST_URLPavTestCase.TEST_URL2PavTestCase.TEST_URL_HASHPavTestCase.WORKING_DIRSPavTestCase._classSetupFailedPavTestCase._class_cleanupsPavTestCase._cmp_files()PavTestCase._cmp_tree()PavTestCase._get_lock_lifetime()PavTestCase._get_timeouts()PavTestCase._is_softlink_dir()PavTestCase._load_test()PavTestCase._quick_test()PavTestCase._quick_test_cfg()PavTestCase.dbg_print()PavTestCase.get_hash()PavTestCase.link_file()PavTestCase.link_files()PavTestCase.make_pav_config()PavTestCase.set_up()PavTestCase.setup_suite_output_dir()PavTestCase.tear_down()PavTestCase.wait_tests()
- Utilities
- Variable Components
- Variable Inner Workings (test_config.variables)
DeferredVariableSubVariableVariableErrorVariableListVariableSetVariableSetManagerVariableSetManager.VAR_SETSVariableSetManager.add_var_set()VariableSetManager.any_deferred()VariableSetManager.as_dict()VariableSetManager.get()VariableSetManager.get_permutations()VariableSetManager.is_deferred()VariableSetManager.key_as_dotted()VariableSetManager.len()VariableSetManager.load()VariableSetManager.parse_key()VariableSetManager.resolve_key()VariableSetManager.resolve_references()VariableSetManager.save()VariableSetManager.set_deferred()VariableSetManager.undefer()
- Variable Dict Class (var_dict)
- Pavilion Defined Variables (pav_vars)
- System Variable Plugins
- Variable Inner Workings (test_config.variables)