Difference between revisions of "Windows Install"

From PyMOLWiki
Jump to navigation Jump to search
m (reformulate a hyperlink)
(37 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Installation|Windows]]
+
This page describes how to install PyMOL on Microsoft Windows.
  
== Installing ==
+
== Incentive PyMOL ==
=== Binary ===
 
To install PyMOL from the binaries, just run the executable you've [http://pymol.sf.net/ downloaded].
 
  
=== Source ===
+
[http://www.schrodinger.com Schrödinger] provides an installer to paying sponsors (EXE for PyMOL 2.0, MSI for previous version). The bundle also includes ready-to-use [[APBS]], [[morph|RigiMOL]], an MPEG encoder for movie export, and a small molecule energy minimization engine.
To get the latest features, you should download the [http://sourceforge.net/svn/?group_id=4546 PyMOL source] from the [http://sourceforge.net/projects/pymol/ project page].
 
  
==== Directions using CygWin ====
+
Download: https://pymol.org/#download
* Install [http://www.cygwin.com/ CygWin].  Make sure you install the following modules:
 
You should have similar packages installed as described [http://www.pymolwiki.org/index.php/Linux_Install#Mint11_Linux_.28Ubuntu.29_-_Tested_for_PyMOL_1.4.1 here]. Note, that you might need gcc-4.4 instead of  gcc-4.5.
 
** C++ (gcc or g++ package name)
 
** Python
 
** OpenGL
 
** PNG
 
* run '''python setup.py install''' in the source directory
 
* run '''python setup2.py install''' in the source directory
 
* install Pmw
 
  
== Pre-compiled PyMOL ==
+
== Open-Source PyMOL ==
Pre-compiled PyMOL is also available free from Christoph Gohlke of the Laboratory for Fluorescence Dynamics, University of California, Irvine [http://www.lfd.uci.edu/~gohlke/pythonlibs/#pymol here].
 
  
For example install [http://www.python.org/getit/releases/2.7/ python 2.7] on windows, and then compile the open source pymol 1.4.1 for free.
+
Open-Source PyMOL is available [https://sourceforge.net/p/pymol/code/HEAD/tree/trunk/pymol/LICENSE free of charge]. It also allows sponsors to create highly customized PyMOL installations which might not be possible with the MSI installer.
# Install python, (2.5, or 2.6) 2.7 for windows.
 
# Download [ http://www.lfd.uci.edu/~gohlke/pythonlibs/#pymol appropriate installer] and select according to your python version and system.
 
# Run the downloaded installer
 
# PyMOL is now installed in: C:\Python27\PyMOL
 
<br/>
 
# Edit '''C:\Python2X\PyMOL\PDB_file.reg ''' so it matches your python version. That makes sure that .pdb files has the right icon and is opened with pymol.
 
<source lang="bash">
 
REGEDIT4
 
  
[-HKEY_CLASSES_ROOT\.pdb]
+
Pre-compiled Open-Source PyMOL is available free from [http://www.lfd.uci.edu/~gohlke/pythonlibs/#pymol Christoph Gohlke of the Laboratory for Fluorescence Dynamics, University of California, Irvine].
[HKEY_CLASSES_ROOT\.pdb]
 
@="PDB.File"
 
"Content Type"="chemical/x-pdb"
 
[-HKEY_CLASSES_ROOT\PDB.File]
 
[HKEY_CLASSES_ROOT\PDB.File]
 
@="PDB File"
 
[HKEY_CLASSES_ROOT\PDB.File\DefaultIcon]
 
@="C:\\Python27\\PyMOL\\PyMOL.exe"
 
[HKEY_CLASSES_ROOT\PDB.File\Shell]
 
@=""
 
[HKEY_CLASSES_ROOT\PDB.File\Shell\open]
 
[HKEY_CLASSES_ROOT\PDB.File\Shell\open\command]
 
@="\"C:\\Python27\\PyMOL\\PyMOL.cmd\" %*"
 
  
[-HKEY_CLASSES_ROOT\.pml]
+
# Install the latest version of Python 3 for Windows (e.g., by going to http://www.python.org/downloads/ and choosing the x64 EXE installer). Use the standard options, which should mean that the installation directory is most likely C:\Users\<Your Username>\AppData\Local\Programs\Python\Python38). Make sure the option to add environment variables is selected.
[HKEY_CLASSES_ROOT\.pml]
+
# Do install [https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads the current Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019]. Otherwise the installed PyMOL binary may fail to run (without any error message!). 
@="PML.File"
+
# Download the [http://www.lfd.uci.edu/~gohlke/pythonlibs/#pymol-open-source appropriate wheel files], along with all requirement wheel files (including [http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip pip], [http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy Numpy] and [http://www.lfd.uci.edu/~gohlke/pythonlibs/#pmw PMW]) into a single file directory, e.g., <code>C:\Users\<Your Username>\Downloads\PyMOL_installation</code>
"Content Type"="script/x-pymol"
 
[-HKEY_CLASSES_ROOT\PML.File]
 
[HKEY_CLASSES_ROOT\PML.File]
 
@="PML File"
 
[HKEY_CLASSES_ROOT\PML.File\DefaultIcon]
 
@="C:\\Python27\\PyMOL\\PyMOL.exe"
 
[HKEY_CLASSES_ROOT\PML.File\Shell]
 
@=""
 
[HKEY_CLASSES_ROOT\PML.File\Shell\open]
 
[HKEY_CLASSES_ROOT\PML.File\Shell\open\command]
 
@="\"C:\\Python27\\PyMOL\\PyMOL.cmd\" %*"
 
</source>
 
Run it with regedit and restart so changes take effect. After restart, you should see the PyMOL icon for .pdb files and be able to double click it to launch PyMOL.
 
Pymol can also started by clicking C:\Python27\PyMOL\pymol.cmd  which executes python on C:\Python27\PyMOL\pymol-launch.py. Make a link to pymol.cmd.
 
  
You can make a "pymolrc.pym" file, and put it under "C:\Users\YOU". In the file you can write the following listed. This folder is now in your PyMOL search path, so you can put pymol wiki scripts here. Note the forward slashes "/".
+
Navigate to the installation directory in a CMD window <source lang = python>cd C:\Users\<Your Username>\Downloads\PyMOL_installation</source> (or where ever you put the files) and begin the installation using the command:
<source lang="python">
+
<source lang = python>python.exe pip-20.x.x-py2.py3-none-any.whl/pip install --no-index --find-links="%CD%" pymol_launcher</source> If your python install is part of your PATH variable, then running (where x refers to the version number of pip): <source lang = python>python pip-20.x.x-py2.py3-none-any.whl/pip install --no-index --find-links="%CD%" pymol_launcher</source>
import sys
+
should suffice.
sys.path.append("C:/Python27/PyMOL/scripts")
 
</source>
 
  
== Problems &amp; Solutions ==
+
To update PyMOL update the files in the PyMOL install directory and run: <source lang = python>pip install --upgrade --no-deps pymol.whl</source> where <code>pymol.whl</code> is replaced by the PyMOL wheel file name (not the launcher, the launcher should not require updating). To use the newer single-window Qt interface, also install the optional PyQt5 dependency for your Python installation: <source lang=python> pip install pyqt5 </source>
  
===Problem: Installing PyMol 0.98 on WinXP Pro SP2===
+
=== Extend PyMOL with additional scripts ===
If you get the following error '''while''' installing
+
If you now want to extend the capabilities of PyMOL, and take advantage of all the available plugins+scripts "out there", then do the following. <br>
<pre>
+
# First install "numpy" as an available module to Python. [http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy Select appropriate installer from here]
"16-bit Windows Subsystem.":
+
# Download the script/plugin collection [[Git | Pymol-script-repo]] from [https://github.com/Pymol-Scripts/Pymol-script-repo/zipball/master a .zip file from here]
"C:\WINDOWS\SYSTEM32\AUTOEXEC.NT. The system file is not
+
  git clone https://github.com/Pymol-Scripts/Pymol-script-repo
  suitable for running MS-DOS and Microsoft Windows applications.
+
# Unpack it to here: '''C:\Python27\Lib\site-packages\pymol\pymol_path\Pymol-script-repo'''   Double check that the folder name is correct and the same.
Choose 'Close' to terminate the application.
+
Open "Notepad" and write.
</pre>
+
<syntaxhighlight lang="python">
'''Fix''': Sounds like the '''AUTOEXEC.NT''' file is corrupt. You can fix this problem by replacing
+
# Add paths to sys.path so PyMOL can find modules and scripts
c:\WINDOWS\SYSTEM32\AUTOEXEC.NT
+
import sys, os
with the one in
+
pymol_git = os.path.abspath(os.path.join(os.environ['PYMOL_PATH'], 'Pymol-script-repo'))
c:\windows\repair
+
os.environ['PYMOL_GIT_MOD'] = os.path.join(pymol_git,'modules')
However if this doesn't work (or if the file is absent from this repair folder), use the file on the installation CDROM, it is
+
sys.path.append(pymol_git)
autoexec.nt_
+
sys.path.append(os.environ['PYMOL_GIT_MOD'])
in the '''i386''' folder. Just type in a command window:
 
expand X:\i386\autoexec.nt_ c:\windows\system32\autoexec.nt
 
where '''X''' is the drive letter of your CDROM.
 
  
If this does not resolve your issue, visit this link:
+
# Make setting changes to Plugin Manager
[http://support.microsoft.com/default.aspx?scid=kb;en-us;324767 MS Support For This Issue]
+
import pymol.plugins
where you may also find the answer to your question.
+
pymol.plugins.preferences = {'instantsave': False, 'verbose': False}
 +
pymol.plugins.autoload = {'apbs_tools': False}
 +
pymol.plugins.set_startup_path([os.path.join(pymol_git, 'plugins'), os.path.join(sys.prefix, 'Lib', 'site-packages', 'pmg_tk', 'startup')])
 +
pymol.plugins.preferences = {'instantsave': True, 'verbose': False}
 +
</syntaxhighlight>
 +
'''Then "File->Save as->All files-> C:\Python27\Lib\site-packages\pymol\pymol_path\run_on_startup.py'''
  
 +
Now start pymol, and enjoy all the plugins available from the menu.
  
 +
'''PyMOL''' shortcut<br>
 +
Make a '''pymol''' directory in your homepath. '''mkdir %HOMEPATH%\pymol'''  Then make sure, PyMOL starts here, when you open the shortcut.<br>
 +
Make a shortcut to the .cmd file, and modify it. <br>
 +
Target: C:\python27\PyMOL\pymol.cmd <br>
 +
Start in: %HOMEPATH%\pymol
  
===Problem: PyMol Binary Crashes===
+
== See Also ==
==== Video Driver ====
 
'''Fix''': Try updating your video card's driver software.  This is a common problem on laptops.
 
  
==== msvcr71.dll ====
+
* [[pymolrc]]
'''Fix''': find the file '''msvcr71.dll''' on your computer and copy it to the directory that PyMol was installed to.
+
* [[Linux Install]]
 
+
* [[MAC Install]]
 
 
 
 
===Problem: Path Does Not Exist Error ===
 
 
 
'''Install Shield Problem with some Dell Laptops'''
 
 
 
With this problem irrespective of where you place the binaries for installing PyMol you receive an error claiming that the path\setup.exe does not exist.
 
 
 
'''Fix''': Install the windows binary through 16-bit MS-DOS console.
 
 
 
First place the PyMol setup binaries in an easy to find folder, e.g. C:\PyMol
 
 
 
Use the '''RUN''' command via '''Windows Start'''.
 
 
 
In the '''CLI''' type '''COMMAND.COM''' (note CMD will not work as it is a native interface and not true DOS).
 
 
 
In the '''DOS CLI''' that opens go back to the root directory '''C:\''' using the '''cd..''' command.
 
 
 
Then go to the folder into which you placed PyMol, e.g. '''cd PyMol'''.
 
 
 
Then type in '''setup.exe'''.
 
 
 
PyMol should now install, simply type '''exit''' to close the '''DOS CLI'''
 
 
 
== Using ==
 
===Debugging===
 
On Windows, you need to launch PyMOLWin.exe from a Windows command line with the "+2" option to prevent PyMOL from hiding the console window:
 
(start menu -> run -> cmd [return])
 
 
 
<source lang="bash">
 
cd c:\program files\delano scientific\pymol
 
 
 
pymolwin + 2
 
</source>
 
  
 +
[[Category:Installation|Windows]]
 
[[Category:Technical Issues|Windows Install]]
 
[[Category:Technical Issues|Windows Install]]
 
[[Category:Windows]]
 
[[Category:Windows]]

Revision as of 06:50, 23 April 2021

This page describes how to install PyMOL on Microsoft Windows.

Incentive PyMOL

Schrödinger provides an installer to paying sponsors (EXE for PyMOL 2.0, MSI for previous version). The bundle also includes ready-to-use APBS, RigiMOL, an MPEG encoder for movie export, and a small molecule energy minimization engine.

Download: https://pymol.org/#download

Open-Source PyMOL

Open-Source PyMOL is available free of charge. It also allows sponsors to create highly customized PyMOL installations which might not be possible with the MSI installer.

Pre-compiled Open-Source PyMOL is available free from Christoph Gohlke of the Laboratory for Fluorescence Dynamics, University of California, Irvine.

  1. Install the latest version of Python 3 for Windows (e.g., by going to http://www.python.org/downloads/ and choosing the x64 EXE installer). Use the standard options, which should mean that the installation directory is most likely C:\Users\<Your Username>\AppData\Local\Programs\Python\Python38). Make sure the option to add environment variables is selected.
  2. Do install the current Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019. Otherwise the installed PyMOL binary may fail to run (without any error message!).
  3. Download the appropriate wheel files, along with all requirement wheel files (including pip, Numpy and PMW) into a single file directory, e.g., C:\Users\<Your Username>\Downloads\PyMOL_installation

Navigate to the installation directory in a CMD window

cd C:\Users\<Your Username>\Downloads\PyMOL_installation

(or where ever you put the files) and begin the installation using the command:

python.exe pip-20.x.x-py2.py3-none-any.whl/pip install --no-index --find-links="%CD%" pymol_launcher

If your python install is part of your PATH variable, then running (where x refers to the version number of pip):

python pip-20.x.x-py2.py3-none-any.whl/pip install --no-index --find-links="%CD%" pymol_launcher

should suffice.

To update PyMOL update the files in the PyMOL install directory and run:

pip install --upgrade --no-deps pymol.whl

where pymol.whl is replaced by the PyMOL wheel file name (not the launcher, the launcher should not require updating). To use the newer single-window Qt interface, also install the optional PyQt5 dependency for your Python installation:

 pip install pyqt5

Extend PyMOL with additional scripts

If you now want to extend the capabilities of PyMOL, and take advantage of all the available plugins+scripts "out there", then do the following.

  1. First install "numpy" as an available module to Python. Select appropriate installer from here
  2. Download the script/plugin collection Pymol-script-repo from a .zip file from here
git clone https://github.com/Pymol-Scripts/Pymol-script-repo
  1. Unpack it to here: C:\Python27\Lib\site-packages\pymol\pymol_path\Pymol-script-repo Double check that the folder name is correct and the same.

Open "Notepad" and write.

# Add paths to sys.path so PyMOL can find modules and scripts
import sys, os
pymol_git = os.path.abspath(os.path.join(os.environ['PYMOL_PATH'], 'Pymol-script-repo'))
os.environ['PYMOL_GIT_MOD'] = os.path.join(pymol_git,'modules')
sys.path.append(pymol_git)
sys.path.append(os.environ['PYMOL_GIT_MOD'])

# Make setting changes to Plugin Manager
import pymol.plugins
pymol.plugins.preferences = {'instantsave': False, 'verbose': False}
pymol.plugins.autoload = {'apbs_tools': False}
pymol.plugins.set_startup_path([os.path.join(pymol_git, 'plugins'), os.path.join(sys.prefix, 'Lib', 'site-packages', 'pmg_tk', 'startup')])
pymol.plugins.preferences = {'instantsave': True, 'verbose': False}

Then "File->Save as->All files-> C:\Python27\Lib\site-packages\pymol\pymol_path\run_on_startup.py

Now start pymol, and enjoy all the plugins available from the menu.

PyMOL shortcut
Make a pymol directory in your homepath. mkdir %HOMEPATH%\pymol Then make sure, PyMOL starts here, when you open the shortcut.
Make a shortcut to the .cmd file, and modify it.
Target: C:\python27\PyMOL\pymol.cmd
Start in: %HOMEPATH%\pymol

See Also