{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"JupyterLab quick reference","type":"basic","slug":"editor-quick-reference","excerpt":"","body":"JupyterLab is one of the two available editors in Data Cruncher, where the actual code editing and execution takes place. This document provides a brief description of the JupyterLab environment and its commonly used commands.\n\n## The interface\n\nWhen you open JupyterLab, you see the **Launcher** screen that allows you to select one of the available options:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cc6bcba-jupyterlab-quick-reference-1.png\",\n        \"jupyterlab-quick-reference-1.png\",\n        659,\n        592,\n        \"#f4f4f4\"\n      ]\n    }\n  ]\n}\n[/block]\n\nChoose one of the options in the **Notebook** section, depending on the programming language you want to use. Available programming languages and their versions might differ depending on the selected [environment setup](doc:about-libraries-in-a-data-cruncher-analysis).\n\nThe editor screen showing a notebook and a terminal console open at the same time will look like this:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2fd0c06-jupyterlab-quick-reference-2.png\",\n        \"jupyterlab-quick-reference-2.png\",\n        1440,\n        682,\n        \"#f0eee9\"\n      ]\n    }\n  ]\n}\n[/block]\nThe main elements of the JupyterLab editor are:\n1. **Notebook** - The document that contains the code and outputs of an interactive analysis, as well as additional markdown or raw text that accompanies the code, but is not meant for execution.\n2. **Cell** - A single section of a notebook where you can enter code, markdown or raw text.\n3. **Toolbar** - Allows you to quickly perform the most common actions within a notebook, by clicking on an icon.\n4. **Left-hand panel** containing tabs that allow you to access some (or all) of the following functionalities:\n    * View and manage files that are created or added (uploaded or downloaded) within the analysis itself, including the Jupyter notebooks (`.ipynb` files). \n    * Manage kernel sessions that are currently running. One kernel session corresponds to one open notebook.\n    * View and use additional commands in the editor. To execute a command, click it in the list.\n    * Add notebook tags and metadata.\n    * Manage active tabs.\n5. **Terminal console** - This is a JupyterLab Terminal extension equivalent to a Linux shell.\n6. **Code Console** - Enables you to run code interactively in a kernel.\n7. **Back button** - Allows you to navigate back from the editor to the analysis details page.\n8. **Analysis control and help options**:\n    * **Stop** - Allows you to stop the analysis directly from the editor.\n    * **Help** - Displays a dropdown containing a link to Data Cruncher documentation and the link to the feedback form through which you can contact our Support Team.\n\nFor more details about the visual interface, see the [official JupyterLab documentation](https://jupyterlab.readthedocs.io/en/stable/user/interface.html).\n\n## Commonly used text commands\n\nBesides execution of Python, R or Julia code, you can also run the following types of commands directly in your notebook:\n\n* **Magic commands** - a set of predefined functions that you can call with a command line style syntax. Magic commands can begin with a single `%` symbol, in which case they take the rest of the line as an argument. If you prefix a magic command with a double `%` symbol (`%%`), it will take the rest of the cell as its argument. Learn more about [magic commands](http://ipython.readthedocs.io/en/stable/interactive/magics.html) or type `%magic` in a blank cell and execute it.\n* **Linux shell commands** - You can also run any system shell command by prefixing it with an exclamation mark (`!`), for example `!ls`. You can even combine shell commands with the rest of the code in your notebook, for example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"myfiles = !ls\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\n This line of code will assign the list of files returned by the `ls` command to the `myfiles` variable.\n\nFind out more about functionalities related to [text commands](http://ipython.readthedocs.io/en/stable/interactive/tutorial.html).","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"594ced741dcef4001c8a8603","project":"5773dcfc255e820e00e1cd4d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9","6024033e2b2f6f004dfe994c","60a7a12f9a06c70052b7c4db","60a7ab97266a4700161507c4","60b0c84babba720010a8b0b5"],"_id":"5773dcfc255e820e00e1cd50","__v":39,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Data Cruncher","slug":"data-cruncher","order":32,"from_sync":false,"reference":false,"_id":"594cebadd8a2f7001b0b53b2","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","createdAt":"2017-06-23T10:21:33.309Z","__v":0},"user":"575e85ac41c8ba0e00259a44","createdAt":"2017-06-23T10:29:08.653Z","githubsync":"","__v":0,"parentDoc":null}

Get started

Tutorials

CAVATICA Projects

Find apps

Find files

Add files to a project

Bring data to CAVATICA

Set metadata associated with a file

Collaborate securely

BRING YOUR TOOLS

Docker

Developer tools

EDIT AN APP

Tool wrapping tips and tricks

Describe your tool (Legacy)

Browse public datasets

Run an analysis

Task Execution

Review a task

INTERACTIVE ANALYSIS

Kids First studies

CAVATICA Datasets

CAVATICA API

Connect cloud storage

SBFS (Beta)

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

CAVATICA DATASETS API (Advanced Access)

Data Cruncher

SBFS (Beta)

SBFS Command reference

JupyterLab quick reference

JupyterLab is one of the two available editors in Data Cruncher, where the actual code editing and execution takes place. This document provides a brief description of the JupyterLab environment and its commonly used commands. ## The interface When you open JupyterLab, you see the **Launcher** screen that allows you to select one of the available options: [block:image] { "images": [ { "image": [ "https://files.readme.io/cc6bcba-jupyterlab-quick-reference-1.png", "jupyterlab-quick-reference-1.png", 659, 592, "#f4f4f4" ] } ] } [/block] Choose one of the options in the **Notebook** section, depending on the programming language you want to use. Available programming languages and their versions might differ depending on the selected [environment setup](doc:about-libraries-in-a-data-cruncher-analysis). The editor screen showing a notebook and a terminal console open at the same time will look like this: [block:image] { "images": [ { "image": [ "https://files.readme.io/2fd0c06-jupyterlab-quick-reference-2.png", "jupyterlab-quick-reference-2.png", 1440, 682, "#f0eee9" ] } ] } [/block] The main elements of the JupyterLab editor are: 1. **Notebook** - The document that contains the code and outputs of an interactive analysis, as well as additional markdown or raw text that accompanies the code, but is not meant for execution. 2. **Cell** - A single section of a notebook where you can enter code, markdown or raw text. 3. **Toolbar** - Allows you to quickly perform the most common actions within a notebook, by clicking on an icon. 4. **Left-hand panel** containing tabs that allow you to access some (or all) of the following functionalities: * View and manage files that are created or added (uploaded or downloaded) within the analysis itself, including the Jupyter notebooks (`.ipynb` files).  * Manage kernel sessions that are currently running. One kernel session corresponds to one open notebook. * View and use additional commands in the editor. To execute a command, click it in the list. * Add notebook tags and metadata. * Manage active tabs. 5. **Terminal console** - This is a JupyterLab Terminal extension equivalent to a Linux shell. 6. **Code Console** - Enables you to run code interactively in a kernel. 7. **Back button** - Allows you to navigate back from the editor to the analysis details page. 8. **Analysis control and help options**: * **Stop** - Allows you to stop the analysis directly from the editor. * **Help** - Displays a dropdown containing a link to Data Cruncher documentation and the link to the feedback form through which you can contact our Support Team. For more details about the visual interface, see the [official JupyterLab documentation](https://jupyterlab.readthedocs.io/en/stable/user/interface.html). ## Commonly used text commands Besides execution of Python, R or Julia code, you can also run the following types of commands directly in your notebook: * **Magic commands** - a set of predefined functions that you can call with a command line style syntax. Magic commands can begin with a single `%` symbol, in which case they take the rest of the line as an argument. If you prefix a magic command with a double `%` symbol (`%%`), it will take the rest of the cell as its argument. Learn more about [magic commands](http://ipython.readthedocs.io/en/stable/interactive/magics.html) or type `%magic` in a blank cell and execute it. * **Linux shell commands** - You can also run any system shell command by prefixing it with an exclamation mark (`!`), for example `!ls`. You can even combine shell commands with the rest of the code in your notebook, for example: [block:code] { "codes": [ { "code": "myfiles = !ls", "language": "python" } ] } [/block] This line of code will assign the list of files returned by the `ls` command to the `myfiles` variable. Find out more about functionalities related to [text commands](http://ipython.readthedocs.io/en/stable/interactive/tutorial.html).