IllumiDesk

Step 3: Create a Workspace and Add Your Course Notebook Files

Create and launch a new workspace to access your interactive Notebook environment along with the integrated file manager.

Overview

In most cases, users already have a Notebook or a set of Notebook files they wish to use for their courses. Usually these files are located within a git compatible repo, such has GitHub, GitLab, or BitBucket.

Create a New Workspace

Once you have created a new project, you can then create a new workspace. A workspace is equivalent to a server instance, in this case, a Jupyter Notebook server instance.

For those of you that are familiar with launching Jupyter Notebooks from your terminal, this is equivalent to:

$ python3 -m pip install --upgrade pip
$ python3 -m pip install jupyter
$ jupyter notebook

Create a workspace by clicking on the Add a Workspace button within your project's main page:

As illustrated above, a new workspace just requires a workspace name.

Workspace Resources

Workspace resources, specifically the CPU, RAM and disk space available for your workspace instances are determined during account setup.

Once you have created your workspace, click on Start. This will spawn a new workspace instance which will then allow you to open the workspace with Launch. By default, the workspace opens in a new browser tab.

A workspace instance with Status = Running

A workspace instance with Status = Running

Add your Course Files

Congrats! You should now have a valid user account, a project, and a workspace.

With a running workspace in place, you can then add project files to your Jupyter Notebook instance either using Jupyter's native File Manager or via commands. You can run commands within the Jupyter terminal or within the notebook cells themselves using the exclamation point (sometimes referred to as the "bang" character), for example:

Jupyter Interface Documentation

If you are not familiar with the Jupyter Notebook interface, refer to the User interface components section of the Jupyter Notebooks documentation.


What's Next

Now that you have your files added to your project, you can add those files as Assignments or Modules within your Canvas LMS course.

Create an OAuth2 Application

Step 3: Create a Workspace and Add Your Course Notebook Files


Create and launch a new workspace to access your interactive Notebook environment along with the integrated file manager.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.