PyMOL Plugin Installation

PyMOL Plug-in Installation Guide

If you wish to use parKVFinder with a graphical user interface on PyMOL, you need to install PyMOL2 parKVFinder Tools for PyMOL v2.x or PyMOL parKVFinder Tools for PyMOL v1.8.x. If necessary, refer to this guide for installing PyMOL on Linux and macOS.

PyMOL2 parKVFinder Tools (PyMOL v2.x)

PyMOL2 parKVFinder Tools is available to use with PyMOL v2.x and has been been developed using Qt interface and Python3.

First, the plug-in requires the installation of toml module and PyMOL's native Python does not have it installed. So you need to install them:

# PyMOL v2 (python 3)
$ pip3 install toml
# In an conda environment via Anaconda Cloud
$ conda install -c conda-forge toml

Note: pip or Anaconda package management system installation is required.

Then, to install the PyMOL2 parKVFinder Tools on PyMOL v2.x, download the latest PyMOL2-parKVFinder-Tools.zip from here and follow these steps:

1. Open PyMOL.
2. Go to Plugin menu, click on Plugin Manager.
3. The Plugin Manager window will open, go to the Install New Plugin tab.
4. Under Install from local file panel, click on Choose file....
5. The Install Plugin window will open, select the PyMOL2-parKVFinder-Tools.zip` that you downloaded earliar.
6. The Select plugin directory window will open, select /home/<user>/.pymol/startup and click OK.
7. The Confirm window will open, click OK.
8. The Sucess window will appear, confirming that the plug-in has been installed.
9. Restart PyMOL.
10. PyMOL2 parKVFinder Tools is ready to use.

Or, instead of selecting PyMOL2-parKVFinder-Tools.zip (Step 5), you can select __init__.py file on parKVFinder/tools/PyMOL2-parKVFinder-Tools directory tree.

PyMOL parKVFinder Tools (PyMOL v1.8.x)

PyMOL parKVFinder Tools is available to use with PyMOL v1.8.x and has been been developed using tk interface and Python.

First, the plug-in requires the installation of toml and future modules and PyMOL's native Python does not have them installed. So you need to install them:

# PyMOL v1.8.x
$ pip install toml future
# In an conda environment via Anaconda Cloud
$ conda install -c conda-forge toml

Note: pip or Anaconda package management system installation is required.

Then, to install the PyMOL parKVFinder Tools on PyMOL v1.8.x, follow these steps:

1. Open PyMOL.
2. Go to Plugin menu, click on Plugin Manager.
3. The Plugin Manager window will open, go to the Install New Plugin tab.
4. Under Install from local file Group, click Choose file... .
5. The Install Plugin window will open, you select PyMOL_parKVFinder_tools.py on parKVFinder/tools/tk directory tree.
6. The Select plugin directory window will open, select /home/<user>/.pymol/startup and click OK.
7. The Confirm window will open, click OK.
8. The Sucess window will appear, confirming that the plug-in has been installed.
9. Restart PyMOL.
10. PyMOL parKVFinder Tools is ready to use.

---