Skip to main content

IPyMOL allows you to control PyMOL sessions via IPython.

Project description

Latest PyPI version

IPyMOL

IPyMOL allows you to control PyMOL sessions via IPython. This tool is ideal for situations where you’d like to present your work neatly in a Jupyter Notebook or conveniently prototype PyMOL scripts.

Before You Begin

Please ensure that PyMOL is in your $PATH as pymol or you can start PyMOL in server mode:

$ pymol -R #-cKRQ to run it without a GUI

Installation

pip install ipymol

Example Usage

You can fire up an IPython or IPython Notebook session and start using IPyMOL. For example:

from ipymol import viewer as pymol
pymol.start()   # Start PyMOL RPC server
pymol.fetch('3odu') # Fetch PDB
pymol.show_as('cartoon') # Show as cartoon
pymol.bg_color('white') # Set background color to white
pymol.display() # Show current display

This series of commands will define a variable pymol of class MolViewer, which can pass commands to PyMOL, and then create an image of PDBID:3odu in your IPython session. Additional commands can be invoked via pymol.do("[ENTER YOUR COMMAND HERE]").

Here’s an example notebook with more information.

Enjoy!

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

ipymol-0.4.tar.gz (2.7 kB view details)

Uploaded Source

File details

Details for the file ipymol-0.4.tar.gz.

File metadata

  • Download URL: ipymol-0.4.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ipymol-0.4.tar.gz
Algorithm Hash digest
SHA256 bf880993549881b7e4f02db62d0c37370a65f0fce5a07b59fbc60d473bdfc5ee
MD5 cf73268da09a5d0cd1ac0c4a13ce6224
BLAKE2b-256 ada3ab9c03ea3177c0554fb5e7939cc814602a52438a9b2cb479f5eb4d917aac

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