Package: xcube-jl-ext
xcube_jl_extxcubeJupyterLab integrationThis extension is composed of a Python package namedxcube_jl_extfor the JupyterLab server extension and a NPM package namedxcube-jl-extfor the JupyterLab frontend extension.The extension adds the following features to JupyterLab:Allows running a configurable xcube Viewer as widget in the JupyterLab.Allows using xcube Server and Viewer from within Jupyter Notebooks,
even if JupyterLab is running remotely, i.e., spawned by JupyterHub.NOTEThis extension is still experimental and has neither been packaged
nor deployed. Refer to the sectionDevelopmentbelow for dev installs.RequirementsJupyterLab >= 3.0xcube >= 0.13InstallTo install the extension, execute:pipinstallxcube_jl_extUninstallTo remove the extension, execute:pipuninstallxcube_jl_extTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistDevelopmentSetup environmentBuildxcube Viewerresources
from sources. Note you'll needyarnto be installed on your system.cd${projects}gitclonehttps://github.com/dcs4cop/xcube-viewer.gitcdxcube-viewer
yarninstall
yarnbuildNow set environment variableXCUBE_VIEWER_PATHto point
to the xcube Viewer build directory:export XCUBE_VIEWER_PATH=${projects}/xcube-viewer/buildMake sure to have a source installation
ofxcubein a
dedicated xcube Python environment.cd${projects}gitclonehttps://github.com/dcs4cop/xcube.gitcdxcube
mambaenvcreateActivatexcubeenvironment and install xcube in editable (development) mode:condaactivatexcube
pipinstall-ve.Update environment with required packages for building and running
the JupyterLab extension.Note, the version of thejupyterlabin our development environment
should match the version of the target system. We also installjupyter-server-proxy.mambainstall-cconda-forge-cnodefaultsjupyterlab=3.4.0jupyter-server-proxyAlso install some packaging and build tools:mambainstall-cconda-forge-cnodefaultsnodejsjupyter-packaging
pipinstallbuildRefer also to theJupyterLab Extension Tutorialfor the use these tools.Install extension from sourcesMake sure,xcubeenvironment is active:condaactivatexcubeClone xcube JupyterLab extension repository next to thexcubesource
folder:cd${projects}gitclonehttps://github.com/dcs4cop/xcube-jl-ext.gitcdxcube-jl-extInstall the initial project dependencies and install the extension into
the JupyterLab environment. Copy the frontend part of the extension into
JupyterLab. We can run this pip install command again every time we make
a change to copy the change into JupyterLab.pipinstall-ve.Create a symbolic link from JupyterLab to our source directory.
This means our changes are automatically available in JupyterLab:jupyterlabextensiondevelop--overwrite.If successful, we can run JupyterLab and check if the extension
works as expected:jupyterlabBuild after changesRun the following to rebuild the extension. This will be required
after any changes ofpackage.jsonor changes of frontend TypeScript
files and other resources.jlpmrunbuildIf you wish to avoid building after each change, you can run thejlpmrunwatchfrom your extension directory in another terminal.
This will automatically compile the TypeScript files as they
are changed and saved.ContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the xcube_jl_ext directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablexcube_jl_ext# Rebuild extension Typescript source after making changesjlpmbuildYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablexcube_jl_ext
pipuninstallxcube_jl_extIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedxcube-jl-extwithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covxcube_jl_extFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE