This is a read-only mirror of pymolwiki.org

Difference between revisions of "Pymol-script-repo"

From PyMOL Wiki
Jump to navigation Jump to search
(simplify page, remove redundancy)
(Redirected page to Git intro)
Line 1: Line 1:
−
== Introduction ==
+
#REDIRECT [[Git intro]]
−
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 [http://sourceforge.net/mail/?group_id=4546 mailing list].
 
−
# 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'''
 
−
 
 
−
{| class="wikitable"
 
−
| 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
 
−
| <code>import colorbydisplacement</code>
 
−
|-
 
−
| To print the available functions in PyMOL
 
−
| <code>help(colorbydisplacement)</code>
 
−
|}
 
−
 
 
−
== Read more here ==
 
−
 
 
−
* [[git install|Simple install instructions for all PyMOL users]]
 
−
* [[git authors|Information how to contribute scripts to the repository]]. It's easy!
 
−
* [[git script guidelines|Guidelines how to make a good PyMOL wiki script page]]
 
−
* [[git admin|Information how Repository admins handle the contributions]]
 

Revision as of 12:11, 18 December 2011

Redirect to:

Retrieved from "http://wiki.pymol.org/index.php?title=Pymol-script-repo&oldid=8493"