CrossCompute Extensions for JupyterLab
Project description
CrossCompute Extensions for JupyterLab
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
Usage
You will need to configure CROSSCOMPUTE_TOKEN in your environment to use the printer service. You can find your token on https://crosscompute.com.
export CROSSCOMPUTE_TOKEN
jupyter lab
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.
Thank you to Ji Yoon Lee and Tyler Doyle for user experience feedback.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for crosscompute_jupyterlab_extensions-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb0ed11ed2ab4614986dbf9716f2cddc043b982c523513aec6fb7449f38ac292 |
|
MD5 | c5b7d65412948b5d575e9c2e2307459c |
|
BLAKE2b-256 | 582c5d7ab86492beb3654390b843a532566b579b4ec57917927551849045e095 |
Hashes for crosscompute_jupyterlab_extensions-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7919e6c799c888fc9e7a1b7bdc3362315ff473eac4846a27956c005417aa27d |
|
MD5 | 47f762f5eec53f01388722443a37bcaa |
|
BLAKE2b-256 | 9cb0ead2a85c575c369fc497cb0a36ba3880b0b71702176e21c474214353a736 |