Difference between revisions of "Linux Install"

Latest revision as of 05:01, 22 June 2020

This page describes how to install PyMOL on Linux.

Incentive PyMOL

Schrödinger provides pre-compiled (64 bit) PyMOL to paying sponsors. 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/

Open-Source PyMOL in Linux Distros

Many Linux distributions provide binary packages for open-source PyMOL. They often do not provide the latest version, but if the provided package fits your needs this is the most convenient way to install PyMOL.

Command line install examples for some popular distributions (note that all of these commands must be run as root or superuser):

# Arch/Manjaro
pacman -S pymol

# CentOS with EPEL
rpm -i http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-5.noarch.rpm
yum --enablerepo=epel install pymol

# Debian/Ubuntu/Mint
apt-get install pymol

# Fedora
dnf install pymol

# Gentoo
emerge -av pymol

# openSUSE (12.1 and later)
zypper install pymol

# Sabayon
equo i -av pymol

Install from source

Installation from source gives you the latest version and is the generic way to install PyMOL.

Please also consult the INSTALL file.

Requirements

Libraries as well as development files (headers) of the following software is required:

C++11 compiler (e.g. GCC 4.7 or higher)
Python 3.6+
OpenGL driver (I use NVidia)
GLEW
libpng
freetype
libxml2 (optional, for COLLADA export, disable with --no-libxml)
msgpack-c 2.1.5+ (optional, for fast MMTF loading, new in SVN r4167, disable with --use-msgpackc=no)
PyQt5, PyQt4, or PySide (optional, will fall back to Tk interface if compiled with --glut)
glm
mmtf-cpp (optional, for MMTF export, disable with --use-msgpackc=no)
libnetcdf (optional, disable with --no-vmd-plugins)

Optional/deprecated:

Pmw (Python Megawidgets, for legacy GUI/plugins)
GLUT/freeglut (enable with --glut)

On many Linux systems, one of the following commands installs all requirements (and must be run as root):

# Debian/Ubuntu/Mint
apt-get install git build-essential python3-dev libglew-dev \
  libpng-dev libfreetype6-dev libxml2-dev \
  libmsgpack-dev python3-pyqt5.qtopengl libglm-dev libnetcdf-dev

# CentOS
yum install gcc gcc-c++ kernel-devel python-devel tkinter python-pmw glew-devel \
  freeglut-devel libpng-devel freetype-devel libxml2-devel glm-devel \
  msgpack-devel netcdf-devel

# Fedora
dnf install gcc gcc-c++ kernel-devel python3-devel glew-devel PyQt5 msgpack-devel \
  freeglut-devel libpng-devel freetype-devel libxml2-devel glm-devel

# Gentoo
emerge -av dev-lang/python dev-python/pmw media-libs/glew \
  media-libs/freeglut media-libs/libpng media-libs/freetype media-libs/glm

# openSUSE
zypper install python-devel freeglut-devel gcc-c++ glew-devel libpng-devel python-pmw glm

# Sabayon
equo i -av dev-lang/python dev-python/pmw media-libs/glew \
  media-libs/freeglut media-libs/libpng media-libs/freetype

Get latest source from Git

git clone https://github.com/schrodinger/pymol-open-source.git
git clone https://github.com/rcsb/mmtf-cpp.git
mv mmtf-cpp/include/mmtf* pymol-open-source/include/
cd pymol-open-source

The master branch requires Python 3.6+. Use the legacy py2 branch for Python 2.7 compatibility.

Libraries in non-standard places

Optional: You may use the colon-delimited $PREFIX_PATH variable to point setup.py to non-standard locations of libraries and headers (those locations should have include and lib directories).

Compile and install

This will install PyMOL as normal user into $HOME/pymol-open-source-build.

#!/bin/bash -e

prefix=$HOME/pymol-open-source-build

# Example for dependencies in non-standard places
# export PREFIX_PATH="$HOME/extra/glew-2.0.0:$HOME/extra/libpng-1.6.5:/opt/local"

python3 setup.py build install \
    --home=$prefix

Now launch PyMOL like this:

$HOME/pymol-open-source-build/bin/pymol

Troubleshooting

Do do a "clean" build, remove the "build" directory (sometimes necessary if "git pull" changed header files)

If you are using Ubuntu with a NVIDIA graphic card and generic drivers you may experience bad rendering, black pixelation and other graphical oddities. A guide to installing NVIDIA proprietary drivers can be found under Ubuntu community Nvidia Drivers How To

Customized Installations

Troels Linnet's installations scripts: Detailed installation scripts for Ubuntu, Mint 12 and RHEL 6, including MPEG support from FREEMOL

@@ Line 40: / Line 40: @@
 Installation from source gives you the latest version and is the generic way to install PyMOL.
+Please also consult the [https://github.com/schrodinger/pymol-open-source/blob/master/INSTALL INSTALL] file.
 === Requirements ===
@@ Line 46: / Line 48: @@
 required:
-* [http://subversion.apache.org/ Subversion] to download the source code
+* C++11 compiler (e.g. GCC 4.7 or higher)
-* [http://www.python.org/ Python] (with distutils)
+* [http://www.python.org/ Python] 3.6+
-* [http://pmw.sf.net Pmw] (Python Megawidgets)
 * OpenGL driver (I use [http://www.nvidia.com/object/unix.html NVidia])
 * GLEW
-* GLUT (freeglut)
 * libpng
 * freetype
 * libxml2 (optional, for COLLADA export, disable with <code>--no-libxml</code>)
-* [https://github.com/msgpack/msgpack-c msgpack-c] 1.0+ (optional, for fast [http://mmtf.rcsb.org/ MMTF] loading, new in SVN r4167, disable with <code>--use-msgpackc=no</code>)
+* [https://github.com/msgpack/msgpack-c msgpack-c] 2.1.5+ (optional, for fast [http://mmtf.rcsb.org/ MMTF] loading, new in SVN r4167, disable with <code>--use-msgpackc=no</code>)
-* PyQt5, PyQt4, or PySide (optional, will fall back to Tk interface)
+* PyQt5, PyQt4, or PySide (optional, will fall back to Tk interface if compiled with <code>--glut</code>)
-* [https://github.com/schrodinger/simplemmtf-python simplemmtf] (optional, for MMTF export)
+* [https://glm.g-truc.net/ glm]
+* [https://github.com/rcsb/mmtf-cpp mmtf-cpp] (optional, for [http://mmtf.rcsb.org/ MMTF] export, disable with <code>--use-msgpackc=no</code>)
+* libnetcdf (optional, disable with <code>--no-vmd-plugins</code>)
+Optional/deprecated:
+* [https://github.com/schrodinger/pmw-patched Pmw] (Python Megawidgets, for legacy GUI/plugins)
+* GLUT/freeglut (enable with <code>--glut</code>)
 On many Linux systems, one of the following commands installs all requirements (and must be run as root):
@@ Line 63: / Line 70: @@
 <source lang="bash">
 # Debian/Ubuntu/Mint
-apt-get install subversion build-essential python-dev python-pmw libglew-dev \
+apt-get install git build-essential python3-dev libglew-dev \
-   freeglut3-dev libpng-dev libfreetype6-dev libxml2-dev \
+   libpng-dev libfreetype6-dev libxml2-dev \
-   libmsgpack-dev python-pyqt5.qtopengl
+   libmsgpack-dev python3-pyqt5.qtopengl libglm-dev libnetcdf-dev
 # CentOS
-yum install subversion gcc gcc-c++ kernel-devel python-devel tkinter python-pmw glew-devel \
+yum install gcc gcc-c++ kernel-devel python-devel tkinter python-pmw glew-devel \
-   freeglut-devel libpng-devel freetype-devel libxml2-devel
+   freeglut-devel libpng-devel freetype-devel libxml2-devel glm-devel \
+  msgpack-devel netcdf-devel
 # Fedora
-dnf install subversion gcc gcc-c++ kernel-devel python-devel tkinter python-pmw glew-devel \
+dnf install gcc gcc-c++ kernel-devel python3-devel glew-devel PyQt5 msgpack-devel \
-   freeglut-devel libpng-devel freetype-devel libxml2-devel
+   freeglut-devel libpng-devel freetype-devel libxml2-devel glm-devel
 # Gentoo
-emerge -av dev-vcs/subversion dev-lang/python dev-python/pmw media-libs/glew \
+emerge -av dev-lang/python dev-python/pmw media-libs/glew \
-   media-libs/freeglut media-libs/libpng media-libs/freetype
+   media-libs/freeglut media-libs/libpng media-libs/freetype media-libs/glm
 # openSUSE
-zypper install python-devel freeglut-devel gcc-c++ glew-devel libpng-devel python-pmw subversion
+zypper install python-devel freeglut-devel gcc-c++ glew-devel libpng-devel python-pmw glm
 # Sabayon
-equo i -av dev-vcs/subversion dev-lang/python dev-python/pmw media-libs/glew \
+equo i -av dev-lang/python dev-python/pmw media-libs/glew \
    media-libs/freeglut media-libs/libpng media-libs/freetype
 </source>
-=== Get latest source from SVN ===
+=== Get latest source from Git ===
-This will download the latest source to '''/tmp/pymol''':
 <source lang="bash">
-cd /tmp
+git clone https://github.com/schrodinger/pymol-open-source.git
-svn co svn://svn.code.sf.net/p/pymol/code/trunk/pymol
+git clone https://github.com/rcsb/mmtf-cpp.git
-cd pymol
+mv mmtf-cpp/include/mmtf* pymol-open-source/include/
+cd pymol-open-source
 </source>
-<div class="mw-collapsible mw-collapsed" style="width: 600px; padding: 0px 8px; background-color: #fc9;">
+''The master branch requires Python 3.6+. Use the legacy [https://github.com/schrodinger/pymol-open-source/tree/py2 py2] branch for Python 2.7 compatibility.''
-'''Troubleshooting:''' Connection refused...
-<div class="mw-collapsible-content" style="padding: 2px;">
-If the above address is not available, giving an error such as
- Connection refused: Unable to connect to a repository at URL <nowiki>'svn://svn.code.sf.net/p/pymol/code/trunk/pymol'</nowiki>: Can't connect to host 'svn.code.sf.net': Connection refused...
+=== Libraries in non-standard places ===
-you can try using <code>http://</code> instead of <code>svn://</code> in the URL.
+Optional: You may use the colon-delimited <code>$PREFIX_PATH</code> variable to point <code>setup.py</code> to non-standard locations of libraries and headers (those locations should have <code>include</code> and <code>lib</code> directories).
-</div>
-</div>
 === Compile and install ===
-This will install PyMOL as normal user into '''/opt/pymol-svn'''. If you don't have write permissions to '''/opt''', change the <code>prefix</code> variable to something like '''$HOME/pymol-svn'''.
+This will install PyMOL as normal user into <code>$HOME/pymol-open-source-build</code>.
 <source lang="bash">
 #!/bin/bash -e
-prefix=/opt/pymol-svn
+prefix=$HOME/pymol-open-source-build
-modules=$prefix/modules
-# If you want to install as root, then split this line up in "build"
+# Example for dependencies in non-standard places
-# and "install" and run the "install" with "sudo"
+# export PREFIX_PATH="$HOME/extra/glew-2.0.0:$HOME/extra/libpng-1.6.5:/opt/local"
-python2.7 setup.py build install \
-     --home=$prefix \
+python3 setup.py build install \
-    --install-lib=$modules \
+     --home=$prefix
-    --install-scripts=$prefix
 </source>
@@ Line 129: / Line 129: @@
 <source lang="bash">
-/opt/pymol-svn/pymol
+$HOME/pymol-open-source-build/bin/pymol
 </source>
-Optionally, in order to allow running the command <code>pymol</code> from the terminal to launch the program do:
-<source lang = "bash">
-sudo ln -s /opt/pymol-svn/pymol /usr/bin/pymol
-</source>
-====Updating====
-To update the installation merely run:
-<source lang = "bash">
-sudo rm -r /opt/pymol-svn/pymol
-rm -r /tmp/pymol
-</source>
-and redo the installation from the beginning with the latest release.
 === Troubleshooting ===
-* On Linux Mint 11 there have been reports of gcc-4.5 breaking Pymol. You could use gcc-4.4 instead. (reported by [[User:Tlinnet]])
+* Do do a "clean" build, remove the "build" directory (sometimes necessary if "git pull" changed header files)
-<div style="margin-left: 2em;">
-<source lang="bash">
-sudo apt-get install build-essential gcc-4.4 g++-4.4
-export CC=/usr/bin/gcc-4.4
-</source>
-</div>
-* If you get an error message "ImportError: No module named Pmw" and lack half of the user interface, then append <code>--bundled-pmw</code> to the install command line.
-* If you're using Ubuntu 11.10 with an Intel Sandy Bridge video card and get graphics oddities. Please see [https://launchpad.net/~glasen/+archive/intel-driver Intel Driver Post for Ubuntu].
 * If you are using Ubuntu with a NVIDIA graphic card and generic drivers you may experience bad rendering, black pixelation and other graphical oddities. A guide to installing NVIDIA proprietary drivers can be found under [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia Ubuntu community Nvidia Drivers How To]