Skip to main content
Ctrl+K
Logo image

Site Navigation

  • Install
  • User Guide
  • Reference
  • Development

Site Navigation

  • Install
  • User Guide
  • Reference
  • Development

Section Navigation

  • Python API
    • hpcflow.app
      • hpcflow.app.app
      • hpcflow.app.cancel
      • hpcflow.app.get_OS_info
      • hpcflow.app.get_known_submissions
      • hpcflow.app.get_shell_info
      • hpcflow.app.make_and_submit_demo_workflow
      • hpcflow.app.make_and_submit_workflow
      • hpcflow.app.make_demo_workflow
      • hpcflow.app.make_workflow
      • hpcflow.app.run_hpcflow_tests
      • hpcflow.app.run_tests
      • hpcflow.app.show
      • hpcflow.app.show_legend
      • hpcflow.app.submit_workflow
      • hpcflow.app.Action
      • hpcflow.app.ActionEnvironment
      • hpcflow.app.ActionRule
      • hpcflow.app.ActionScope
      • hpcflow.app.ActionScopeType
      • hpcflow.app.Command
      • hpcflow.app.CommandFilesList
      • hpcflow.app.DirectPosix
      • hpcflow.app.DirectWindows
      • hpcflow.app.Element
      • hpcflow.app.ElementAction
      • hpcflow.app.ElementActionRun
      • hpcflow.app.ElementFilter
      • hpcflow.app.ElementGroup
      • hpcflow.app.ElementInputFiles
      • hpcflow.app.ElementInputs
      • hpcflow.app.ElementIteration
      • hpcflow.app.ElementOutputFiles
      • hpcflow.app.ElementOutputs
      • hpcflow.app.ElementParameter
      • hpcflow.app.ElementPropagation
      • hpcflow.app.ElementRepeats
      • hpcflow.app.ElementResources
      • hpcflow.app.ElementSet
      • hpcflow.app.Elements
      • hpcflow.app.Environment
      • hpcflow.app.EnvironmentsList
      • hpcflow.app.Executable
      • hpcflow.app.ExecutableInstance
      • hpcflow.app.ExecutablesList
      • hpcflow.app.FileNameExt
      • hpcflow.app.FileNameSpec
      • hpcflow.app.FileNameStem
      • hpcflow.app.FileSpec
      • hpcflow.app.GroupList
      • hpcflow.app.InputFile
      • hpcflow.app.InputFileGenerator
      • hpcflow.app.InputFileGeneratorSource
      • hpcflow.app.InputSource
      • hpcflow.app.InputSourceType
      • hpcflow.app.InputValue
      • hpcflow.app.Jobscript
      • hpcflow.app.Loop
      • hpcflow.app.NumCores
      • hpcflow.app.OutputFileParser
      • hpcflow.app.OutputFileParserSource
      • hpcflow.app.OutputLabel
      • hpcflow.app.Parameter
      • hpcflow.app.ParameterPath
      • hpcflow.app.ParameterPropagationMode
      • hpcflow.app.ParameterValue
      • hpcflow.app.Parameters
      • hpcflow.app.ParametersList
      • hpcflow.app.ResourceList
      • hpcflow.app.ResourceSpec
      • hpcflow.app.Rule
      • hpcflow.app.RunDirAppFiles
      • hpcflow.app.SGEPosix
      • hpcflow.app.SchemaInput
      • hpcflow.app.SchemaOutput
      • hpcflow.app.SchemaParameter
      • hpcflow.app.SlurmPosix
      • hpcflow.app.SubParameter
      • hpcflow.app.Submission
      • hpcflow.app.Task
      • hpcflow.app.TaskInputParameters
      • hpcflow.app.TaskList
      • hpcflow.app.TaskObjective
      • hpcflow.app.TaskOutputParameters
      • hpcflow.app.TaskSchema
      • hpcflow.app.TaskSchemasList
      • hpcflow.app.TaskSourceType
      • hpcflow.app.TaskTemplateList
      • hpcflow.app.ValuePerturbation
      • hpcflow.app.ValueSequence
      • hpcflow.app.Workflow
      • hpcflow.app.WorkflowBlueprint
      • hpcflow.app.WorkflowLoop
      • hpcflow.app.WorkflowLoopList
      • hpcflow.app.WorkflowTask
      • hpcflow.app.WorkflowTaskList
      • hpcflow.app.WorkflowTemplate
  • Command-line interface
  • Template components
    • Parameters
    • Environments
    • Command files
    • Task schemas
  • Demo workflows
  • Configuration file
  • SDK
    • hpcflow.sdk
      • hpcflow.sdk.sdk_classes
      • hpcflow.sdk.sdk_funcs
      • hpcflow.sdk.get_SDK_logger
      • hpcflow.sdk.app
        • hpcflow.sdk.app.get_app_attribute
        • hpcflow.sdk.app.get_app_module_all
        • hpcflow.sdk.app.get_app_module_dir
        • hpcflow.sdk.app.rate_limit_safe_url_to_fs
        • hpcflow.sdk.app.App
        • hpcflow.sdk.app.BaseApp
        • hpcflow.sdk.app.Singleton
      • hpcflow.sdk.cli
        • hpcflow.sdk.cli.string_option
        • hpcflow.sdk.cli.workflow_ref_type_opt
        • hpcflow.sdk.cli.make_cli
        • hpcflow.sdk.cli.parse_jobscript_wait_spec
      • hpcflow.sdk.cli_common
        • hpcflow.sdk.cli_common.format_option
        • hpcflow.sdk.cli_common.path_option
        • hpcflow.sdk.cli_common.name_option
        • hpcflow.sdk.cli_common.overwrite_option
        • hpcflow.sdk.cli_common.store_option
        • hpcflow.sdk.cli_common.ts_fmt_option
        • hpcflow.sdk.cli_common.ts_name_fmt_option
        • hpcflow.sdk.cli_common.variables_option
        • hpcflow.sdk.cli_common.js_parallelism_option
        • hpcflow.sdk.cli_common.wait_option
        • hpcflow.sdk.cli_common.add_to_known_opt
        • hpcflow.sdk.cli_common.print_idx_opt
        • hpcflow.sdk.cli_common.tasks_opt
        • hpcflow.sdk.cli_common.cancel_opt
        • hpcflow.sdk.cli_common.submit_status_opt
        • hpcflow.sdk.cli_common.make_status_opt
        • hpcflow.sdk.cli_common.zip_path_opt
        • hpcflow.sdk.cli_common.zip_overwrite_opt
        • hpcflow.sdk.cli_common.zip_log_opt
        • hpcflow.sdk.cli_common.zip_include_execute_opt
        • hpcflow.sdk.cli_common.zip_include_rechunk_backups_opt
        • hpcflow.sdk.cli_common.unzip_path_opt
        • hpcflow.sdk.cli_common.unzip_log_opt
        • hpcflow.sdk.cli_common.rechunk_backup_opt
        • hpcflow.sdk.cli_common.rechunk_chunk_size_opt
        • hpcflow.sdk.cli_common.rechunk_status_opt
        • hpcflow.sdk.cli_common.sub_tasks_callback
      • hpcflow.sdk.config
        • hpcflow.sdk.config.callbacks
        • hpcflow.sdk.config.cli
        • hpcflow.sdk.config.config
        • hpcflow.sdk.config.config_file
        • hpcflow.sdk.config.errors
      • hpcflow.sdk.core
        • hpcflow.sdk.core.ALL_TEMPLATE_FORMATS
        • hpcflow.sdk.core.ABORT_EXIT_CODE
        • hpcflow.sdk.core.actions
        • hpcflow.sdk.core.cache
        • hpcflow.sdk.core.command_files
        • hpcflow.sdk.core.commands
        • hpcflow.sdk.core.element
        • hpcflow.sdk.core.environment
        • hpcflow.sdk.core.errors
        • hpcflow.sdk.core.json_like
        • hpcflow.sdk.core.loop
        • hpcflow.sdk.core.loop_cache
        • hpcflow.sdk.core.object_list
        • hpcflow.sdk.core.parallel
        • hpcflow.sdk.core.parameters
        • hpcflow.sdk.core.rule
        • hpcflow.sdk.core.run_dir_files
        • hpcflow.sdk.core.task
        • hpcflow.sdk.core.task_schema
        • hpcflow.sdk.core.test_utils
        • hpcflow.sdk.core.utils
        • hpcflow.sdk.core.validation
        • hpcflow.sdk.core.workflow
        • hpcflow.sdk.core.zarr_io
      • hpcflow.sdk.data
      • hpcflow.sdk.demo
        • hpcflow.sdk.demo.cli
      • hpcflow.sdk.helper
        • hpcflow.sdk.helper.cli
        • hpcflow.sdk.helper.helper
        • hpcflow.sdk.helper.watcher
      • hpcflow.sdk.log
        • hpcflow.sdk.log.AppLog
        • hpcflow.sdk.log.TimeIt
      • hpcflow.sdk.persistence
        • hpcflow.sdk.persistence.DEFAULT_STORE_FORMAT
        • hpcflow.sdk.persistence.ALL_STORE_FORMATS
        • hpcflow.sdk.persistence.ALL_CREATE_STORE_FORMATS
        • hpcflow.sdk.persistence.store_cls_from_str
        • hpcflow.sdk.persistence.base
        • hpcflow.sdk.persistence.json
        • hpcflow.sdk.persistence.pending
        • hpcflow.sdk.persistence.store_resource
        • hpcflow.sdk.persistence.utils
        • hpcflow.sdk.persistence.zarr
      • hpcflow.sdk.runtime
        • hpcflow.sdk.runtime.RunTimeInfo
      • hpcflow.sdk.submission
        • hpcflow.sdk.submission.jobscript
        • hpcflow.sdk.submission.jobscript_info
        • hpcflow.sdk.submission.schedulers
        • hpcflow.sdk.submission.shells
        • hpcflow.sdk.submission.submission
      • hpcflow.sdk.typing
        • hpcflow.sdk.typing.PathLike
        • hpcflow.sdk.typing.E_idx_type
        • hpcflow.sdk.typing.EI_idx_type
        • hpcflow.sdk.typing.EAR_idx_type
  • Glossary
  • Reference
  • hpcflow.sdk
  • hpcflow.sdk.helper

hpcflow.sdk.helper#

Helpers for the CLI.

hpcflow.sdk.helper.cli

Common Click command line options related to the helper.

hpcflow.sdk.helper.helper

Implementation of a helper process used to monitor jobs.

hpcflow.sdk.helper.watcher

File-system watcher classes.

previous

hpcflow.sdk.demo.cli.get_demo_workflow_CLI

next

hpcflow.sdk.helper.cli
Edit on GitHub
Show Source

© Copyright 2023, hpcflow developers.

Created using Sphinx 6.2.1.

Built with the PyData Sphinx Theme 0.13.3.