SKA SDP Piper Execution Framework
Releases
Changelog
Contents
Getting Started
Developer Guide
Piper
API
SKA SDP Piper Execution Framework
Index
Index
_
|
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__json_repr__ (ska_sdp_piper.piper.piper_undefined.PiperUndefined attribute)
__stages (ska_sdp_piper.piper.stage.stages.Stages attribute)
_instances (ska_sdp_piper.piper.named_instance.NamedInstance attribute)
_script_path (ska_sdp_piper.app.executable_pipeline.ExecutablePipeline attribute)
A
add_additional_parameters() (ska_sdp_piper.piper.stage.stages.Stage method)
(ska_sdp_piper.piper.stage.stages.Stages method)
additional (ska_sdp_piper.piper.runners.dask_runner.DaskRunner attribute)
allowed_values (ska_sdp_piper.extensions.common.ConfigTableRow attribute)
annotate() (ska_sdp_piper.piper.piper_undefined.PiperUndefined static method)
args (ska_sdp_piper.piper.command.cli_command_parser.CLIArgument attribute)
C
check() (ska_sdp_piper.piper.piper_undefined.PiperUndefined static method)
cli_args() (ska_sdp_piper.piper.runners.dask_runner.DaskRunner class method)
(ska_sdp_piper.piper.runners.default_runner.DefaultRunner class method)
(ska_sdp_piper.piper.stage.stage_metadata.StageMetadata method)
cli_args_dict (ska_sdp_piper.piper.command.cli_command_parser.CLICommandParser property)
cli_arguments (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata attribute)
CLIArgument (class in ska_sdp_piper.piper.command.cli_command_parser)
CLICommandParser (class in ska_sdp_piper.piper.command.cli_command_parser)
Command (class in ska_sdp_piper.piper.command.command)
config (ska_sdp_piper.piper.pipeline.Pipeline property)
(ska_sdp_piper.piper.stage.stages.Stage property)
ConfigRoot (class in ska_sdp_piper.piper.constants)
ConfigTableRow (class in ska_sdp_piper.extensions.common)
ConfigurableStage() (in module ska_sdp_piper.piper.stage.configurable_stage)
configure() (ska_sdp_piper.piper.utils.log_util.LogUtil class method)
configure_logging() (ska_sdp_piper.piper.pipeline.Pipeline method)
convert_allowed_values_to_string() (in module ska_sdp_piper.piper.configurations.doc_utils)
convert_description_to_line_string() (in module ska_sdp_piper.piper.configurations.doc_utils)
convert_type_to_reST_string() (in module ska_sdp_piper.piper.configurations.doc_utils)
create_output_dir() (in module ska_sdp_piper.piper.utils.io_utils)
(ska_sdp_piper.piper.pipeline.Pipeline method)
create_sub_parser() (ska_sdp_piper.piper.command.cli_command_parser.CLICommandParser method)
D
DaskRunner (class in ska_sdp_piper.piper.runners.dask_runner)
dataclass_to_list() (in module ska_sdp_piper.extensions.common)
default (ska_sdp_piper.extensions.common.ConfigTableRow attribute)
DefaultRunner (class in ska_sdp_piper.piper.runners.default_runner)
delayed_log() (in module ska_sdp_piper.piper.utils.log_util)
description (ska_sdp_piper.extensions.common.ConfigTableRow attribute)
E
executable_content (ska_sdp_piper.app.executable_pipeline.ExecutablePipeline attribute)
executable_stages (ska_sdp_piper.piper.pipeline.Pipeline property)
(ska_sdp_piper.piper.stage.stages.Stages property)
ExecutablePipeline (class in ska_sdp_piper.app.executable_pipeline)
execute() (ska_sdp_piper.piper.runners.default_runner.DefaultRunner method)
F
from_stage_definition() (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata class method)
G
generate_config_rows_for_stage() (ska_sdp_piper.piper.stage.stages.Stage method)
generate_config_table_rows() (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata method)
get_allowed_values() (in module ska_sdp_piper.piper.configurations.doc_utils)
get_instance() (ska_sdp_piper.piper.named_instance.NamedInstance class method)
get_resolved_path() (in module ska_sdp_piper.piper.configurations.doc_utils)
GLOBAL_PARAMETERS (ska_sdp_piper.piper.constants.ConfigRoot attribute)
H
has_content (ska_sdp_piper.extensions.sphinx_piper_pipeline.PiperPipelineConfigDirective attribute)
HEADER_ROW (in module ska_sdp_piper.extensions.common)
I
install() (in module ska_sdp_piper.app.cli)
(ska_sdp_piper.app.executable_pipeline.ExecutablePipeline method)
install_config() (ska_sdp_piper.piper.pipeline.Pipeline method)
installable_pipeline (ska_sdp_piper.app.executable_pipeline.ExecutablePipeline attribute)
is_nullable() (in module ska_sdp_piper.piper.configurations.doc_utils)
K
kwargs (ska_sdp_piper.piper.command.cli_command_parser.CLIArgument attribute)
L
LogPlugin (class in ska_sdp_piper.piper.utils.log_util)
LogUtil (class in ska_sdp_piper.piper.utils.log_util)
M
model_config (ska_sdp_piper.piper.piper_base_model.PiperBaseModel attribute)
module
ska_sdp_piper
ska_sdp_piper.app
ska_sdp_piper.app.cli
ska_sdp_piper.app.constants
ska_sdp_piper.app.executable_pipeline
ska_sdp_piper.extensions
ska_sdp_piper.extensions.common
ska_sdp_piper.extensions.sphinx_piper_pipeline
ska_sdp_piper.piper
ska_sdp_piper.piper.command
ska_sdp_piper.piper.command.cli_command_parser
ska_sdp_piper.piper.command.command
ska_sdp_piper.piper.configurations
ska_sdp_piper.piper.configurations.doc_utils
ska_sdp_piper.piper.configurations.runtime_config
ska_sdp_piper.piper.constants
ska_sdp_piper.piper.exceptions
ska_sdp_piper.piper.named_instance
ska_sdp_piper.piper.pipeline
ska_sdp_piper.piper.piper_base_model
ska_sdp_piper.piper.piper_undefined
ska_sdp_piper.piper.runners
ska_sdp_piper.piper.runners.dask_runner
ska_sdp_piper.piper.runners.default_runner
ska_sdp_piper.piper.stage
ska_sdp_piper.piper.stage.configurable_stage
ska_sdp_piper.piper.stage.stage_metadata
ska_sdp_piper.piper.stage.stages
ska_sdp_piper.piper.utils
ska_sdp_piper.piper.utils.io_utils
ska_sdp_piper.piper.utils.log_config
ska_sdp_piper.piper.utils.log_util
N
name (ska_sdp_piper.extensions.common.ConfigTableRow attribute)
NamedInstance (class in ska_sdp_piper.piper.named_instance)
NoStageToExecuteException
nullable (ska_sdp_piper.extensions.common.ConfigTableRow attribute)
O
overide_run() (ska_sdp_piper.piper.pipeline.Pipeline method)
P
PARAMETERS (ska_sdp_piper.piper.constants.ConfigRoot attribute)
Pipeline (class in ska_sdp_piper.piper.pipeline)
PIPELINE (ska_sdp_piper.piper.constants.ConfigRoot attribute)
PipelineNotFoundException
piper_args() (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata method)
piper_arguments (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata attribute)
PIPER_UNDEFINED (in module ska_sdp_piper.piper.piper_undefined)
PiperBaseModel (class in ska_sdp_piper.piper.piper_base_model)
PiperPipelineConfigDirective (class in ska_sdp_piper.extensions.sphinx_piper_pipeline)
PiperUndefined (class in ska_sdp_piper.piper.piper_undefined)
R
read_yml() (in module ska_sdp_piper.piper.utils.io_utils)
required_arguments (ska_sdp_piper.extensions.sphinx_piper_pipeline.PiperPipelineConfigDirective attribute)
resolve_qa_dir() (ska_sdp_piper.piper.pipeline.Pipeline method)
run() (ska_sdp_piper.extensions.sphinx_piper_pipeline.PiperPipelineConfigDirective method)
(ska_sdp_piper.piper.pipeline.Pipeline method)
RuntimeConfig (class in ska_sdp_piper.piper.configurations.runtime_config)
S
serialize() (ska_sdp_piper.piper.piper_undefined.PiperUndefined static method)
set() (ska_sdp_piper.piper.configurations.runtime_config.RuntimeConfig method)
set_runtime() (ska_sdp_piper.piper.pipeline.Pipeline method)
setup() (in module ska_sdp_piper.extensions.sphinx_piper_pipeline)
(ska_sdp_piper.piper.utils.log_util.LogPlugin method)
ska_sdp_piper
module
ska_sdp_piper.app
module
ska_sdp_piper.app.cli
module
ska_sdp_piper.app.constants
module
ska_sdp_piper.app.executable_pipeline
module
ska_sdp_piper.extensions
module
ska_sdp_piper.extensions.common
module
ska_sdp_piper.extensions.sphinx_piper_pipeline
module
ska_sdp_piper.piper
module
ska_sdp_piper.piper.command
module
ska_sdp_piper.piper.command.cli_command_parser
module
ska_sdp_piper.piper.command.command
module
ska_sdp_piper.piper.configurations
module
ska_sdp_piper.piper.configurations.doc_utils
module
ska_sdp_piper.piper.configurations.runtime_config
module
ska_sdp_piper.piper.constants
module
ska_sdp_piper.piper.exceptions
module
ska_sdp_piper.piper.named_instance
module
ska_sdp_piper.piper.pipeline
module
ska_sdp_piper.piper.piper_base_model
module
ska_sdp_piper.piper.piper_undefined
module
ska_sdp_piper.piper.runners
module
ska_sdp_piper.piper.runners.dask_runner
module
ska_sdp_piper.piper.runners.default_runner
module
ska_sdp_piper.piper.stage
module
ska_sdp_piper.piper.stage.configurable_stage
module
ska_sdp_piper.piper.stage.stage_metadata
module
ska_sdp_piper.piper.stage.stages
module
ska_sdp_piper.piper.utils
module
ska_sdp_piper.piper.utils.io_utils
module
ska_sdp_piper.piper.utils.log_config
module
ska_sdp_piper.piper.utils.log_util
module
Stage (class in ska_sdp_piper.piper.stage.stages)
stage_param() (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata method)
stage_param_model (ska_sdp_piper.piper.stage.stage_metadata.StageMetadata attribute)
StageMetadata (class in ska_sdp_piper.piper.stage.stage_metadata)
StageNotFoundException
Stages (class in ska_sdp_piper.piper.stage.stages)
stages_to_run (ska_sdp_piper.piper.configurations.runtime_config.RuntimeConfig property)
sub_command() (ska_sdp_piper.piper.command.command.Command method)
T
timestamp() (in module ska_sdp_piper.piper.utils.io_utils)
U
uninstall() (in module ska_sdp_piper.app.cli)
(ska_sdp_piper.app.executable_pipeline.ExecutablePipeline method)
update_from_cli_overrides() (ska_sdp_piper.piper.configurations.runtime_config.RuntimeConfig method)
update_from_cli_stages() (ska_sdp_piper.piper.configurations.runtime_config.RuntimeConfig method)
update_from_yaml() (ska_sdp_piper.piper.configurations.runtime_config.RuntimeConfig method)
update_parameters() (ska_sdp_piper.piper.stage.stages.Stage method)
update_stage_parameters() (ska_sdp_piper.piper.stage.stages.Stages method)
update_stage_state() (ska_sdp_piper.piper.stage.stages.Stages method)
V
validate() (ska_sdp_piper.piper.piper_undefined.PiperUndefined static method)
(ska_sdp_piper.piper.stage.stages.Stages method)
validate_pipeline() (ska_sdp_piper.app.executable_pipeline.ExecutablePipeline method)
validate_stage_args() (ska_sdp_piper.piper.stage.stages.Stage method)
verbose (ska_sdp_piper.piper.utils.log_util.LogUtil attribute)
VERSION (ska_sdp_piper.piper.constants.ConfigRoot attribute)
W
with_qa_path_resolver() (ska_sdp_piper.piper.pipeline.Pipeline method)
write_runtime_params() (ska_sdp_piper.piper.pipeline.Pipeline method)
write_yml() (in module ska_sdp_piper.piper.utils.io_utils)
(ska_sdp_piper.piper.command.cli_command_parser.CLICommandParser method)
(ska_sdp_piper.piper.configurations.runtime_config.RuntimeConfig method)