Pymol-script-repo

Introduction

In November 2011, a group of PyMOL users initiated together with Jason Vertrees, a project to let PyMOL scripts be under version control system (VCS) called Git.

We hope that script authors and PyMOL users would be interested in this option.

Benefits

The benefits from this project, is

1. A convenient way, to let PyMOL users download all scripts at the PyMOL wiki, with a minimum of effort.
2. The possibility to let script authors push changes to their script out to PyMOL users.
3. Easier requiring assistance from the PyMOL mailing list.
4. Script will be tested for malicious code before added to the official repository.

Read here to install: git install

Official repository

The repository is located at:

https://github.com/Pymol-Scripts/Pymol-script-repo

Naming convention

We recommend that the name for script filename and pagename at the PyMOLWiki are the same. All letters should also be lower case.

Example: colorbydisplacement

For a description of use	http://pymolwiki.org/index.php/colorbydisplacement
For a color coded view	https://github.com/Pymol-Scripts/Pymol-script-repo/blob/master/colorbydisplacement.py
Raw download	https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/colorbydisplacement.py
In the users local script library	/home/tlinnet/Software/pymol/Pymol-script-repo/colorbydisplacement.py
To import in PyMOL	import colorbydisplacement
To print the available functions in PyMOL	help(colorbydisplacement)

Read more here

• Simple install instructions for all PyMOL users
• Information how to contribute scripts to the repository. It's easy!
• Guidelines how to make a good PyMOL wiki script page
• Information how Repository admins handle the contributions