Changes for page Using JupyterHub in HDC

Last modified by Dennis Segebarth on 2024/10/02 18:14
From version 1.3
edited by Susan Evans
on 2023/07/11 13:45
Change comment: (Autosaved)
To version 9.1
edited by Dennis Segebarth
on 2024/08/16 08:54
Change comment: Deleted image "Project Workspace Jupyter Kernel change Kernel dropdown 2023-07-11.png"

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sgevans
1 +XWiki.dsegebarth
Content
... ... @@ -1,5 +1,13 @@
1 +{{box cssClass="floatinginfobox" title="Table of Contents"}}
2 +{{toc depth="2"/}}
3 +{{/box}}
4 +
5 +
1 1  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/]].
2 2  
8 +[[image:1723798240534-407.png||height="189" width="291"]]
9 +
10 +
3 3  = How it Works =
4 4  
5 5  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.
... ... @@ -19,7 +19,7 @@
19 19  
20 20  = Launching JupyterHub =
21 21  
22 -[[image:HDC Project Workspace tool navigation Jupyterhub v1.0.0 2023-05-25.png||height="10%" width="30%"]]
30 +[[image:1723798257792-201.png||height="121" width="349"]]
23 23  
24 24  1. Launch your Project and click the **JupyterHub icon** in the left menu bar.
25 25  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.
... ... @@ -34,7 +34,7 @@
34 34  1. In the Launcher, click the **Python 3 Notebook **icon, or click **File > New > Notebook**.
35 35  1. Create your Notebook.
36 36  
37 -[[image:Project Workspace Jupyter Create Python Notebook v2.1.6 2023-02-07.png||height="22%" width="50%"]]
45 +[[image:1723798278604-114.png||height="376" width="865"]]
38 38  
39 39  = Launching the Terminal =
40 40  
... ... @@ -43,7 +43,7 @@
43 43  1. In the Launcher, click the **Terminal **icon, or click **File > New > Terminal**.
44 44  1. The terminal window opens.
45 45  
46 -[[image:Project Workspace Jupyter Launch Terminal v2.1.6 2023-02-07.png||height="9%" width="50%"]]
54 +[[image:1723798293872-992.png||height="162" width="863"]]
47 47  
48 48  Ubuntu is used to host Jupyter Notebook. Use the command cat /etc/os-release to determine to current version of Ubuntu:
49 49  
... ... @@ -180,12 +180,12 @@
180 180  
181 181  Afterwards, the environment will be listed when you open the Launcher to open a new Jupyter Notebook:
182 182  
183 -[[image:Project Workspace Jupyter view new Kernel 2023-07-11.png||height="25%" width="50%"]]
191 +[[image:1723798325144-485.png||height="436" width="867"]]
184 184  
185 185  
186 186  and also from each opened Notebook, e.g., via **Kernel > Change Kernel…** :
187 187  
188 -[[image:Project Workspace Jupyter Kernel change Kernel dropdown 2023-07-11.png||height="64%" width="50%"]]
196 +[[image:1723798338447-469.png||height="317" width="247"]]
189 189  
190 190  = Installing New Python Packages =
191 191  
... ... @@ -275,9 +275,9 @@
275 275  * Open the login window and enter your HDC username and password (i.e. your EBRAINS account credentials).
276 276  * Grant access by clicking **Yes**.
277 277  
278 -[[image:Pilotcli Jupyter user login Grant Access window v2.4.0 2023-05-25.png||height="46%" width="50%"]]
286 +[[image:1723798355215-434.png||height="352" width="379"]]
279 279  
280 -[[image:Pilotcli Jupyter user login Device Login Successful v2.4.0 2023-05-25.png||height="16%" width="50%"]]
288 +[[image:1723798365454-527.png||height="123" width="376"]]
281 281  
282 282  * After successful confirmation, return to the terminal in your JupyterHub browser tab.
283 283  
... ... @@ -291,26 +291,14 @@
291 291  
292 292  When using the Pilot Command Line Interface in JupyterHub and the following actions are possible on the derivative files generated in JupyterHub:
293 293  
294 -{table}
295 -**File Operation** | **Permitted in the **
296 -**Green Room**
297 -Word 1 | Word 2
298 -{table}
299 -
300 300  |=(% colspan="1" rowspan="1" %)(((
301 301  **File Operation**
302 -
303 -
304 304  )))|=(% colspan="1" rowspan="1" %)(((
305 305  **Permitted in the **
306 -**Green Room**
307 -
308 -
306 +**Green Room**
309 309  )))|=(% colspan="1" rowspan="1" %)(((
310 310  **Permitted in the **
311 -**Core**
312 -
313 -
309 +**Core**
314 314  )))
315 315  |(% colspan="1" rowspan="1" %)File upload 
316 316  (upload derivative output files from JupyterHub to the Green Room or Core storage)|(% colspan="1" rowspan="1" %)(((
... ... @@ -325,6 +325,99 @@
325 325  Yes
326 326  )))
327 327  
324 +== Downloading Project Data to JupyterHub using the Pilot Command Line Interface ==
328 328  
326 +After logging into the Pilot Command Line Interface, you can download data from the Project Core into the JupyterHub environment to start your data analyses.
329 329  
330 -
328 +File related commands are grouped in the {{code}}file{{/code}} category. To view the full list of commands in this category, type {{code}}pilotcli file --help{{/code}}. To download project data, use the file sync command. To view the full list of commands in this category, type {{code}}pilotcli file sync --help{{/code}}.
329 +
330 +
331 +{{code language="none"}}
332 +collaborator4@jupyter-collaborator4:~$ pilotcli file sync --help
333 +Usage: pilotcli file sync [OPTIONS] [PATHS]... OUTPUT_PATH
334 +
335 + Download files/folders from a given Project/folder/file in core zone.
336 +
337 +Options:
338 + -z, --zone TEXT Target Zone (i.e., core/greenroom)
339 + --zip Download files as a zip.
340 + -i, --geid Enable downloading by geid.
341 + --help Show this message and exit.
342 +{{/code}}
343 +
344 +=== Example ===
345 +
346 +Downloading a file from the Core to your Home Directory:
347 +
348 +Reminder: Please follow Linux conventions for file management. If your filename contains spaces, wrap it in single or double quotes.
349 +
350 +* //Filename~:// “Chemical Tracking Data.csv”
351 +* //Source~:// Project “Indoc Test Project”, “Core” storage zone, folder “collaborator4” {{code}}indoctestproject/collaborator4/Chemical Tracking Data.csv -z core{{/code}}
352 +* //Destination: //user's Home directory in the Guacamole or JupyterHub VM {{code}}.{{/code}}
353 +* //Command group/option: //{{code}}file sync{{/code}}
354 +
355 +{{code language="none"}}
356 +collaborator4@jupyter-collaborator4:~$ pilotcli file sync indoctestproject/collaborator4/'Chemical Tracking Data.csv' . -z core
357 +start downloading...
358 +Downloading Chemical Tracking Data.csv |██████████████████████████████ 100% 00:00
359 +File has been downloaded successfully and saved to: ./Chemical Tracking Data.csv
360 +{{/code}}
361 +
362 +To confirm successful download, type {{code}}ls{{/code}} and verify the file "Chemical Tracking Data.csv" is stored in the Home folder.
363 +
364 +{{code language="none"}}
365 +collaborator4@jupyter-collaborator4:~$ ls
366 +'Chemical Tracking Data.csv' pilotcli
367 +{{/code}}
368 +
369 +The file “Chemical Tracking Data.csv” can be viewed in the JupyterHub graphical user interface:
370 +
371 +[[image:1723798383409-873.png||height="267" width="874"]]
372 +
373 +
374 +== Uploading Project Data from JupyterHub using the Pilot Command Line Interface ==
375 +
376 +After analyzing Project data inside the JupyterHub, you can upload the generated outputs back into the Project via the Pilot Command Line Interface.
377 +
378 +=== Example ===
379 +
380 +* //Filename//: Chemical Tracking Data rev.csv
381 +* //Source~:// user's Home directory in JupyterHub {{code}}.{{/code}}
382 +* //Destination//: Project “Indoc Test Project”, folder “collaborator4”, “Core” storage zone,
383 +{{code}}indoctestproject/collaborator4{{/code}} {{code}}-z core{{/code}}
384 +* //Command group/option~:// {{code}}file upload{{/code}}
385 +* //User message// (for upload back to the Core): “my workbench output, no additional sensitive data"
386 +* //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}}
387 +
388 +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.
389 +
390 +{{code language="none"}}
391 +collaborator4@jupyter-collaborator4:~$ pilotcli file upload ./'Chemical Tracking Data rev.csv' -p indoctestproject/collaborator4 -z core -m "my workbench output, no additional sensitive data"
392 +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
393 +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
394 +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.
395 +To cancel this transfer, enter [n/No]
396 +To confirm and proceed with the data transfer, enter [y/Yes]
397 + [y/N]: y
398 +Starting upload of: ./Chemical Tracking Data rev.csv
399 +Pre-upload complete.
400 +Uploading Chemical Tracking Data rev.csv: |██████████████████████████████ 100% 00:00
401 +Upload Time: 2.92s for 1 files
402 +All uploading jobs have finished.
403 +{{/code}}
404 +
405 +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.
406 +
407 +{{code language="none"}}
408 +collaborator4@jupyter-collaborator4:~$ pilotcli file list indoctestproject/collaborator4 -z core
409 +Chemical Tracking Data rev.csv Chemical Tracking Data.csv
410 +{{/code}}
411 +
412 +[[image:1723798397694-530.png||height="217" width="863"]]
413 +
414 +----
415 +
416 +Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]].
417 +
418 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
419 +
Project Workspace Jupyter Kernel change Kernel dropdown 2023-07-11.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.sgevans
Size
... ... @@ -1,1 +1,0 @@
1 -38.9 KB
Content
Project Workspace Jupyter view new Kernel 2023-07-11.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.sgevans
Size
... ... @@ -1,1 +1,0 @@
1 -490.0 KB
Content
1723798240534-407.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +18.0 KB
Content
1723798257792-201.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +42.2 KB
Content
1723798278604-114.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +216.4 KB
Content
1723798293872-992.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +113.5 KB
Content
1723798325144-485.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +423.2 KB
Content
1723798338447-469.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +27.1 KB
Content
1723798355215-434.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +14.1 KB
Content
1723798365454-527.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +10.0 KB
Content
1723798383409-873.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +30.1 KB
Content
1723798397694-530.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +166.8 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
Jupyterhub file upload back to core v2.4.11 2023-05-25 1926.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +507.5 KB
Content
Jupyterhub-Logo-300x100px cropped.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.sgevans
Size
... ... @@ -1,0 +1,1 @@
1 +27.7 KB
Content