Pymol-script-repo: Difference between revisions

From PyMOLWiki
Jump to navigation Jump to search
No edit summary
Line 19: Line 19:
== Same namespace ==
== 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.
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 let be possible to do, (Example: colorbydisplacement)
All letters should also be small for both. <br>
Example: colorbydisplacement


=== Example of namespace ===
For a description of use  
For a description of use  
  http://www.pymolwiki.org/index.php/colorbydisplacement
  http://www.pymolwiki.org/index.php/colorbydisplacement

Revision as of 10:31, 30 November 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.

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.
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.py

For the raw code

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

In the users local script librarr

/home/tlinnet/Software/pymol/Pymol-script-repo/colorbydisplacement.py

To import in PyMOL

import colorbydisplacement