To access all primary components within the Syntasa application, such as Apps, Dashboards, Notebooks, and their respective folders, follow these steps:
- Click on the menu icon (
).
- Select "Workspace" from the menu.
- Within the Workspace, navigate to "Filters" or "Folders" to locate the specific notebook you're interested in.
The most common way to launch a notebook is by clicking on the notebook card. If you are Editing a Notebook there is also a Launch Notebook button. If you don't have an existing notebook or need to create a new one, then see the article on Creating a Notebook.
This article reviews the need-to-know basics when launching a notebook:
Starting the notebook
Launching a notebook will open a new browser tab and will take a few steps to load. You only need to wait a few seconds, no clicking necessary, to complete the startup actions within JupyterHub. These steps will look like the following:
If you are launching a notebook that has been shared with you, as opposed to being the owner, then you will also see the following loading screen. The Authorize button you do need to click.
Notebook basics
Once loaded, the notebook will look similar to the examples below. The information shown in the header and the first portion of the notebook will vary based on the attributes saved when the notebook was created and other configurations.
Language
The Language field in the header of the notebook screen reflects the programming language value set during the creation of the notebook. This value can be altered by editing the notebook; however, the notebook itself must be refreshed for this modification to be applied. Additionally, it's important to note that any code already written in the notebook will require refactoring if the language of the notebook is changed.
The kernel field shown on the notebook will depend on the language you select. If GPU is enabled, the GPU kernel for the selected language will be shown.
Syntasa Runtime
Determining if and when you need to attach a runtime to your notebook is reviewed in the article Notebook Runtimes. The Runtime Status field in the header of the notebook screen will appear if a runtime has been attached to the notebook.
Syntasa Runtime can be enabled while creating the notebook or editing the notebook or on the JupyterHub screen. Once the runtime is enabled or saved on any screen, it will automatically reflect on the other two screens along with the runtime status i.e. Running or stopped. To check the attached Runtime details or enable the Syntasa Runtime on the JupyterHub screen, click the gear icon () shown on the left side.
You can overwrite Template Defaults by enabling the toggle 'Overwrite Template Defaults' on any of the three screens.
Within the settings screen, you have the option to stop and start the runtime attached to the notebook. However, it's important to be aware that if a currently running runtime is selected during the selection process, stopping this runtime may disrupt other notebooks, if any, that are also connected to and utilizing the same runtime instance.
Reference Documents
The Reference Documents section seen at the top of the notebook is a configurable space, by a system administrator, to present any desired message, sample code, or links to documentation. If configured, all notebooks will be created with this section.