Skip to main content

Create an environment

Before creating a Notebook.link project, you would need to create an environment or pick a default one.

You can visit the Environment page.

Default environments​

Notebook.link already provides some default environments for you.

  • Python Scientific Stack: contains a Python kernel, NumPy, Pandas, Matplotlib etc.
  • Jupyter CAD Stack
  • Jupyter GIS Stack
  • Jupyter Widgets Stack
  • R Stack: contains a R kernel and everything you need for plotting
note

If one of those environments fits your need, you can already select it to create your own project

Custom environment​

In case the default environments are not enough for your needs, you can create your own from the environment creation page

Create-an-environment

Environment creation form​

On the environment creation page, you will need to provide:

  • The environment name
  • (Optional) a description for the environment
  • The content of the environment.yml file. This file is a conda environment definition, used to define the WASM environment that will be used in your project or link.

An example of such environment.yml file is as follows:

name: my-environment
channels:
  - emscripten-forge
  - conda-forge
dependencies:
  - xeus-python # A Jupyter kernel for Python
  - pandas
  - matplotlib
  - xeus-r # A Jupyter kernel for R
  - xeus-cpp # A Jupyter kernel for C++
  - pip: # List pure Python packages from PyPi here
    - ipyleaflet

As general recommendations, please:

  1. Make sure to include the emscripten-forge channel
  2. Install xeus-python instead of ipykernel if you need a Python kernel
  3. Do not install jupyterlab, it's already provided
tip

If you want to get started with simple examples:

  • Install the xeus-python kernel
  • Install some well known Python packages like matplotlib, bqplot, scipy, etc.

You can also specificy pure Python packages to install with pip, like folium or requests.

warning
  1. Some packages are yet to be made available on emscripten-forge. Notebook.link accepts package requests on emscripten-forge by opening issues on the repository.
  2. Only pure-Python packages provided as Python wheels can be installed from PyPi.
note

Once created and saved, your environment can be modified further. You would need to provide a new version number.

Environment definition versus lock window​

The following video shows how to switch between the 2 views : environment definition and environment lock.

Add a package to the environment​

The following video shows how the environment is resolved in real-time when adding a package to the environment.

Search in environment resolution logs​

The following video shows an example of searching a keyword like a package name in the logs.