Changes for page Using JupyterHub in HDC

Last modified by Dennis Segebarth on 2024/10/02 18:14
From version 18.1
edited by Dennis Segebarth
on 2024/10/02 18:13
Change comment: There is no comment for this version
To version 1.6
edited by Susan Evans
on 2023/07/11 14:00
Change comment: (Autosaved)

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dsegebarth
1 +XWiki.sgevans
Content
... ... @@ -1,13 +6,5 @@
1 -{{box cssClass="floatinginfobox" title="Table of Contents"}}
2 -{{toc depth="2"/}}
3 -{{/box}}
4 -
5 -
6 6  JupyterHub is an open-source, multi-user version of Jupyter Notebook for performing analysis of Project files in the Core. More information can be found in the application documentation [[https:~~/~~/jupyter.org/>>https://jupyter.org/]].
7 7  
8 -[[image:1723798240534-407.png||height="189" width="291"]]
9 -
10 -
11 11  = How it Works =
12 12  
13 13  JupyterHub allows Project members to create or import Jupyter Notebooks into the Project Workspace environment, retrieve Project files from the Core, perform computational workflows on the data, and write the outputs back to the Core where they can be accessed by other Project members. JupyterHub spins up a new JupyterLab instance for each Project member.
... ... @@ -25,13 +25,9 @@
25 25  
26 26  JupyterHub is configured at the time of Project Setup. If you launch JupyterHub and receive a notice that it hasn’t been deployed for your project, please contact your Platform Administrator.
27 27  
28 -{{info}}
29 -If you access JupyterHub of the HealthDataCloud Test Project, please be aware that the resources are limited for each user to: 2 GB of persistent storage volume, 4 GB memory, and a single CPU. These limitations can easily be adjusted for new Projects.
30 -{{/info}}
31 -
32 32  = Launching JupyterHub =
33 33  
34 -[[image:1723798257792-201.png||height="121" width="349"]]
22 +[[image:HDC Project Workspace tool navigation Jupyterhub v1.0.0 2023-05-25.png||height="10%" width="30%"]]
35 35  
36 36  1. Launch your Project and click the **JupyterHub icon** in the left menu bar.
37 37  1. Click **Sign in with Keycloak** to initiate your session. JupyterHub automatically authenticates with your existing username and password and launches your session - no additional sign-in is required.
... ... @@ -46,7 +46,7 @@
46 46  1. In the Launcher, click the **Python 3 Notebook **icon, or click **File > New > Notebook**.
47 47  1. Create your Notebook.
48 48  
49 -[[image:1723798278604-114.png||height="376" width="865"]]
37 +[[image:Project Workspace Jupyter Create Python Notebook v2.1.6 2023-02-07.png||height="22%" width="50%"]]
50 50  
51 51  = Launching the Terminal =
52 52  
... ... @@ -55,7 +55,7 @@
55 55  1. In the Launcher, click the **Terminal **icon, or click **File > New > Terminal**.
56 56  1. The terminal window opens.
57 57  
58 -[[image:1723798293872-992.png||height="162" width="863"]]
46 +[[image:Project Workspace Jupyter Launch Terminal v2.1.6 2023-02-07.png||height="9%" width="50%"]]
59 59  
60 60  Ubuntu is used to host Jupyter Notebook. Use the command cat /etc/os-release to determine to current version of Ubuntu:
61 61  
... ... @@ -192,12 +192,12 @@
192 192  
193 193  Afterwards, the environment will be listed when you open the Launcher to open a new Jupyter Notebook:
194 194  
195 -[[image:1723798325144-485.png||height="436" width="867"]]
183 +[[image:Project Workspace Jupyter view new Kernel 2023-07-11.png||height="25%" width="50%"]]
196 196  
197 197  
198 198  and also from each opened Notebook, e.g., via **Kernel > Change Kernel…** :
199 199  
200 -[[image:1723798338447-469.png||height="317" width="247"]]
188 +[[image:Project Workspace Jupyter Kernel change Kernel dropdown 2023-07-11.png||height="64%" width="50%"]]
201 201  
202 202  = Installing New Python Packages =
203 203  
... ... @@ -287,9 +287,9 @@
287 287  * Open the login window and enter your HDC username and password (i.e. your EBRAINS account credentials).
288 288  * Grant access by clicking **Yes**.
289 289  
290 -[[image:1723798355215-434.png||height="352" width="379"]]
278 +[[image:Pilotcli Jupyter user login Grant Access window v2.4.0 2023-05-25.png||height="46%" width="50%"]]
291 291  
292 -[[image:1723798365454-527.png||height="123" width="376"]]
280 +[[image:Pilotcli Jupyter user login Device Login Successful v2.4.0 2023-05-25.png||height="16%" width="50%"]]
293 293  
294 294  * After successful confirmation, return to the terminal in your JupyterHub browser tab.
295 295  
... ... @@ -352,9 +352,9 @@
352 352  Reminder: Please follow Linux conventions for file management. If your filename contains spaces, wrap it in single or double quotes.
353 353  
354 354  * //Filename~:// “Chemical Tracking Data.csv”
355 -* //Source~:// Project “Indoc Test Project”, “Core” storage zone, folder “collaborator4” {{code}}indoctestproject/collaborator4/Chemical Tracking Data.csv -z core{{/code}}
356 -* //Destination: //user's Home directory in the Guacamole or JupyterHub VM {{code}}.{{/code}}
357 -* //Command group/option: //{{code}}file sync{{/code}}
343 +* //Source~:// Project “Indoc Test Project”, “Core” storage zone, folder “collaborator4” indoctestproject/collaborator4/Chemical Tracking Data.csv -z core
344 +* //Destination: //user's Home directory in the Guacamole or JupyterHub VM .
345 +* //Command group/option: //file sync
358 358  
359 359  {{code language="none"}}
360 360  collaborator4@jupyter-collaborator4:~$ pilotcli file sync indoctestproject/collaborator4/'Chemical Tracking Data.csv' . -z core
... ... @@ -363,60 +363,10 @@
363 363  File has been downloaded successfully and saved to: ./Chemical Tracking Data.csv
364 364  {{/code}}
365 365  
366 -To confirm successful download, type {{code}}ls{{/code}} and verify the file "Chemical Tracking Data.csv" is stored in the Home folder.
367 367  
368 -{{code language="none"}}
369 -collaborator4@jupyter-collaborator4:~$ ls
370 -'Chemical Tracking Data.csv' pilotcli
371 -{{/code}}
372 372  
373 -The file “Chemical Tracking Data.csv” can be viewed in the JupyterHub graphical user interface:
374 374  
375 -[[image:1723798383409-873.png||height="267" width="874"]]
376 376  
358 +To confirm successful download, type ls and verify the file {{code}}Chemical Tracking Data.csv{{/code}} is stored in the Home folder.
377 377  
378 -== Uploading Project Data from JupyterHub using the Pilot Command Line Interface ==
379 -
380 -After analyzing Project data inside the JupyterHub, you can upload the generated outputs back into the Project via the Pilot Command Line Interface.
381 -
382 -=== Example ===
383 -
384 -* //Filename//: Chemical Tracking Data rev.csv
385 -* //Source~:// user's Home directory in JupyterHub {{code}}.{{/code}}
386 -* //Destination//: Project “Indoc Test Project”, folder “collaborator4”, “Core” storage zone,
387 -{{code}}indoctestproject/collaborator4{{/code}} {{code}}-z core{{/code}}
388 -* //Command group/option~:// {{code}}file upload{{/code}}
389 -* //User message// (for upload back to the Core): “my workbench output, no additional sensitive data"
390 -* //Command~:// {{code}}pilotcli file upload ./'Chemical Tracking Data rev.csv' -p{{/code}} {{code}}indoctestproject/collaborator4 -z core -m "my workbench output, no additional sensitive data"{{/code}}
391 -
392 -When uploading data to the Core, you are reminded that you are bypassing the usual Green Room upload workflow. To confirm, type {{code}}y{{/code}} at the prompt, or {{code}}N{{/code}} to cancel.
393 -
394 -{{code language="none"}}
395 -collaborator4@jupyter-collaborator4:~$ pilotcli file upload ./'Chemical Tracking Data rev.csv' -p indoctestproject/collaborator4 -z core -m "my workbench output, no additional sensitive data"
396 -You are about to transfer data directly to the PILOT Core! In accordance with the PILOT Terms of Use, please confirm that you have made your best efforts to
397 -pseudonymize or anonymize the data and that you have the legal authority to transfer and make this data available for dissemination and use within the PILOT .If you
398 -need to process the data to remove sensitive identifiers, please cancel this transfer and upload the data to the Green Room to perform these actions.
399 -To cancel this transfer, enter [n/No]
400 -To confirm and proceed with the data transfer, enter [y/Yes]
401 - [y/N]: y
402 -Starting upload of: ./Chemical Tracking Data rev.csv
403 -Pre-upload complete.
404 -Uploading Chemical Tracking Data rev.csv: |██████████████████████████████ 100% 00:00
405 -Upload Time: 2.92s for 1 files
406 -All uploading jobs have finished.
407 -{{/code}}
408 -
409 -After completing the upload, you can confirm the new file “Chemical Tracking Data rev.csv" exists in the correct directory using the pilotcli file list command and/or in the Portal File Explorer.
410 -
411 -{{code language="none"}}
412 -collaborator4@jupyter-collaborator4:~$ pilotcli file list indoctestproject/collaborator4 -z core
413 -Chemical Tracking Data rev.csv Chemical Tracking Data.csv
414 -{{/code}}
415 -
416 -[[image:1723798397694-530.png||height="217" width="863"]]
417 -
418 -----
419 -
420 -Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]].
421 -
422 -HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
360 +[[image:Jupyter downloaded file in Home folder v2.4.11 2023-05-25 1850.png||height="15%" width="50%"]]
1723798240534-407.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -18.0 KB
Content
1723798257792-201.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -42.2 KB
Content
1723798278604-114.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -216.4 KB
Content
1723798293872-992.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -113.5 KB
Content
1723798325144-485.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -423.2 KB
Content
1723798338447-469.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -27.1 KB
Content
1723798355215-434.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -14.1 KB
Content
1723798365454-527.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -10.0 KB
Content
1723798383409-873.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -30.1 KB
Content
1723798397694-530.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -166.8 KB
Content
HDC Project Workspace tool navigation Jupyterhub v1.0.0 2023-05-25.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +40.6 KB
Content
Jupyter downloaded file in Home folder v2.4.11 2023-05-25 1850.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +35.0 KB
Content
Pilotcli Jupyter user login Device Login Successful v2.4.0 2023-05-25.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +10.3 KB
Content
Pilotcli Jupyter user login Grant Access window v2.4.0 2023-05-25.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +13.9 KB
Content
Project Workspace Jupyter Create Python Notebook v2.1.6 2023-02-07.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +793.7 KB
Content
Project Workspace Jupyter Kernel change Kernel dropdown 2023-07-11.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +38.9 KB
Content
Project Workspace Jupyter Launch Terminal v2.1.6 2023-02-07.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +346.3 KB
Content
Project Workspace Jupyter view new Kernel 2023-07-11.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +490.0 KB
Content