Skip to content

Jupyter Lab: Data

Structured Representation

We present in what follows the structured representation for the Jupyter Lab Application.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{
    "allOf": [
        {
            "schemaId": "software-application", 
            "required": [
                "name"
            ], 
            "type": "object", 
            "properties": {
                "build": {
                    "type": "string", 
                    "description": "Application build. e.g. VTST"
                }, 
                "shortName": {
                    "type": "string", 
                    "description": "The short name of the application. e.g. qe"
                }, 
                "version": {
                    "type": "string", 
                    "description": "Application version. e.g. 5.3.5"
                }, 
                "name": {
                    "type": "string", 
                    "description": "The name of the application. e.g. espresso"
                }, 
                "summary": {
                    "type": "string", 
                    "description": "Application's short description."
                }
            }, 
            "title": "application schema (base)"
        }
    ], 
    "schemaId": "software-directory-scripting-jupyter-lab", 
    "title": "Jupyter Lab Application Schema", 
    "$schema": "http://json-schema.org/draft-04/schema#", 
    "type": "object", 
    "properties": {
        "flavor": {
            "enum": [
                "notebook"
            ]
        }, 
        "version": {
            "enum": [
                "0.33.12"
            ]
        }, 
        "name": {
            "enum": [
                "jupyterLab"
            ]
        }, 
        "exec": {
            "enum": [
                "jupyter"
            ]
        }, 
        "summary": {
            "enum": [
                "Jupyter Lab"
            ]
        }
    }
}

1
2
3
4
5
6
7
8
{
    "name": "jupyterLab", 
    "exec": "jupyter", 
    "summary": "Jupyter Lab", 
    "version": "0.33.12", 
    "shortName": "jl", 
    "flavor": "notebook"
}

Files/Storage Convention

  1. Initially, the root of the Dropbox folder is passed to the application on the start, so the files at the root of the Dropbox directory can be accessed
  2. Upon each "Save and Checkpoint" action invoked inside the notebook, the ipynb file is overwritten. A new version is stored in the file system, and a checkpoint is saved to the job inside its directory both in the command-line and on the web interface.

  3. All notebooks have access to the filesystem accessible to the user on the corresponding computational node, namely the home and share directories. For example, the following command will list the shared directory for the account "exabyte-io", when invoked inside the Jupyter Notebook running on "cluster-007":

    1
    ls -lhta /cluster-007-share/groups/exabyte-io