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.17.0.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.17.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: icn3dpy-3.17.0.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.17.0.tar.gz
Algorithm Hash digest
SHA256 ae0156e0ec836117c497a1ceebc58493f3ddda2ba22f610b3b71dcc51647d818
MD5 ecf9e934283d712c609d2a99e95e1638
BLAKE2b-256 5599b51f6d1e04f27430c04d37e77b1414560e7fe18a75ca314f0c99abb57cb3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: icn3dpy-3.17.0-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.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f21325b3565a7a71ca2a5b387168ab4ab2372e91ec99591db9c58a4d295f4d19
MD5 2960b6357e06e304a4f5ea32b28969f6
BLAKE2b-256 25ecc9fe476d21b2a24a3db3cf420bee4d91b0c2a915d7ae624387111a378385

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