This is a read-only mirror of pymolwiki.org
Difference between revisions of "Pymol-script-repo"
Line 20: | Line 20: | ||
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. <br> | All letters should also be small for both. <br> | ||
+ | This will ease the use of the script | ||
+ | |||
Example: colorbydisplacement | Example: colorbydisplacement | ||
Line 33: | Line 35: | ||
To import in PyMOL | To import in PyMOL | ||
import colorbydisplacement | import colorbydisplacement | ||
+ | To print the available functions in PyMOL | ||
+ | help(colorbydisplacement) |
Revision as of 15:32, 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
- A convenient way, to let PyMOL users download all scripts at the PyMOL wiki, with a minimum of effort.
- The possibility to let script authors push changes to their script out to PyMOL users.
- Easier requiring assistance from the PyMOL mailing list.
- 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.
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.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
To print the available functions in PyMOL
help(colorbydisplacement)