Skip to main content

CrossCompute Extensions for JupyterLab

Project description

CrossCompute Extensions for JupyterLab

Github Actions Status

This extension is composed of a Python package named crosscompute_jupyterlab_extensions for the server extension and a NPM package named crosscompute-jupyterlab-extensions for the frontend extension.

Requirements

  • JupyterLab >= 3.0
  • crosscompute >= 0.8.4.6

Installation

pip install crosscompute-jupyterlab-extensions

Troubleshooting

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Development

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the crosscompute_jupyterlab_extensions directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You 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 needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With 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, the jlpm run build command 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:

jupyter lab build --minimize=False

Uninstallation

pip uninstall crosscompute_jupyterlab_extensions

Acknowledgments

Thank you to Rodrigo Guarachi for creating a custom JupyterLab extension and integration with the CrossCompute framework and platform.

Thank you to Miguel Angel Gordián for testing our JupyterLab extension in different computational environments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for crosscompute-jupyterlab-extensions, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size crosscompute_jupyterlab_extensions-0.1.0-py3-none-any.whl (31.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size crosscompute_jupyterlab_extensions-0.1.0.tar.gz (95.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page