Git install scripts

From PyMOLWiki
Revision as of 08:57, 5 June 2012 by Tlinnet (talk | contribs) (For Windows users)
Jump to: navigation, search

Manual download of scripts

If you don't have the option or want't to install git on your system, then go to

Click the "ZIP" button, near the top left corner. Now unpack the files to a directory. For example:


Now go to: Adding Pymol-script-repo to PyMOL search path [1]

Git install instructions

For Windows users

  1. Install Git for Windows.

Use following settings in options, (You can read more here).

  • Windows Explorer Integration -> Context Menu Entries -> Git Bash Here + Git GUI here
  • Run Git and included Unix tools from Windows Command prompts
  • Checkout Windows style, commit Unix-style endings
  1. Navigate to: C:\Users\YOURNAME
  2. Right click in folder -> Select: Git Gui -> Clone Existing Repository
  3. Source Location: git://
  4. Target Directory: C:\\Users\\YOURNAME\\Pymol-script-repo
    A backslash "\" in a string is is used for escape sequences. To get a real backslash in a string, use double backslash "\\"

You now have all the scripts available in your directory.

For Linux users

  1. Install git
# Debian/Ubuntu/Mint
sudo apt-get install git
# Fedora
su -c 'yum install git'
# openSUSE
sudo zypper in git
  1. Navigate to desired folder:
cd /home/YOURNAME/Software/pymol
git clone git://

You now have all the scripts available in: /home/YOURNAME/Software/pymol/Pymol-script-repo

Adding Pymol-script-repo to PyMOL search path

You now have to add the "Pymol-script-repo" directory to the PyMOL search path.

PyMOL has since revision 3997 (30/04/21012) an improved plugin/script manager. You have to remove old installations of plugins first, to get the automatic plugin installation to work.

For Windows users

  1. Open notepad
  2. Write (Remember double backslashes)
import sys,os
import plugins
os.chdir('C:\\Users\\YOURNAME\\Documents\\pymol')                                # Your standard working dir

Save under: C:\Users\YOURNAME\pymolrc.pym (Set: "Save as type" to "All files")

For Linux users

gedit ~/.pymolrc


 import sys,os
 import plugins
 os.chdir('/home/YOU/Software/pymol/')                              # Your standard working dir

Save and exit


Or perhaps insert the following code instead (no need to insert USERNAME, so more generic)

# eventually add ~/Software/pymol/Pymol-script-repo to sys.path
import sys, os
# load the module
import plugins

Test the Scripts

Now start PyMOL, and test in PyMOL.

print sys.path
import colorbydisplacement

Get latest changes to scripts

If new scripts are available or changes have been made, then:

For windows users

  1. Navigate to C:\Users\YOURNAME\Documents\Pymol-script-repo
  2. Right click in folder -> Select: Git Bash
  3. Write in terminal
git pull origin master

For Ubuntu/Mint users

  1. Navigate to /home/YOURNAME/Software/pymol/Pymol-script-repo
  2. Write in terminal.
git pull origin master

Do you want to contribute with a script?

Information how to contribute scripts to the repository. It's easy!