Welcome to bencbuild’s documentation!

Contents:

• BenchBuild Documentation
  • Design Philosophy
    • A case-study doesn’t know its experiment
    • An experiment doesn’t know its case-studies
  • Supported Python Versions
  • Getting started
• Installation
  • Requirements
    • PostgreSQL
    • FUSE
    • SLURM
  • Benchbuild
    • Bootstrapping
• Configure
  • Module: settings
  • Module: utils.settings
    • ConfigDumper
      • ConfigDumper.yaml_implicit_resolvers
      • ConfigDumper.yaml_representers
    • ConfigLoader
      • ConfigLoader.yaml_constructors
      • ConfigLoader.yaml_implicit_resolvers
    • ConfigPath
      • ConfigPath.path_to_str()
      • ConfigPath.validate()
    • Configuration
      • Configuration.filter_exports()
      • Configuration.has_default()
      • Configuration.has_value()
      • Configuration.init_from_env()
      • Configuration.is_leaf()
      • Configuration.load()
      • Configuration.store()
      • Configuration.to_env_dict()
      • Configuration.value
    • Indexable
    • InvalidConfigKey
    • available_cpu_count()
    • convert_components()
    • current_available_threads()
    • escape_yaml()
    • find_config()
    • get_number_of_jobs()
    • is_yaml()
    • path_constructor()
    • path_representer()
    • setup_config()
    • to_env_var()
    • to_yaml()
    • update_env()
    • upgrade()
    • uuid_add_implicit_resolver()
    • uuid_constructor()
    • uuid_representer()
• Containers
  • Usage
    • Replace Images
  • Configuration
  • Definition
  • Runtime requirements
    • Buildah
    • Podman
  • Module: benchbuild.container
    • BashStrategy
      • BashStrategy.run()
    • Container
      • Container.VERSION
      • Container.builddir()
      • Container.input_file()
      • Container.main()
      • Container.mounts()
      • Container.output_file()
      • Container.shell()
      • Container.verbosity
    • ContainerBootstrap
      • ContainerBootstrap.install_cmake_and_exit()
      • ContainerBootstrap.main()
    • ContainerCreate
      • ContainerCreate.main()
      • ContainerCreate.strategy()
    • ContainerList
      • ContainerList.main()
    • ContainerRun
      • ContainerRun.main()
    • ContainerStrategy
      • ContainerStrategy.run()
    • MockObj
    • SetupPolyJITGentooStrategy
      • SetupPolyJITGentooStrategy.run()
    • clean_directories()
    • find_hash()
    • main()
    • pack_container()
    • run_in_container()
    • set_input_container()
    • setup_bash_in_container()
    • setup_container()
    • setup_directories()
  • Module: benchbuild.environments.domain.declarative
    • ContainerImage
      • ContainerImage.add()
      • ContainerImage.base
      • ContainerImage.command()
      • ContainerImage.context()
      • ContainerImage.copy_()
      • ContainerImage.entrypoint()
      • ContainerImage.env()
      • ContainerImage.from_()
      • ContainerImage.run()
      • ContainerImage.workingdir()
    • add_benchbuild_layers()
  • Module: benchbuild.environments.domain.model
    • AddLayer
      • AddLayer.destination
      • AddLayer.sources
    • Command
    • Container
      • Container.container_id
      • Container.context
      • Container.events
      • Container.image
      • Container.name
    • ContextLayer
      • ContextLayer.func
    • CopyLayer
      • CopyLayer.destination
      • CopyLayer.sources
    • EntryPoint
      • EntryPoint.command
    • Event
    • FromLayer
      • FromLayer.base
    • Image
      • Image.append()
      • Image.env
      • Image.events
      • Image.from_
      • Image.is_complete()
      • Image.is_present()
      • Image.layer_index
      • Image.layers
      • Image.mounts
      • Image.name
      • Image.prepend()
      • Image.present()
      • Image.update_env()
    • Layer
    • LayerState
      • LayerState.ABSENT
      • LayerState.PRESENT
    • Message
    • Mount
      • Mount.source
      • Mount.target
    • RunLayer
      • RunLayer.args
      • RunLayer.command
      • RunLayer.kwargs
    • SetCommand
      • SetCommand.command
    • UpdateEnv
      • UpdateEnv.env
    • WorkingDirectory
      • WorkingDirectory.directory
    • immutable_kwargs()
  • Module: benchbuild.environments.domain.commands
    • CreateBenchbuildBase
      • CreateBenchbuildBase.layers
      • CreateBenchbuildBase.name
    • CreateImage
      • CreateImage.layers
      • CreateImage.name
    • DeleteImage
      • DeleteImage.name
    • ExportImage
      • ExportImage.image
      • ExportImage.out_name
    • ImportImage
      • ImportImage.image
      • ImportImage.in_path
    • RunProjectContainer
      • RunProjectContainer.args
      • RunProjectContainer.build_dir
      • RunProjectContainer.image
      • RunProjectContainer.name
    • fs_compliant_name()
    • oci_compliant_name()
• Actions
  • Customize actions
  • Available Actions
    • Step (Base)
    • Clean
    • MakeBuildDir
    • Compile
    • Run
    • Echo
    • Any (Group)
    • Experiment (Any, Group)
    • RequireAll (Group)
    • CleanExtra
    • ProjectEnvironment
    • SetProjectVersion
      • Any
        • Any.DESCRIPTION
        • Any.NAME
      • Clean
        • Clean.DESCRIPTION
        • Clean.NAME
        • Clean.clean_mountpoints()
      • CleanExtra
        • CleanExtra.DESCRIPTION
        • CleanExtra.NAME
      • Compile
        • Compile.DESCRIPTION
        • Compile.NAME
      • Echo
        • Echo.DESCRIPTION
        • Echo.NAME
        • Echo.message
      • Experiment
        • Experiment.DESCRIPTION
        • Experiment.NAME
        • Experiment.begin_transaction()
        • Experiment.end_transaction()
        • Experiment.experiment
      • MakeBuildDir
        • MakeBuildDir.DESCRIPTION
        • MakeBuildDir.NAME
      • MultiStep
        • MultiStep.DESCRIPTION
        • MultiStep.NAME
        • MultiStep.actions
        • MultiStep.onerror()
      • ProjectEnvironment
        • ProjectEnvironment.DESCRIPTION
        • ProjectEnvironment.NAME
      • ProjectStep
        • ProjectStep.DESCRIPTION
        • ProjectStep.NAME
        • ProjectStep.onerror()
        • ProjectStep.project
      • RequireAll
        • RequireAll.DESCRIPTION
        • RequireAll.NAME
      • Run
        • Run.DESCRIPTION
        • Run.NAME
        • Run.experiment
      • RunWorkload
        • RunWorkload.DESCRIPTION
        • RunWorkload.NAME
        • RunWorkload.workload_ref
      • RunWorkloads
        • RunWorkloads.DESCRIPTION
        • RunWorkloads.NAME
        • RunWorkloads.experiment
        • RunWorkloads.project
      • SetProjectVersion
        • SetProjectVersion.DESCRIPTION
        • SetProjectVersion.NAME
        • SetProjectVersion.revision
      • Step
        • Step.DESCRIPTION
        • Step.NAME
        • Step.onerror()
        • Step.status
      • StepResult
        • StepResult.CAN_CONTINUE
        • StepResult.ERROR
        • StepResult.OK
        • StepResult.UNSET
      • log_before_after()
      • prepend_status()
      • run_any_child()
      • step_has_failed()
• Commands
  • Usage inside Projects
  • Tokens
  • Module: command
    • ArgsRenderStrategy
      • ArgsRenderStrategy.rendered()
      • ArgsRenderStrategy.unrendered
    • ArgsToken
      • ArgsToken.make_token()
      • ArgsToken.render()
      • ArgsToken.renderer
    • BackupFn
    • BuilddirRenderer
      • BuilddirRenderer.rendered()
      • BuilddirRenderer.unrendered
    • Command
      • Command.path
      • Command.output_param
      • Command.output
      • Command.label
      • Command.creates
      • Command.consumes
      • Command.as_plumbum()
      • Command.consumes
      • Command.creates
      • Command.dirname
      • Command.env()
      • Command.label
      • Command.name
      • Command.output
      • Command.path
      • Command.rendered_args()
    • ConstStrRenderer
      • ConstStrRenderer.rendered()
      • ConstStrRenderer.unrendered
      • ConstStrRenderer.value
    • OnlyIn
      • OnlyIn.rev_range
      • OnlyIn.unwrap()
      • OnlyIn.workload_set
    • PathRenderStrategy
      • PathRenderStrategy.rendered()
      • PathRenderStrategy.unrendered
    • PathToken
      • PathToken.dirname
      • PathToken.exists()
      • PathToken.left
      • PathToken.make_token()
      • PathToken.name
      • PathToken.render()
      • PathToken.renderer
      • PathToken.right
    • ProjectCommand
      • ProjectCommand.command
      • ProjectCommand.path
      • ProjectCommand.project
    • ProjectRoot()
    • PruneFn
    • RestoreFn
    • RootRenderer
      • RootRenderer.rendered()
      • RootRenderer.unrendered
    • SourceRoot()
    • SourceRootRenderer
      • SourceRootRenderer.local
      • SourceRootRenderer.rendered()
      • SourceRootRenderer.unrendered
    • SupportsUnwrap
      • SupportsUnwrap.unwrap()
    • WorkloadSet
      • WorkloadSet.unwrap()
    • cleanup()
    • filter_workload_index()
    • project_root()
    • source_root()
    • unwrap()
• Source
  • Base
    • BaseSource
    • ContextAwareSource
      • ContextAwareSource.is_context_free()
      • ContextAwareSource.versions_with_context()
    • ContextEnumeratorFn
    • ContextFreeMixin
      • ContextFreeMixin.is_context_free()
      • ContextFreeMixin.versions_with_context()
    • EnumeratorFn
    • Expandable
      • Expandable.is_expandable
      • Expandable.versions()
    • Fetchable
      • Fetchable.fetch()
      • Fetchable.key
      • Fetchable.local
      • Fetchable.remote
    • FetchableSource
      • FetchableSource.default
      • FetchableSource.explore()
      • FetchableSource.fetch()
      • FetchableSource.is_expandable
      • FetchableSource.key
      • FetchableSource.local
      • FetchableSource.remote
      • FetchableSource.version()
      • FetchableSource.versions()
    • NoSource
      • NoSource.default
      • NoSource.fetch()
      • NoSource.version()
      • NoSource.versions()
    • Revision
      • Revision.extend()
      • Revision.has_variant()
      • Revision.primary
      • Revision.project_cls
      • Revision.sorted()
      • Revision.source_by_name()
      • Revision.update()
      • Revision.variant_by_name()
      • Revision.variants
    • RevisionStr
      • RevisionStr.value
    • Variant
      • Variant.name()
      • Variant.owner
      • Variant.source()
      • Variant.version
    • Versioned
      • Versioned.default
      • Versioned.version()
      • Versioned.versions()
    • enumerate_revisions()
    • nosource()
    • primary()
    • product()
    • revision_from_str()
    • secondaries()
    • sources_as_dict()
    • target_prefix()
    • to_str()
  • Git
    • Git
      • Git.default
      • Git.fetch()
      • Git.version()
      • Git.versions()
    • GitSubmodule
      • GitSubmodule.is_expandable
    • clone_needed()
    • maybe_shallow()
  • HTTP
    • HTTP
      • HTTP.default
      • HTTP.fetch()
      • HTTP.fetch_version()
      • HTTP.version()
      • HTTP.versions()
    • HTTPMultiple
      • HTTPMultiple.fetch_version()
    • HTTPUntar
      • HTTPUntar.version()
    • download_required()
    • download_single_version()
    • normalize_remotes()
    • versioned_target_name()
  • RSync
  • Module: source
• Environment
• Project
• Experiment
• SLURM
  • Basics
  • Template customization
• CLI
• 6.8 (2023-10-09)
  • Features
  • Bug Fixes
• 6.7 (2023-04-04)
  • Features
  • Bug Fixes
• Changelog
  • 6.6.4 (2023-03-16)
  • 6.6.3 (2023-03-06)
  • 6.6.2 (2023-03-06)
    • Bug Fixes
  • 6.6.1 (2023-01-10)
    • Features
    • Bug Fixes
  • 6.5 (2022-11-03)
    • Feat
    • Fix
    • Refactor
  • 6.4 (2022-09-21)
    • Feat
    • Fix
    • Refactor
  • 6.3.2 (2022-08-21)
    • Feat
    • Fix
    • Refactor
  • 6.3.1 (2022-03-01)
    • Feat
    • Fix
    • Refactor
  • 6.3 (2022-02-03)
    • Feat
    • Fix
    • Refactor
  • 6.2.7 (2021-09-21)
  • 6.2.6 (2021-09-16)
    • Fix
  • 6.2.5 (2021-09-15)
    • Feat
  • 6.2.4 (2021-09-03)
  • 6.2.3 (2021-08-26)
    • Fix
  • 6.2.2 (2021-07-29)
  • 6.2.1 (2021-07-06)
    • Feat
    • Fix
  • 6.2 (2021-06-02)
    • Fix
  • 6.1.1 (2021-05-11)
    • Fix
  • 6.1 (2021-05-11)
    • Feat
    • Fix
    • Refactor
  • 6.0.1 (2020-12-29)
    • Fix

Indices and tables

• Index

• Module Index

• Search Page