WIP: Add docs on how to use ToolBox with Jupyter notebooks on Maxwell

Hi all,

This is a suggestion on how to use the Toolbox (on environments) in Maxwell jupyter notebooks.

The integral part of this process is that the environment is installed at <PROPOSAL_PATH>/usr/Software/envs as suggested by the install script at !109 (closed). This path can be still changed from the future discussions, but we should consider enforcing a uniform environment path for all proposal as early as possible to avoid confusion.

I am also not keen of making the user copy/pasting some code on their notebook to install the kernel.. would it be possible to use a shared folder to store scripts? Probably /gpfs/exfel/data/group/scs could be a candidate: then the user can just run !python gpfs/exfel/data/group/scs/scripts/install_kernel.py or something similar.

Please feel free to let me know what you think :D

@lleguy @mercadil @mercurio

added 1 commit

• 4ee4c819 - Add script for kernel setup

Compare with previous version

assigned to @lleguy

Thanks for the discussion earlier, @lleguy. As discussed, I added the setup_kernel script that can be run with or without an activated environment.

changed the description

changed target branch from refactor-packaging to master

Dear @carinanc what should we do with this MR ?

Sorry, this MR went unnoticed. There's a lot of changes from this time and I will rebase this branch and update the docs with the new script (scs-activate-toolbox-kernel). The setup scripts will also be removed. Changing to WIP for the meantime.

marked this merge request as draft

changed the description

assigned to @carinanc and unassigned @lleguy

closed