Skip to main content

An IPython interface for embedding 3Dmol.js views

Project description

A simple [IPython/Jupyter](http://jupyter.org/) widget to embed an interactive [3Dmol.js](http://3dmol.csb.pitt.edu) viewer in a notebook.

The widget is completely static, which means the viewer doesn’t need a running IPython kernel to be useful and web pages and presentations generated from the notebook will work as expected. However, this also means there is only one-way communication between the notebook and the viewer.

If you experience problems, please file an [issue](https://github.com/3dmol/3Dmol.js/issues).

[An example notebook](http://nbviewer.jupyter.org/github/3dmol/3Dmol.js/blob/master/py3Dmol/examples.ipynb)

Installation

From PyPI:

pip install py3Dmol

Important: In order to use with JupyterLab you must install the JupyterLab extension:

jupyter labextension install jupyterlab_3dmol

Usage

Open a notebook

jupyter notebook

and issue

`Python import py3Dmol view = py3Dmol.view(query='pdb:1ubq') view.setStyle({'cartoon':{'color':'spectrum'}}) view `

API

The returned view object has the exact same API as [$3Dmol.GLViewer](http://3dmol.csb.pitt.edu/doc/$3Dmol.GLViewer.html) with the exception that functions return None.

License

MIT

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

py3Dmol-1.8.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

py3Dmol-1.8.0-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file py3Dmol-1.8.0.tar.gz.

File metadata

  • Download URL: py3Dmol-1.8.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.10

File hashes

Hashes for py3Dmol-1.8.0.tar.gz
Algorithm Hash digest
SHA256 bc495e0f5204ea1e6fcb527a0332ee8765c3d4491e4ace9a9a72b790e89e9647
MD5 365362d4037e6c1b334a05c2597d29b7
BLAKE2b-256 614306213e4fc1f9ff0b1aa8264b92ef97dca3831fcb0e017dca0ca49350f8b5

See more details on using hashes here.

Provenance

File details

Details for the file py3Dmol-1.8.0-py2.py3-none-any.whl.

File metadata

  • Download URL: py3Dmol-1.8.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.10

File hashes

Hashes for py3Dmol-1.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7fa6183056f6890af145e30e99a7b415f43dc3967bd8dd481f4108878722389e
MD5 b1c3ef18238dd73866d02784fe063835
BLAKE2b-256 f5256b7324df6c09e096e458e1393fa714eddc726fa2792f3019430f8a2f139e

See more details on using hashes here.

Provenance

Supported by

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