Skip to main content

A Custom Jupyter Widget Library

Project description

XSMILES visualizations in Jupyter Lab

A Custom Jupyter Lab Widget to visualize SMILES-based and atom-based scores.

Please Cite

If you use XSMILES, the use cases, its code, or the generated explanations, please cite our article:

Article in preparation, a preprint should appear mid September!

Heberle, H., Zhao, L., Schmidt, S., Wolf, T., & Heinrich, J. (2022). XSMILES: interactive visualization for molecules, SMILES and XAI scores. Article in preparation.
@article{Heberle2022XSMILES,
author = {Heberle, Henry and Zhao, Linlin and Schmidt, Sebastian and Wolf, Thomas and Heinrich, Julian},
doi = {},
journal = {Article in preparation},
month = {},
number = {},
pages = {},
title = {{XSMILES: interactive visualization for molecules, SMILES and XAI scores}},
volume = {},
year = {2022}
}

JupyterLab Notebook

Availability and examples

Example Notebook with a how-to

To use XSMILES with Jupyter Lab you need to install the package with pip and have internet connection while using it.

RDKit MinimalLib is downloaded by your browser.

Please check this notebook to see how to use the tool: Notebook

Note that it is only being tested with Jupyter Lab. A reason for you to use Lab is the space available for visualizations, which is much better than in regular Jupyter notebooks. We also had problems with the installation with Jupyter notebooks.

Installation

Quick example - create conda environment and installs xsmiles

conda create --name xsmiles_env python=3.7 -c conda-forge # create conda env with python 3.7

conda activate xsmiles_env # activate the created env

conda install -c conda-forge jupyterlab # install jupyter lab

pip install xsmiles # if xsmiles is not in pip yet, try pip install xsmiles-0.2.2-py2.py3-none-any.whl
# Download the most up to date whl from this repository's releases)

jupyter lab examples/xsmiles_examples.ipynb # run a notebook with jupyter lab

Uninstall

  • pip uninstall xsmiles
  • rm -r <path-to:>/share/jupyter/labextensions/xsmiles
  • jupyter labextension list

Development

Please check the DEVELOPMENT.md file.

Project details


Download files

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

Source Distribution

xsmiles-0.2.2.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xsmiles-0.2.2-py2.py3-none-any.whl (1.7 MB view details)

Uploaded Python 2Python 3

File details

Details for the file xsmiles-0.2.2.tar.gz.

File metadata

  • Download URL: xsmiles-0.2.2.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for xsmiles-0.2.2.tar.gz
Algorithm Hash digest
SHA256 4ae58126b46194c3255f99004a8ffa65f7c8b03e7597d1e01fc1599672ded981
MD5 095846df1dae95577839417d269e47a4
BLAKE2b-256 897926b016faeca7bf98059c76132acb3b79341993ebb48f85496f703af51ed6

See more details on using hashes here.

File details

Details for the file xsmiles-0.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: xsmiles-0.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for xsmiles-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e9cbd1698fe8839b84f4ab7a6f9bbcecc48e76c8d579d590158d9408b1260d68
MD5 c9260e73d5d0fc4e31019ded486467ee
BLAKE2b-256 d85e2a03d3552341e52f332cc3962790bc1cdd071319fd967590d4cbd9e6f569

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page