Skip to main content

Terminology

Notebook.link refers to the name of the application which handles environment/project creation as well as Git repositories handling and serving the JupyterLite front-end. Across all the Notebook.link application and documentation, we will use the following terminology:

Environment

An environment is an isolated workspace where you can install specific versions of your packages. It includes the dependencies needed for your projects such as kernels or scientific computing librairies. e.g. xeus-python, numpy, matplotlib.

This is a conda environment that lives entirely in your browser.

Read more on how to create an environment.

Project

A project refers to the combination of:

  • an environment
  • a persistent storage space (Notebooks, Python files, data files etc).
  • a list of add-ons

Read more on how to create a project.

Add-ons

Add-ons are JupyterLite extensions tailored for Notebook.link. They are generally accompanied by a backend service. Addons bring additional functionalities like AI assistance.

Read more on add-ons.

Git repository handling

Notebook.link handles serving Git repositories as if those were projects hosted on their Git provider (e.g. GitHub). The environment definition is then picked from the repository (in the form of an environment.yml file).

Read more on enabling your Git repository for using it with Notebook.link.

A Notebook link is a link to a Notebook.link project or a Git repository. e.g. http://notebook.link/@quantstack/Jupyter-Widgets or http://notebook.link/github/jupyter-widgets-contrib/ipycanvas/lab

Read more on how to create Notebook links