[Scripts] Add worktree setup script and docs#229
Merged
Conversation
Adds scripts/setup_worktree.sh which creates a sibling git worktree off a base ref (default origin/develop), writes a per-worktree .envrc that sets TORCHSIM_DIR / dump / log / config paths and a PYTHONPATH override so the conda-wide editable install of torch_openreg does not pin every worktree to the same .so, and unsets upstream tracking so the first git push lands on the new branch instead of develop. docs/worktrees.md documents usage, the three things the script keeps in sync, and the build_ext --inplace vs pip install -e tradeoff. Container-dedicated: GEM5_PATH, TORCHSIM_LLVM_PATH, and RISCV are hardcoded to the ghcr.io/psal-postech/torchsim-ci layout. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
scripts/setup_worktree.shcreates a sibling git worktree off a base ref (defaultorigin/develop), writes a per-worktree.envrc, and unsets upstream tracking so the firstgit pushdoes not targetdevelop..envrcoverridesTORCHSIM_DIR,TORCHSIM_DUMP_PATH,TORCHSIM_LOG_PATH,TOGSIM_CONFIG, and prepends the worktree'sPyTorchSimDevicetoPYTHONPATHsoimport torch_openregresolves to the active worktree's.soeven though the conda-wide editable install points at one fixed worktree.docs/worktrees.mdwalks through the workflow, the three things the script keeps in sync, and whybuild_ext --inplaceis preferred over re-runningpip install -eper worktree.Container-dedicated:
GEM5_PATH,TORCHSIM_LLVM_PATH,RISCVare hardcoded to theghcr.io/psal-postech/torchsim-cilayout.