Skip to main content

An IPython interface for embedding iCn3D viewer

Project description

icn3dpy

icn3dpy is a simple IPython/Jupyter widget to embed an interactive iCn3D viewer in a notebook. Its source code is at PyPI, and is also included at iCn3D GitHub.

The 3D view of icn3dpy in Jupyter Notebook is interactive, just like in any browser. The popup windows will appear under the 3D view. If you have a predefined cutom view, you can use the predefined commands in icn3dpy as shown below.

If you experience problems, please file an issue.

Installation

Install icn3dpy:

pip install icn3dpy

Install node if node is unavailable. One way in Mac is to use "brew":

brew update

brew install node

Install Jupyter Lab and the extension "jupyterlab_3dmol":

pip install jupyterlab

jupyter labextension install jupyterlab_3dmol
or jupyterhub labextension install jupyterlab_3dmol

Usage

Open a notebook:

jupyter notebook

and issue Python script as follows:

import icn3dpy

"mmdbid" as input:

view = icn3dpy.view(q='mmdbid=6hjr')

view

You can also try other input besides "mmdbid". "pdbid" as input:

view = icn3dpy.view(q='pdbid=2bbv')

view

"mmtfid" as input:

view = icn3dpy.view(q='mmtfid=6vxx')

view

"cid" as input:

view = icn3dpy.view(q='cid=2244')

view

Use predefined commands (see commands in iCn3D Gallery for reference):

view = icn3dpy.view(q='mmdbid=6m0j',command='scatterplot interaction pairs | !A !E | hbonds,salt bridge,interactions,halogen,pi-cation,pi-stacking | false | threshold 3.8 6 4 3.8 6 6; show selection; add residue number labels')

view

Command

You can use iCn3D interactive interface to generate a custom view, then click "File > Share Link" to get the commands in the "Original URL". All iCn3D commands are listed here.

License

United States Government Work

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

icn3dpy-3.16.3.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

icn3dpy-3.16.3-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file icn3dpy-3.16.3.tar.gz.

File metadata

  • Download URL: icn3dpy-3.16.3.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.3

File hashes

Hashes for icn3dpy-3.16.3.tar.gz
Algorithm Hash digest
SHA256 6c5584abe25ed0eb52ad6f9dcca579019cfd5cc8c43d659a7abfc0bd18b280aa
MD5 485e01610a2b9c5dd65a1673f882d723
BLAKE2b-256 b8e4d518dd380c9733ac4bfb4f28b5359e70b124eaae3378052181a56244827c

See more details on using hashes here.

File details

Details for the file icn3dpy-3.16.3-py3-none-any.whl.

File metadata

  • Download URL: icn3dpy-3.16.3-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.3

File hashes

Hashes for icn3dpy-3.16.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8599caac63c7320ab693380f2ebe491af32b14d23d57e85d6863e3961932da98
MD5 3c2794c601c29c2594f3f150df58b15c
BLAKE2b-256 c80c68fd775f0090679d92a70a2874aae6e606f26aaee6184ce8c5ca0a5c1494

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