Difference between revisions of "Pymol-script-repo"

From PyMOLWiki
Jump to: navigation, search
(Example of namespace)
(Read more here)
Line 58: Line 58:
 
# Information how to contribute scripts to the repository. It's easy!
 
# Information how to contribute scripts to the repository. It's easy!
 
#:http://www.pymolwiki.org/index.php/git_authors
 
#:http://www.pymolwiki.org/index.php/git_authors
 +
# Guidelines how to make a good PyMOL wiki script page.
 +
#:http://www.pymolwiki.org/index.php/git_script_guidelines
 
# Information how Repository admins handle the contributions
 
# Information how Repository admins handle the contributions
 
#:http://www.pymolwiki.org/index.php/git_admin
 
#:http://www.pymolwiki.org/index.php/git_admin

Revision as of 05:55, 2 December 2011

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: http://www.pymolwiki.org/index.php/git_install

Official repository

The official repository is located at:

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

And the Git Read-Only access is:

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

Same namespace

As a part of this project, we recommend that the name for script filename and pagename at the PyMOL wiki are the same. All letters should also be small for both.
This will ease the use of the script

Example: colorbydisplacement

Example of namespace

For a description of use

http://www.pymolwiki.org/index.php/colorbydisplacement

For a color coded view

https://github.com/Pymol-Scripts/Pymol-script-repo/blob/master/colorbydisplacement.py

See the raw code or download manually, by right clicking the following link here -> Save as: colorbydisplacement.py

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)

This means, that if a PyMOL user look in his/her local repo directory, and wonder what colorbydisplacement.py does. Then he/she can write: http://www.pymolwiki.org/index.php/colorbydisplacement

And then a easy description of the of script is presented, with example of use and images. When he/she then wants to use the script, he/she simply write: import colorbydisplacement

To find out the defined functions, he/she can then either look at the wiki page, OR write in PyMOL. help(colorbydisplacement) which automatically returns the functions.

Read more here

  1. Simple install instructions for all PyMOL users.
    http://www.pymolwiki.org/index.php/git_install
  2. Information how to contribute scripts to the repository. It's easy!
    http://www.pymolwiki.org/index.php/git_authors
  3. Guidelines how to make a good PyMOL wiki script page.
    http://www.pymolwiki.org/index.php/git_script_guidelines
  4. Information how Repository admins handle the contributions
    http://www.pymolwiki.org/index.php/git_admin