This is a read-only mirror of pymolwiki.org

Difference between revisions of "Git install scripts"

From PyMOL Wiki
Jump to navigation Jump to search
m (moved Git install to Git install scripts: Confusing title with an eventual git install of pymol source.)
(→‎For Linux users: added alternative version of the .pymolrc text for username-agnostic version)
Line 63: Line 63:
 
  gedit ~/.pymolrc
 
  gedit ~/.pymolrc
 
Write
 
Write
 +
<syntaxhighlight lang="python">
 
  import sys,os
 
  import sys,os
 
  sys.path.append('/home/YOU/Software/pymol/Pymol-script-repo')
 
  sys.path.append('/home/YOU/Software/pymol/Pymol-script-repo')
Line 68: Line 69:
 
  import plugins
 
  import plugins
 
  os.chdir('/home/YOU/Software/pymol/')                              # Your standard working dir
 
  os.chdir('/home/YOU/Software/pymol/')                              # Your standard working dir
 +
</syntaxhighlight>
 
Save and exit
 
Save and exit
 +
 +
==== Alternative ====
 +
Or perhaps insert the following code instead (no need to insert USERNAME, so more generic) <!-- this works for me, but please edit if this is wrong -->
 +
<syntaxhighlight lang="python">
 +
# eventually add ~/Software/pymol/Pymol-script-repo to sys.path
 +
import sys, os
 +
sys.path.append(os.path.expanduser('~/Software/pymol/Pymol-script-repo'))
 +
os.environ['PYMOL_GIT_MOD']=os.path.expanduser('~/Software/pymol/Pymol-script-repo')
 +
 +
# load the module
 +
import plugins
 +
</syntaxhighlight>
  
 
== Test the Scripts ==
 
== Test the Scripts ==

Revision as of 11:09, 14 May 2012

Manual download of scripts

If you don't have the option or want't to install git on your system, then go to

https://github.com/Pymol-Scripts/Pymol-script-repo

Click the "ZIP" button, near the top left corner. Now unpack the files to a directory. For example:

C:/Users/YOURNAME/Documents/Pymol-script-repo

or

/home/YOURNAME/Software/pymol

Now go to: Adding Pymol-script-repo to PyMOL search path [1]

Git install instructions

For Windows users

  1. Install Git for Windows.

Use following settings in options, (You can read more here).

  • Windows Explorer Integration -> Context Menu Entries -> Git Bash Here + Git GUI here
  • Run Git and included Unix tools from Windows Command prompts
  • Checkout Windows style, commit Unix-style endings
  1. Navigate to: C:\Users\YOURNAME\Documents\pymol
  2. Right click in folder -> Select: Git Gui -> Clone Existing Repository
  3. Source Location: git://github.com/Pymol-Scripts/Pymol-script-repo.git
  4. Target Directory: C:\\Users\\YOURNAME\\Documents\\pymol\Pymol-script-repo
    A backslash "\" in a string is is used for escape sequences. To get a real backslash in a string, use double backslash "\\"

You now have all the scripts available in your directory.

Add python.exe to your PATH, so external .py scripts can be executed.
Open control panel. Search for, and click: Edit environment variables for your account
Add to end of variable PATH: ;C:\Python27 (Or other path to your python python.exe)
Click start button, and open cmd.exe. Try starting python by writing: python

For Linux users

  1. Install git
# Debian/Ubuntu/Mint
sudo apt-get install git
# Fedora
su -c 'yum install git'
# openSUSE
sudo zypper in git
  1. Navigate to desired folder:
cd /home/YOURNAME/Software/pymol
git clone git://github.com/Pymol-Scripts/Pymol-script-repo.git

You now have all the scripts available in: /home/YOURNAME/Software/pymol/Pymol-script-repo

Adding Pymol-script-repo to PyMOL search path

You now have to add the "Pymol-script-repo" directory to the PyMOL search path.

The project also have automatically plugin installer: http://www.pymolwiki.org/index.php/plugindirectory
This is activated with: import plugins.
You have to remove old installations of plugins first, to get the automatic plugin installation to work.

For Windows users

  1. Open notepad
  2. Write (Remember double backslashes)
import sys,os
sys.path.append('C:\\Users\\YOURNAME\\Documents\\pymol\\Pymol-script-repo')
os.environ['PYMOL_GIT_MOD']='C:\\Users\\YOURNAME\\Documents\\pymol\\Pymol-script-repo\\modules'
import plugins
os.chdir('C:\\Users\\YOURNAME\\Documents\\pymol')                                # Your standard working dir

Save under: C:\Users\YOURNAME\pymolrc.pym (Set: "Save as type" to "All files")

For Linux users

gedit ~/.pymolrc

Write

 import sys,os
 sys.path.append('/home/YOU/Software/pymol/Pymol-script-repo')
 os.environ['PYMOL_GIT_MOD']='/home/YOU/Software/pymol/Pymol-script-repo/modules'
 import plugins
 os.chdir('/home/YOU/Software/pymol/')                              # Your standard working dir

Save and exit

Alternative

Or perhaps insert the following code instead (no need to insert USERNAME, so more generic)

# eventually add ~/Software/pymol/Pymol-script-repo to sys.path
import sys, os
sys.path.append(os.path.expanduser('~/Software/pymol/Pymol-script-repo'))
os.environ['PYMOL_GIT_MOD']=os.path.expanduser('~/Software/pymol/Pymol-script-repo')
 
# load the module
import plugins

Test the Scripts

Now start PyMOL, and test in PyMOL.

print sys.path
import colorbydisplacement
help(colorbydisplacement)

Get latest changes to scripts

If new scripts are available or changes have been made, then:

For windows users

  1. Navigate to C:\Users\YOURNAME\Documents\Pymol-script-repo
  2. Right click in folder -> Select: Git Bash
  3. Write in terminal
git pull origin master

For Ubuntu/Mint users

  1. Navigate to /home/YOURNAME/Software/pymol/Pymol-script-repo
  2. Write in terminal.
git pull origin master

Do you want to contribute with a script?

Information how to contribute scripts to the repository. It's easy!
http://www.pymolwiki.org/index.php/git_authors