JupyterLab extension for integrating Rucio
Project description
Rucio JupyterLab Extension
This is a JupyterLab extension that integrates with Rucio - Scientific Data Management to allow users to access some of Rucio's capabilities directly from the JupyterLab interface.
This extension is composed of a Python package named rucio_jupyterlab
for the server extension and a NPM package named rucio-jupyterlab
for the frontend extension.
Requirements
- JupyterLab >= 2.0
Install
Note: You will need NodeJS to install the extension.
$ pip install rucio-jupyterlab
$ jupyter lab build
If you are going to run the extension in Download mode, you will also need to install libraries required by the RSE downloaders. For instance, gfal2
, which is available in EPEL or conda-forge. Additionally, you have to install globus-proxy-utils
.
$ apt install globus-proxy-utils
$ conda install -c conda-forge python-gfal2
# OR
$ yum install epel-release
$ yum install gfal2-all gfal2-python globus-proxy-utils
Restart your JupyterLab instance afterwards to load the server extension.
Configuration
See CONFIGURATION.md
Contributing
If you want to contribute or build the extension from source, see CONTRIBUTING.md
Quick Setup using Docker
This repository comes with a Docker image of jupyter/scipy-notebook installed with the extension.
To run the image, use the following command.
Replica Mode
$ docker run -d -p 8888:8888 \
-e RUCIO_MODE=replica \
-e RUCIO_WILDCARD_ENABLED=<true = 1, false = 0> \
-e RUCIO_BASE_URL=<Rucio base URL> \
-e RUCIO_AUTH_URL=<Rucio auth URL (if any)> \
-e RUCIO_DESTINATION_RSE=<destination RSE> \
-e RUCIO_DISPLAY_NAME=<instance display name> \
-e RUCIO_NAME=<instance name> \
-e RUCIO_PATH_BEGINS_AT=<path begins at> \
-e RUCIO_RSE_MOUNT_PATH=<mount path> \
-v <host folder>:<container folder> \
didithilmy/rucio-jupyterlab:latest
<host folder>
is a folder in the host that is mounted to a Rucio Storage Element via FUSE.
<container folder>
is a folder accessible from the notebook that is mounted to the host folder.
Download Mode
$ docker run -d -p 8888:8888 \
-e RUCIO_MODE=download \
-e RUCIO_WILDCARD_ENABLED=<true = 1, false = 0> \
-e RUCIO_BASE_URL=<Rucio base URL> \
-e RUCIO_AUTH_URL=<Rucio auth URL (if any)> \
-e RUCIO_DISPLAY_NAME=<instance display name> \
-e RUCIO_NAME=<instance name> \
-e RUCIO_SITE_NAME=ROAMING \
-e RUCIO_CA_CERT=/certs/rucio_ca.pem \
-v <path to Rucio CA PEM file>:/certs/rucio_ca.pem \
didithilmy/rucio-jupyterlab:latest
Follow the configuration guide for details of the parameters.
Troubleshoot
If you are seeing the frontend extension but it is not working, check that the server extension is enabled:
jupyter serverextension list
If the server extension is installed and enabled but you are not seeing the frontend, check the frontend is installed:
jupyter labextension list
If it is installed, try:
jupyter lab clean
jupyter lab build
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 rucio_jupyterlab-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d7560f62ae6169ce98a1b9bbe4139248a29e6e77f07e51dbba1553d1296b36d |
|
MD5 | c24d40266fbdb54c9d053b9ae1b4648d |
|
BLAKE2b-256 | dd0d28489c17625cf752fd3675d2667df314514a9726776207b1ef1fad292733 |