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 the extension:

jupyter labextension install jupyterlab_3dmol

Usage

Open a notebook:

jupyter notebook

and issue Python script as follows:

import icn3dpy
  1. "pdbid" as input:

    view = icn3dpy.view(q='pdbid=1tup',command='color spectrum')

    view

  2. "mmtfid" as input:

    view = icn3dpy.view(q='mmtfid=1ffk',command='color spectrum')

    view

  3. "mmdbid" as input (works in Chrome, but not in Safari for now):

    view = icn3dpy.view(q='mmdbid=1ffk',command='color spectrum')

    view

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

    view = icn3dpy.view(q='pdbid=6m0j',command='line graph 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-0.1.17.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: icn3dpy-0.1.17.tar.gz
  • Upload date:
  • Size: 5.2 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-0.1.17.tar.gz
Algorithm Hash digest
SHA256 c76ae60401ee4a6e673c371637e0378e980e66cd09dad47f972cfcaa2f08249e
MD5 4ac32039f1c2ae86cd17158d98477d0e
BLAKE2b-256 88ba916a1d5402df507a98d456384cf09cc5a9f07c774a98527f8cc4d5ddc7a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: icn3dpy-0.1.17-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-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 f3c37de760ef6c212047e358379f50b217a9654113e576784a46fcdc2779034d
MD5 0ae8cc055f4ea2bcdb6985d7c2e3531d
BLAKE2b-256 898ce2f768b594a6f8fcadafa4956c0c8929a0cf65636ec915f805a154961a38

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