This is a read-only mirror of pymolwiki.org
Difference between revisions of "Pymol-script-repo"
Jump to navigation
Jump to search
m (1 revision) |
m (Speleo3 moved page Git intro to Pymol-script-repo over redirect) |
||
| Line 1: | Line 1: | ||
| − | # | + | == 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 [http://sourceforge.net/mail/?group_id=4546 mailing list]. | ||
| + | |||
| + | == 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|Git install instructions]] | ||
| + | * [[git authors|Information how to contribute scripts to the repository]]. | ||
| + | * [[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:33, 13 November 2018
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.
Official repository
The repository is located at:
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)
|