Mher/spd 588/picas course post merge reviews#46
Mher/spd 588/picas course post merge reviews#46mherkazandjian wants to merge 3 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the environment setup tutorial to improve the process of cloning and setting up the PiCaS client repository. The changes remove hard-coded version constraints and introduce a more flexible approach to branch/tag selection while standardizing shell command execution.
Key changes:
- Removes version pinning from git clone command and adds manual branch/tag switching capability
- Replaces individual shell commands with bash magic cells for better organization and execution context
- Adds consistent directory navigation and virtual environment activation patterns
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| # %% | ||
| # cd into the picasclient directory and switch to a specific branch or tag if needed | ||
| %cd picasclient |
There was a problem hiding this comment.
The %cd magic command changes the working directory for the entire notebook session, but the subsequent bash cells use absolute paths (cd ~/picas_tutorial). This creates inconsistent directory context and may cause confusion about the current working directory.
| ! python3 -m pip install --upgrade pip | ||
| ! pip install picas | ||
| %%bash | ||
| cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate |
There was a problem hiding this comment.
The pattern cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate is repeated multiple times. Consider defining this as a variable or using a more consistent approach to reduce duplication.
| ! python3 -m pip install --upgrade pip | ||
| ! python3 -m pip install poetry | ||
| %%bash | ||
| cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate |
There was a problem hiding this comment.
The pattern cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate is repeated multiple times. Consider defining this as a variable or using a more consistent approach to reduce duplication.
| # %% | ||
| ! python3 -m poetry lock | ||
| %%bash | ||
| cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate |
There was a problem hiding this comment.
The pattern cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate is repeated multiple times. Consider defining this as a variable or using a more consistent approach to reduce duplication.
| # %% | ||
| ! python3 -m poetry install | ||
| %%bash | ||
| cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate |
There was a problem hiding this comment.
The pattern cd ~/picas_tutorial && source .venv/picas-tutorial/bin/activate is repeated multiple times. Consider defining this as a variable or using a more consistent approach to reduce duplication.
| # switch to a specific branch or tag | ||
| #! git checkout some-branch-or-tag | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
The commented command git checkout some-branch-or-tag uses a placeholder but lacks clear guidance on what specific branch or tag users should actually use. Consider providing more specific examples or instructions.
| # switch to a specific branch or tag | |
| #! git checkout some-branch-or-tag | |
| # To see available branches, run: | |
| #! git branch -a | |
| # To see available tags, run: | |
| #! git tag | |
| # To switch to a specific branch (e.g., 'main'), run: | |
| #! git checkout main | |
| # To switch to a specific tag (e.g., 'v1.0.0'), run: | |
| #! git checkout v1.0.0 |
No description provided.