Install App Runner

To install the most recent released version:

uv tool install bfabric_app_runner

To install a development version:

uv tool install bfabric_app_runner@git+https://github.com/fgcz/bfabricPy.git@main#egg=bfabric_app_runner&subdirectory=bfabric_app_runner

Contents

• Workunit Definition
  • Creating WorkunitDefinition instances
  • Workunit references
  • Reference
    • WorkunitDefinition
      • WorkunitDefinition.execution
      • WorkunitDefinition.registration
      • WorkunitDefinition.from_ref()
      • WorkunitDefinition.from_workunit()
      • WorkunitDefinition.from_yaml()
      • WorkunitDefinition.to_yaml()
    • WorkunitExecutionDefinition
      • WorkunitExecutionDefinition.dataset
      • WorkunitExecutionDefinition.raw_parameters
      • WorkunitExecutionDefinition.resources
      • WorkunitExecutionDefinition.from_workunit()
      • WorkunitExecutionDefinition.mutually_exclusive_dataset_resources
    • WorkunitRegistrationDefinition
      • WorkunitRegistrationDefinition.application_id
      • WorkunitRegistrationDefinition.application_name
      • WorkunitRegistrationDefinition.container_id
      • WorkunitRegistrationDefinition.container_type
      • WorkunitRegistrationDefinition.storage_id
      • WorkunitRegistrationDefinition.storage_output_folder
      • WorkunitRegistrationDefinition.workunit_id
      • WorkunitRegistrationDefinition.workunit_name
      • WorkunitRegistrationDefinition.from_workunit()
• Architecture Overview
  • App model
  • App runner activity diagram
• Input specification
  • General structure
• Commands
  • Validation
  • Prepare files
  • List files
• Reference
  • InputsSpec
    • InputsSpec.inputs
    • InputsSpec.read_yaml()
    • InputsSpec.read_yaml_old()
    • InputsSpec.write_yaml()
    • InputsSpec.apply_filter()
• Output specification
  • General structure
• Commands
  • Validation
  • Register files
• Reference
  • CopyResourceSpec
    • CopyResourceSpec.local_path
    • CopyResourceSpec.protocol
    • CopyResourceSpec.store_entry_path
    • CopyResourceSpec.store_folder_path
    • CopyResourceSpec.type
    • CopyResourceSpec.update_existing
  • OutputsSpec
    • OutputsSpec.outputs
    • OutputsSpec.read_yaml()
    • OutputsSpec.write_yaml()
  • SaveDatasetSpec
    • SaveDatasetSpec.has_header
    • SaveDatasetSpec.invalid_characters
    • SaveDatasetSpec.local_path
    • SaveDatasetSpec.name
    • SaveDatasetSpec.separator
    • SaveDatasetSpec.type
  • UpdateExisting
    • UpdateExisting.IF_EXISTS
    • UpdateExisting.NO
    • UpdateExisting.REQUIRED
• App Specification
  • Overview
  • App Specification Structure
  • Commands
    • CommandsSpec
      • CommandsSpec.collect
      • CommandsSpec.dispatch
      • CommandsSpec.process
    • Shell Commands
      • CommandShell
        • CommandShell.command
        • CommandShell.type
        • CommandShell.to_shell()
    • Docker Commands
      • CommandDocker
        • CommandDocker.command
        • CommandDocker.custom_args
        • CommandDocker.engine
        • CommandDocker.entrypoint
        • CommandDocker.env
        • CommandDocker.hostname
        • CommandDocker.image
        • CommandDocker.mac_address
        • CommandDocker.mounts
        • CommandDocker.type
        • CommandDocker.to_shell()
      • MountOptions
        • MountOptions.read_only
        • MountOptions.share_bfabric_config
        • MountOptions.work_dir_target
        • MountOptions.writeable
        • MountOptions.collect()
  • App Versions
  • Variables and Templating
  • Loading and Using App Specifications
  • Reference
    • AppVersion
      • AppVersion.commands
      • AppVersion.reuse_default_resource
      • AppVersion.submitter
      • AppVersion.version
    • AppVersionMultiTemplate
      • AppVersionMultiTemplate.commands
      • AppVersionMultiTemplate.reuse_default_resource
      • AppVersionMultiTemplate.submitter
      • AppVersionMultiTemplate.version
      • AppVersionMultiTemplate.expand_versions()
    • AppVersionTemplate
      • AppVersionTemplate.commands
      • AppVersionTemplate.reuse_default_resource
      • AppVersionTemplate.submitter
      • AppVersionTemplate.version
      • AppVersionTemplate.evaluate()
• Changelog
  • [Unreleased]
  • Added
  • [0.0.18] - 2025-02-25
    • Added
    • Changed
  • [0.0.17] - 2025-02-19
    • Fixed
  • [0.0.16] - 2025-02-19
    • Added
    • Changed
  • [0.0.15] - 2025-02-06
    • Added
    • Changed
    • Fixed
  • [0.0.14] - 2025-01-30
    • Fixed
  • [0.0.13] - 2025-01-28
    • Added
  • [0.0.12] - 2025-01-22
  • Added
  • [0.0.11] - 2025-01-16
    • Added
  • [0.0.10] - 2025-01-15
    • Added
  • [0.0.9] - 2025-01-09
    • Added
  • [0.0.8] - 2025-01-08
    • Added
    • Changed
  • [0.0.7] - 2024-11-22
    • Fixed
  • [0.0.6] - 2024-11-14
    • Fixed
    • Changed
  • [0.0.5] - 2024-11-11
    • Added
  • [0.0.4] - 2024-11-11
    • Added
  • [0.0.3] - 2024-10-24
    • Added
  • [0.0.2] - 2024-10-23
    • Added
    • Fixed