Add set_execution_mode param and UDOCKER_SET_EXECUTION_MODE to for udocker run #444
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New Feature: Automatic Execution Mode Setting
This PR adds a new configuration parameter
set_execution_modeand environment variableUDOCKER_SET_EXECUTION_MODEthat allows automatic setting of execution mode when running containers from images.What it does
When
UDOCKER_SET_EXECUTION_MODEis set, udocker will automatically create a container and set the execution mode before running when usingudocker runwith an image name. This eliminates the need for manual container creation and execution mode setup.Example Usage
Before (manual approach):
After (automatic approach):
export UDOCKER_SET_EXECUTION_MODE=F3 udocker run quay.io/pacbio/hiphase:1.5.0_build1 hiphase --helpConfiguration Options
The feature can be configured in two ways:
Environment variable:
export UDOCKER_SET_EXECUTION_MODE=F3Configuration file (
~/.udocker/udocker.conf):set_execution_mode = F3Documentation Updates
CHANGELOG.mdwith version 1.3.18 entrydocs/installation_manual.mddocs/reference_card.mddocs/user_manual.mdThis feature is particularly useful for users who use tools like miniwdl that invoke udocker run with a image:tag, but need to specify specific execution modes and do not have an option to use the create + setup + run strategy.