Script Tutorial

Introduction

One of the more powerful features of PyMOL is that it supports Python scripting. That gives you the power of using all the Python libraries. You can even use the Python API to write programs in other languages and then send the results back into PyMOL (this is what cealign does). The PyMOLWiki has a rather extensive script_library full of useful scripts (feel free to add your own).

General Scripts

Scripting follows a simple recipe, in PyMOL.

To write them:

1. Write the function, let's call it doSimpleThing, in a Python file, let's call the file pyProgram.py.
2. Add the following command to the end of the pyProgram.py file

   cmd.extend(doSimpleThing,doSimpleThing)
   

To use them:

1. simply import the script into PyMOL:

   run /home/userName/path/toscript/pyProgram.py
   

That's it. Your script can, through Python, import any modules you need and also edit modify objects in PyMOL.

Getting PyMOL Data into your Script

To get PyMOL data into your script you will need to somehow get access to the PyMOL objects and pull out the data. For example, if you want the atomic coordinates of a selection of alpha carbon atoms your Python function may do something like this (all PyMOL functions are referenced in the See Also section, below):

# Import PyMOL's stored module.  This will allow us with a 
# way to pull out the PyMOL data and modify it in our script.
# See below.
from pymol import stored

def functionName( userSelection ):
    # this array will be used to hold the coordinates.  It
    # has access to PyMOL objects and, we have access to it.
    stored.alphaCabons = []

    # let's just get the alpha carbons, so make the
    # selection just for them
    userSelection = userSelection + " and n. CA"

    cmd.iterate_state(1, selector.process(userSelection), "stored.alphaCarbons.append([x,y,z])")

Advanced Scripts

Example

See the source code for cealign.

See Also

stored, iterate_state