Add a topic on jupyter-lmod in documentation#640
Open
Conversation
wpoely86
reviewed
Mar 24, 2023
wpoely86
approved these changes
Mar 27, 2023
cmd-ntrf
commented
Mar 27, 2023
lexming
reviewed
Apr 3, 2023
lexming
left a comment
There was a problem hiding this comment.
Looks good, I only have a few minor comments. Please see below
| Jupyter and Lmod | ||
| ================ | ||
|
|
||
| It is possible to use Lmod inside of Jupyter with the terminal or jupyter-lmod. |
There was a problem hiding this comment.
Maybe add a link to your repo from the start 🙂
Suggested change
| It is possible to use Lmod inside of Jupyter with the terminal or jupyter-lmod. | |
| It is possible to use Lmod inside of Jupyter with its terminal or the Jupyter extension `jupyter-lmod <https://github.com/cmd-ntrf/jupyter-lmod>`_. |
Comment on lines
+29
to
+32
| jupyter-lmod uses lmod python interface to generate Python code | ||
| that modifies the environment variables of the Python process running Jupyter. All child | ||
| processes of Jupyter (including kernels) created after Lmod calls inherit | ||
| the environment variables as defined by the set of loaded modules. |
There was a problem hiding this comment.
This sentence is a bit confusing, I suggest to simplify it:
Suggested change
| jupyter-lmod uses lmod python interface to generate Python code | |
| that modifies the environment variables of the Python process running Jupyter. All child | |
| processes of Jupyter (including kernels) created after Lmod calls inherit | |
| the environment variables as defined by the set of loaded modules. | |
| jupyter-lmod uses lmod python interface to generate Python code | |
| that modifies the environment variables of the Python process running Jupyter. All child | |
| processes of Jupyter (*e.g.* newly spawned kernels) will inherit the environment | |
| as currently defined by the set of loaded modules. |
Comment on lines
+51
to
+53
| If the environment variables are defined before JupyterHub launch, you can add their | ||
| names only to `c.Spawner.env_keep <https://jupyterhub.readthedocs.io/en/stable/api/spawner.html#jupyterhub.spawner.Spawner.env_keep>`_ | ||
| instead. |
There was a problem hiding this comment.
Technically these variable are only needed in the single-user server. JupyterHub itself does not need them.
Suggested change
| If the environment variables are defined before JupyterHub launch, you can add their | |
| names only to `c.Spawner.env_keep <https://jupyterhub.readthedocs.io/en/stable/api/spawner.html#jupyterhub.spawner.Spawner.env_keep>`_ | |
| instead. | |
| If the environment variables are already defined before JupyterHub is launched | |
| or before the single-user server starts (Jupyter Notebook or JupyterLab), | |
| you can propagate these variable by adding their names to | |
| `c.Spawner.env_keep <https://jupyterhub.readthedocs.io/en/stable/api/spawner.html#jupyterhub.spawner.Spawner.env_keep>`_ instead. |
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.
This is a first draft of new topic for Lmod's documentation and address issue #639.
Comments and thoughts are welcomed.