pipeline README: the CONFIG block is not pre-filled for 34-ID-E#10
Merged
Conversation
The quick start said the beamline's values were "already filled in" and that editing the CONFIG block was the way to change them. The installed run_laue.sh is byte-identical to the repo's, whose defaults are portable (WORK=$HOME/laue_run, PY=python) -- the site paths are supplied per run in the environment, which is how every run in the July 2026 campaign was actually launched. Left as written, a new user follows the quick start, gets WORK=$HOME/laue_run, and the parameter lookup fails against a path that was never theirs. Show the env-carrying launch line instead, keep the table as the 34-ID-E reference values, and say what an unset WORK does.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Found while syncing the beamline install to merged
main: the installedrun_laue.shis byte-identical to the repo's, whose CONFIG defaults are portable (WORK=$HOME/laue_run,PY=python). The quick start claimed the 34-ID-E values were "already filled in" and that editing the block was how to change them.Every run in the July 2026 campaign actually carried the site paths in the environment. Left as written, a new user follows the quick start, silently gets
WORK=$HOME/laue_run, and the parameter lookup fails against a path that was never theirs — a wrong path, not a missing one.Shows the env-carrying launch line, keeps the table as the 34-ID-E reference values, notes that every CONFIG entry is
${VAR:-default}so either route works, and states what an unsetWORKdoes.Docs only.