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.get_OS_info
      • hpcflow.app.get_shell_info
      • hpcflow.app.make_and_submit_workflow
      • hpcflow.app.make_workflow
      • hpcflow.app.run_hpcflow_tests
      • hpcflow.app.run_tests
      • 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.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.Parameter
      • hpcflow.app.ParameterPath
      • hpcflow.app.ParameterPropagationMode
      • hpcflow.app.ParameterValue
      • hpcflow.app.Parameters
      • hpcflow.app.ParametersList
      • hpcflow.app.ResourceList
      • hpcflow.app.ResourceSpec
      • hpcflow.app.SchemaInput
      • hpcflow.app.SchemaOutput
      • hpcflow.app.SchemaParameter
      • 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
  • Configuration file
  • SDK
    • hpcflow.sdk
      • hpcflow.sdk.get_SDK_logger
      • hpcflow.sdk.api
      • 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.App
        • hpcflow.sdk.app.BaseApp
        • hpcflow.sdk.app.Singleton
      • hpcflow.sdk.cli
        • hpcflow.sdk.cli.make_cli
      • 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.actions
        • 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.object_list
        • hpcflow.sdk.core.parameters
        • 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.data.template_components
      • hpcflow.sdk.demo
        • hpcflow.sdk.demo.cli
        • hpcflow.sdk.demo.scripts
      • hpcflow.sdk.helper
        • hpcflow.sdk.helper.cli
        • hpcflow.sdk.helper.helper
        • hpcflow.sdk.helper.watcher
      • hpcflow.sdk.log
        • hpcflow.sdk.log.AppLog
      • hpcflow.sdk.persistence
        • hpcflow.sdk.persistence.store_cls_from_path
        • hpcflow.sdk.persistence.store_cls_from_str
        • hpcflow.sdk.persistence.temporary_workflow_rename
        • hpcflow.sdk.persistence.base
        • hpcflow.sdk.persistence.json
        • hpcflow.sdk.persistence.zarr
      • hpcflow.sdk.runtime
        • hpcflow.sdk.runtime.RunTimeInfo
      • hpcflow.sdk.scripting
        • hpcflow.sdk.scripting.register_input_file_writer
        • hpcflow.sdk.scripting.register_output_parser
      • hpcflow.sdk.submission
        • hpcflow.sdk.submission.jobscript
        • hpcflow.sdk.submission.schedulers
        • hpcflow.sdk.submission.shells
        • hpcflow.sdk.submission.submission
      • hpcflow.sdk.typing
  • Reference

Reference#

  • Python API
    • hpcflow.app
  • Command-line interface
    • hpcflow
  • Template components
    • Parameters
    • Environments
    • Command files
    • Task schemas
  • Configuration file
    • Default config file
    • Validation schema
  • SDK
    • hpcflow.sdk

previous

Tutorials

next

Python API
Edit on GitHub
Show Source

© Copyright 2023, hpcflow developers.

Created using Sphinx 6.2.1.

Built with the PyData Sphinx Theme 0.13.3.