Streamline notes on jupyter kernels#1306
Conversation
|
Test deployment successful!! (2026-06-19T02:14:31Z)
See all deployed demo sites |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
Ahoy, ye scallywags! This patch merges the manual and tool-assisted Jupyter kernel guides into a single scroll, but ye've left a trail of clumsy errors in yer wake. Ye've got double-path blunders in yer conda and virtual environment activation scripts, duplicate links pointing to the same spot in the index, and some truly shipwrecked markdown formatting with split backticks and italics where code backticks belong. Clean up yer mess before we make ye walk the plank!
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| # activate conda environment | ||
| source $(conda info --base)/etc/profile.d/conda.sh | ||
| conda deactivate # workaround for https://github.com/conda/conda/issues/9392 | ||
| conda activate <full_path_to_your_conda_env>/my-conda-env |
There was a problem hiding this comment.
Avast, ye matey! If <full_path_to_your_conda_env> is already the absolute path to the environment ye created (which is my-conda-env), then appending /my-conda-env to it will have ye sailing straight into a double-path trap! Ye'll end up with /path/to/my-conda-env/my-conda-env, and conda will throw ye overboard. Fix this line to just activate the path itself!
| conda activate <full_path_to_your_conda_env>/my-conda-env | |
| conda activate <full_path_to_your_conda_env> |
| - [Jupyter kernels - Tool-Assisted Management](./Jupyter_kernels.md) (recommended) | ||
| - [Jupyter kernels - Manual Management](./Jupyter_kernels.md) |
There was a problem hiding this comment.
Ahoy! Why point the poor sailors to the exact same destination twice? Ye've got two links side-by-side pointing to the same ./Jupyter_kernels.md file. Merging 'em into a single descriptive link would save us some ink and keep the crew from sailing in circles!
| - [Jupyter kernels - Tool-Assisted Management](./Jupyter_kernels.md) (recommended) | |
| - [Jupyter kernels - Manual Management](./Jupyter_kernels.md) | |
| - [Jupyter kernels](./Jupyter_kernels.md) (Tool-Assisted or Manual Management) |
| module load Python/3.14.4-foss-2026 | ||
|
|
||
| # activate virtual environment | ||
| source <full_path_to_your_venv>/my-venv/bin/activate |
There was a problem hiding this comment.
Avast! This path source <full_path_to_your_venv>/my-venv/bin/activate might lead to a double-path blunder if the user thinks <full_path_to_your_venv> is the path to the virtual environment itself! Better to use <full_path_to_your_venv>/bin/activate and make sure they know it points directly to the my-venv directory!
| source <full_path_to_your_venv>/my-venv/bin/activate | |
| source <full_path_to_your_venv>/bin/activate |
| module load Python/3.14.4-foss-2026 | ||
|
|
||
| # Activate the shared virtual environment | ||
| source <full_path_to_your_venv>/my-venv/bin/activate |
There was a problem hiding this comment.
Avast! Same as before, this path source <full_path_to_your_venv>/my-venv/bin/activate might lead to a double-path blunder if the user thinks <full_path_to_your_venv> is the path to the virtual environment itself! Better to use <full_path_to_your_venv>/bin/activate and make sure they know it points directly to the my-venv directory!
| source <full_path_to_your_venv>/my-venv/bin/activate | |
| source <full_path_to_your_venv>/bin/activate |
| (~/.local/share/jupyter/kernels/myrwithmpfr, assuming you kept `--name | ||
| myrwithmpfr` in the above command): |
There was a problem hiding this comment.
Shiver me timbers! Ye split the inline code backticks across two lines! Line 380 has the start backtick and line 381 has the end backtick. That'll surely wreck the markdown rendering on many a browser! Keep yer code inline on a single line, matey!\n\nFor example:\nmarkdown\n (~/.local/share/jupyter/kernels/myrwithmpfr, assuming you kept `--name myrwithmpfr`\n in the above command):\n
References
- Code should be used for any text that you want the user to copy exactly. (link)
| cd ~/.local/share/jupyter/kernels/my-conda-env | ||
| ``` | ||
|
|
||
| and edit the *kernel.json* to change the first element of the argv list |
There was a problem hiding this comment.
Avast! Ye should wrap kernel.json and argv in backticks instead of italics, so the crew knows they be code and files to be copied exactly! Otherwise, they might think it's just fancy talk!\n\nFor example:\nand edit the `kernel.json` to change the first element of the `argv` list\n\nThis also occurs on lines 330 and 408, so be sure to fix 'em all!
References
- Code should be used for any text that you want the user to copy exactly. (link)
1 participant
The current documentation on kernels is not clear. also, there are so many instructions that it is hard to know what to choose and where the docs are. Here, we use tabbing so that all the options are viewable, but only the option you care about is seeable.