Add data behavior (#95)

* Add data feature

* Only retain video on failure

Co-authored-by: Duc Trung Le <leductrungxf@gmail.com>

* Fix comment

Co-authored-by: Duc Trung Le <leductrungxf@gmail.com>

---------

Co-authored-by: Duc Trung Le <leductrungxf@gmail.com>

Author: martinRenou

examples/session.glu

@@ -318,7 +318,7 @@
         "y_axislabel_weight": "st__normal",
         "y_log": false,
         "y_max": 1168792.8,
-        "y_min": 0.0,
+        "y_min": 0,
         "y_ticklabel_size": 8
       }
     }
@@ -339,7 +339,7 @@
       "bias": 0.5,
       "cmap": "LinearSegmentedColormap_0",
       "color": "st__#595959",
-      "contrast": 1.0,
+      "contrast": 1,
       "global_sync": false,
       "layer": "w5",
       "percentile": 100,
@@ -515,7 +515,7 @@
       "cmap_vmax": 3151.745849609375,
       "cmap_vmin": 438.1081848144531,
       "color": "st__#595959",
-      "density_contrast": 1.0,
+      "density_contrast": 1,
       "density_map": true,
       "fill": true,
       "layer": "w5",
@@ -556,7 +556,7 @@
       "cmap_vmax": 3744.811767578125,
       "cmap_vmin": 438.5635070800781,
       "color": "st__#e31a1c",
-      "density_contrast": 1.0,
+      "density_contrast": 1,
       "density_map": true,
       "fill": true,
       "layer": "Subset 1_0",
@@ -597,7 +597,7 @@
       "cmap_vmax": 17766,
       "cmap_vmin": 2,
       "color": "st__#595959",
-      "density_contrast": 1.0,
+      "density_contrast": 1,
       "density_map": false,
       "fill": true,
       "layer": "w5_psc",
@@ -638,7 +638,7 @@
       "cmap_vmax": 17771,
       "cmap_vmin": 4,
       "color": "st__#e31a1c",
-      "density_contrast": 1.0,
+      "density_contrast": 1,
       "density_map": false,
       "fill": true,
       "layer": "Subset 1_1",
@@ -679,7 +679,7 @@
       "cmap_vmax": 3151.745849609375,
       "cmap_vmin": 438.1081848144531,
       "color": "st__#595959",
-      "density_contrast": 1.0,
+      "density_contrast": 1,
       "density_map": true,
       "fill": true,
       "layer": "w5",
@@ -720,7 +720,7 @@
       "cmap_vmax": 3744.811767578125,
       "cmap_vmin": 438.5635070800781,
       "color": "st__#e31a1c",
-      "density_contrast": 1.0,
+      "density_contrast": 1,
       "density_map": true,
       "fill": true,
       "layer": "Subset 1_0",
@@ -1120,7 +1120,7 @@
         "st__CRVAL2": 60.38,
         "st__CTYPE1": "st__RA---TAN",
         "st__CTYPE2": "st__DEC--TAN",
-        "st__EQUINOX": 2000.0,
+        "st__EQUINOX": 2000,
         "st__HISTORY": [
           "",
           " Settings used in processing:",

gluepyter/glue_session.py

@@ -1,14 +1,21 @@
+import os
+import json
 import warnings
 from pathlib import Path
 from typing import TYPE_CHECKING, Dict, Optional, Tuple
 
+from glue.core.link_helpers import LinkSame
+from glue.core.state import GlueSerializer
 import glue_jupyter as gj
 from glue_jupyter.view import IPyWidgetView
 from glue_jupyter.widgets.layer_options import LayerOptionsWidget
+
 import y_py as Y
-from glue.core.link_helpers import LinkSame
+
 from IPython.display import display
+
 from ipywidgets import Output
+
 from jupyter_ydoc import ydocs
 from ypywidgets import Widget
 
@@ -140,6 +147,13 @@ def render_viewer(self) -> None:
                         )
 
                     saved_viewer["widget"] = widget
+
+                    # This may be the error widget
+                    if widget is None or not hasattr(widget, "viewer_options"):
+                        with output:
+                            display(widget)
+                        return
+
                     viewer_options = widget.viewer_options
                     try:
                         layer_options = LayerOptionsWidget(widget)
@@ -156,6 +170,10 @@ def render_viewer(self) -> None:
                         viewer_state=state,
                     )
 
+                    # This may be the error widget
+                    if widget is None or not hasattr(widget, "viewer_options"):
+                        return
+
                     viewer_options = widget.viewer_options
                     try:
                         layer_options = LayerOptionsWidget(widget)
@@ -309,6 +327,37 @@ def _init_ydoc(self) -> None:
             ydoc=self._sessionYDoc,
         )
 
+    def add_data(self, file_path: str) -> None:
+        """Add a new data file to the session"""
+        relative_path = Path(file_path).relative_to(Path(self._path).parent)
+        assert os.path.exists(relative_path)
+
+        data = self.app.load_data(str(relative_path))
+        self._data[data.label] = data
+
+        # We generate the data representation and merge it into our ycontent
+        serializer = GlueSerializer(data)
+        serialized_data = serializer.dumpo()
+
+        contents = self._document.contents
+
+        # Inject the main data repr
+        contents[data.label] = serialized_data["__main__"]
+        # Inject all components
+        for key, value in serialized_data.items():
+            if key != "__main__":
+                contents[key] = value
+        # Inject the label in the data collection
+        contents["DataCollection"]["data"].append(data.label)
+        contents["DataCollection"]["cids"].extend(
+            cid for cid, comp in serialized_data["__main__"]["components"]
+        )
+        contents["DataCollection"]["components"].extend(
+            comp for cid, comp in serialized_data["__main__"]["components"]
+        )
+
+        self._document.set(json.dumps(contents))
+
     def _load_data(self) -> None:
         """Load data defined in the glue session"""
         data_paths = {}

src/leftPanel/data/dataPanel.ts

@@ -1,5 +1,10 @@
 import { CommandRegistry } from '@lumino/commands';
+
 import { SidePanel, ToolbarButton } from '@jupyterlab/ui-components';
+
+import { FileDialog } from '@jupyterlab/filebrowser';
+import { IDocumentManager } from '@jupyterlab/docmanager';
+
 import { DatasetsWidget } from './datasetsWidget';
 import { SubsetsWidget } from './subsetsWidget';
 import { IControlPanelModel } from '../../types';
@@ -8,6 +13,7 @@ export class DataPanel extends SidePanel {
   constructor(options: {
     model: IControlPanelModel;
     commands: CommandRegistry;
+    manager: IDocumentManager;
   }) {
     super();
 
@@ -17,7 +23,39 @@ export class DataPanel extends SidePanel {
       new ToolbarButton({
         tooltip: 'Add Data',
         label: 'Add Data',
-        onClick: () => console.log('clicked')
+        onClick: async () => {
+          if (!options.model.currentSessionPath) {
+            // TODO Show an error dialog, or disable the button?
+            return;
+          }
+
+          const output = await FileDialog.getOpenFiles({
+            title: 'Load Data Files Into Glue Session',
+            manager: options.manager
+          });
+
+          if (!output.value) {
+            return;
+          }
+
+          const kernel = this._model.currentSessionKernel();
+          if (kernel === undefined) {
+            // TODO Show an error dialog
+            return;
+          }
+
+          for (const file of output.value) {
+            const filePath = file.path.includes(':')
+              ? file.path.split(':')[1]
+              : file.path;
+            const code = `
+            GLUE_SESSION.add_data("${filePath}")
+            `;
+
+            const future = kernel.requestExecute({ code }, false);
+            await future.done;
+          }
+        }
       })
     );
     this._model = options.model;

src/leftPanel/model.ts

@@ -10,6 +10,7 @@ import {
 import { IGlueSessionTracker } from '../token';
 import { IGlueSessionTabs } from '../_interface/glue.schema';
 import { ISessionContext } from '@jupyterlab/apputils';
+import { IKernelConnection } from '@jupyterlab/services/lib/kernel/kernel';
 
 export class ControlPanelModel implements IControlPanelModel {
   constructor(options: ControlPanelModel.IOptions) {
@@ -22,6 +23,7 @@ export class ControlPanelModel implements IControlPanelModel {
         );
       }
       this._sessionModel = changed?.context.model;
+      this._currentSessionPath = changed?.context.path;
       this._tabs = this._sessionModel?.sharedModel.tabs ?? {};
       this._sessionModel?.sharedModel.tabsChanged.connect(
         this._onTabsChanged,
@@ -53,6 +55,10 @@ export class ControlPanelModel implements IControlPanelModel {
     return this._clearConfigRequested;
   }
 
+  get currentSessionPath(): string | undefined {
+    return this._currentSessionPath;
+  }
+
   get selectedDataset(): string | null {
     return this._selectedDataset;
   }
@@ -80,6 +86,10 @@ export class ControlPanelModel implements IControlPanelModel {
     return this._tracker.currentWidget?.context.sessionContext;
   }
 
+  currentSessionKernel(): IKernelConnection | undefined {
+    return this._tracker.currentWidget?.sessionWidget.kernel;
+  }
+
   displayConfig(args: IRequestConfigDisplay): void {
     this._displayConfigRequested.emit(args);
   }
@@ -97,6 +107,7 @@ export class ControlPanelModel implements IControlPanelModel {
     IGlueSessionWidget | null
   >(this);
   private _tabs: IGlueSessionTabs = {};
+  private _currentSessionPath: string | undefined = undefined;
   private _tabsChanged = new Signal<IControlPanelModel, void>(this);
   private _selectedDataset: string | null = null;
   private _selectedDatasetChanged = new Signal<IControlPanelModel, void>(this);

src/leftPanel/plugin.ts

@@ -12,6 +12,8 @@ import { UUID } from '@lumino/coreutils';
 import { CommandRegistry } from '@lumino/commands';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { GridStackItem } from '../viewPanel/gridStackItem';
+import { DocumentRegistry } from '@jupyterlab/docregistry';
+import { DocumentManager } from '@jupyterlab/docmanager';
 
 const NAME_SPACE = 'gluepyter';
 
@@ -183,11 +185,19 @@ export const controlPanel: JupyterFrontEndPlugin<void> = {
 
     const controlModel = new ControlPanelModel({ tracker });
 
+    const docRegistry = new DocumentRegistry();
+    const docManager = new DocumentManager({
+      registry: docRegistry,
+      manager: app.serviceManager,
+      opener
+    });
+
     const controlPanel = new ControlPanelWidget({
       model: controlModel,
       tracker,
       commands,
-      rendermime
+      rendermime,
+      manager: docManager
     });
 
     controlPanel.id = 'gluepyter::controlPanel';

src/leftPanel/widget.ts

@@ -2,6 +2,7 @@ import { SidePanel } from '@jupyterlab/ui-components';
 import { CommandRegistry } from '@lumino/commands';
 import { Message } from '@lumino/messaging';
 import { BoxPanel } from '@lumino/widgets';
+import { IDocumentManager } from '@jupyterlab/docmanager';
 
 import { HTabPanel } from '../common/tabPanel';
 import { IGlueSessionTracker } from '../token';
@@ -17,7 +18,7 @@ export class ControlPanelWidget extends SidePanel {
     const content = new BoxPanel();
     super({ content });
     this.addClass('glue-sidepanel-widget');
-    const { model, rendermime, commands } = options;
+    const { model, rendermime, commands, manager } = options;
     this._model = model;
     const header = new ControlPanelHeader();
     this.header.addWidget(header);
@@ -28,7 +29,8 @@ export class ControlPanelWidget extends SidePanel {
     });
     const data = new DataPanel({
       model: this._model,
-      commands
+      commands,
+      manager
     });
     const canvas = new ConfigPanel({ model, rendermime });
 
@@ -69,5 +71,6 @@ export namespace LeftPanelWidget {
     tracker: IGlueSessionTracker;
     commands: CommandRegistry;
     rendermime: IRenderMimeRegistry;
+    manager: IDocumentManager;
   }
 }

src/types.ts

@@ -13,6 +13,7 @@ import {
 import { ISessionContext } from '@jupyterlab/apputils';
 import { SessionWidget } from './viewPanel/sessionWidget';
 import { GridStackItem } from './viewPanel/gridStackItem';
+import { IKernelConnection } from '@jupyterlab/services/lib/kernel/kernel';
 
 export const DATASET_MIME = 'application/x-gluejupyter-dataset';
 
@@ -99,6 +100,7 @@ export interface IRequestConfigDisplay {
 export interface IControlPanelModel {
   sharedModel: IGlueSessionSharedModel | undefined;
   glueSessionChanged: ISignal<IControlPanelModel, IGlueSessionWidget | null>;
+  currentSessionPath: string | undefined;
   selectedDataset: string | null;
   selectedDatasetChanged: ISignal<IControlPanelModel, void>;
   tabsChanged: ISignal<IControlPanelModel, void>;
@@ -109,6 +111,7 @@ export interface IControlPanelModel {
   displayConfig(args: IRequestConfigDisplay): void;
   clearConfig(): void;
   currentSessionContext(): ISessionContext | undefined;
+  currentSessionKernel(): IKernelConnection | undefined;
 }
 
 export type IGlueSessionViewerTypes = ValueOf<IGlueSessionTabs>[0];