Jupyter notebooks

The Jupyter Notebook is an open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text. [1]

The Compute Canada documentation on these notebooks already contains a lot of information. Here we will explain how to use these notebooks on the UNF servers.

On this page, we will use the elm server. The instructions remain the same for other servers like jacaranda.

Installation

Jupyter is a python module, you only need to install it on the server. This step is already done for you. You have to connect to the server elm in ssh and then load the python environment of the lab.

user@local:~ $ ssh <your-username>@elm.criugm.qc.ca
____________________________________/\\\\\_
 __________________________________/\\\///__
  _________________________________/\\\______
   __/\\\____/\\\__/\\/\\\\\\____/\\\\\\\\\___
    _\/\\\___\/\\\_\/\\\////\\\__\////\\\//____
     _\/\\\___\/\\\_\/\\\__\//\\\____\/\\\______
      _\/\\\___\/\\\_\/\\\___\/\\\____\/\\\______ 
       _\//\\\\\\\\\__\/\\\___\/\\\____\/\\\______
        __\/////////___\///____\///_____\///_______

        Bienvenue chez vous! 
        Pour toute question, adressez-vous à support.unf@criugm.qc.ca
user@elm:~ $ source /data/brambati/quarantine/python_virtualenv/lingualab_3.6/bin/activate
lingualab_3.6|user@elm:~ $

Start a notebook

If you have already used notebooks on your own computer, you use the jupyter notebook command.

In the case of UNF servers, a script (notebook.sh) is provided for you.

lingualab_3.6|user@elm:~ $ notebook.sh 
[I 15:09:29.790 NotebookApp] Serving notebooks from local directory: /home/user
[I 15:09:29.790 NotebookApp] The Jupyter Notebook is running at:
[I 15:09:29.790 NotebookApp] http://elm.criugm.qc.ca:8888/?token=<token>
[I 15:09:29.790 NotebookApp]  or http://127.0.0.1:8888/?token=<token>
[I 15:09:29.791 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[C 15:09:29.871 NotebookApp] 

    To access the notebook, open this file in a browser:
        file:///home/user/.local/share/jupyter/runtime/nbserver-50048-open.html
    Or copy and paste one of these URLs:
        http://elm.criugm.qc.ca:8888/?token=<token>
     or http://127.0.0.1:8888/?token=<token>

Access the notebook

If you are within the research centre, simply follow the instructions and copy and paste the URL into your browser.

If you are outside the building. It is necessary to create a secure connection with elm. The Compute Canada documentation explains the process. Following the instructions, simply replace:

  • <cluster>.computecanada.ca with elm.criugm.qc.ca.
  • cdr544.int.cedar.computecanada.ca by elm.criugm.qc.ca
  • <token> by your own token.