Difference between revisions of "Pymol-script-repo"

From PyMOLWiki
Jump to: navigation, search
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Introduction ==
+
The [[Pymol-script-repo]] is the preferred place to host scripts which are published on the PyMOLWiki.
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 ==
 
== Benefits ==
The benefits from this project, is
+
# A convenient way, to let PyMOL users download all scripts at the PyMOLWiki, with a minimum of effort.
# 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.
 
# 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].
 
# 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.
 
  
 
== Official repository ==
 
== Official repository ==
The official repository is located at:
+
The repository is located at:
https://github.com/Pymol-Scripts/Pymol-script-repo
+
: https://github.com/Pymol-Scripts/Pymol-script-repo
  
And the Git Read-Only access is:
+
== Naming convention ==
git://github.com/Pymol-Scripts/Pymol-script-repo.git
+
We recommend that the name for script filename and pagename at the PyMOLWiki are the same.
 +
All letters should also be lower case.
  
== Same namespace ==
+
Example: '''colorbydisplacement'''
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)
 
  
For a description of use  
+
{| class="wikitable"
http://www.pymolwiki.org/index.php/colorbydisplacement
+
| For a description of use
For a color coded view
+
| http://pymolwiki.org/index.php/colorbydisplacement
https://github.com/Pymol-Scripts/Pymol-script-repo/blob/master/colorbydisplacement.py.py
+
|-
For the raw code
+
| For a color coded view
https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/colorbydisplacement.py
+
| https://github.com/Pymol-Scripts/Pymol-script-repo/blob/master/colorbydisplacement.py
In the users local script librarr
+
|-
/home/tlinnet/Software/pymol/Pymol-script-repo/colorbydisplacement.py
+
| Raw download
To import in PyMOL
+
| https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/colorbydisplacement.py
import colorbydisplacement
+
|-
 +
| 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]]

Latest revision as of 08:36, 13 November 2018

The Pymol-script-repo is the preferred place to host scripts which are published on the PyMOLWiki.

Benefits

  1. A convenient way, to let PyMOL users download all scripts at the PyMOLWiki, 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.

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

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)

Read more here