A JupyterLab extension for rendering cube files.
Project description
jupyterlab-cube
Try it with Binder
A JupyterLab extension for rendering Gaussian cube files. Gaussian cube file describes volumetric data for molecular and material systems. It can be used to store data for electron densities and molecular orbitals.
This extension is a JupyterLab Gaussian cube file renderer. By double clicking the cube files in the JupyterLab file browser, it will show the cube file in a NGL visualizer.
Requirements
- JupyterLab >= 3.0
Install
pip install jupyterlab-cube
Contributing
Development install
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 jupyterlab_cube 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
Uninstall
pip uninstall jupyterlab_cube
jupyter labextension uninstall jupyterlab-cube
Acknowledgements
We acknowledge support from the EPFL Open Science Fund via the OSSCAR project.
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
File details
Details for the file jupyterlab_cube-0.1.9.tar.gz
.
File metadata
- Download URL: jupyterlab_cube-0.1.9.tar.gz
- Upload date:
- Size: 1.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87a52e38a85ae8d1d47393a0db009c7129019960b5c93378d88b7ca73f57bc74 |
|
MD5 | 12326caf3e07774ba328d34dc0fad0ff |
|
BLAKE2b-256 | 19b6db2a25985b113700513a28247f470de874358be173165b7e151e81921df7 |
File details
Details for the file jupyterlab_cube-0.1.9-py3-none-any.whl
.
File metadata
- Download URL: jupyterlab_cube-0.1.9-py3-none-any.whl
- Upload date:
- Size: 3.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 168bbde6c228ed97ec49e62fe1beed7a695947cf38f0b7e4dc185033df6d4d51 |
|
MD5 | 40ea31c9b518959118e6eabf254c7df0 |
|
BLAKE2b-256 | e5cd1a1195193520a03a1a1a8374ffd5c3207d24d9aee1f6e6ac6120dcb553e6 |