-
Notifications
You must be signed in to change notification settings - Fork 128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a topic on jupyter-lmod in documentation #640
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a link to your repo from the start 🙂
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>`_. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is a bit confusing, I suggest to simplify it:
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. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically these variable are only needed in the single-user server. JupyterHub itself does not need them.
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 is a first draft of new topic for Lmod's documentation and address issue #639.
Comments and thoughts are welcomed.