/PyMol_SphericalHarmonics

Spherical Harmonics plugin/extension for PyMol

Primary LanguagePythonOtherNOASSERTION

PyMol Spherical Harmonics

This repository contains the Plugin 'spherical_harmonics.py' for PyMol (tested on version 2.5.0 Open-Source). This adds the functionality of plotting spherical harmonics functions on any atom of a molecule loaded in PyMol. The functionality is extremely helpful for visualising Atomic Orbitals or Spherical Multipole Moments.

alt text

Requirements

Usage

To load the spherical_harmonics.py script as a PyMol plugin, please follow this link.

A typical PyMol session to run the spherical harmonics plugin will look like this:

alt text
Figure showing an example usage of the spherical_harmonics.py plugin. The image shows a Qzz (i.e. m=2, l=0) component of the Quadrupole of benzene carbons. The 'test' molecule is the text.xyz in the test folder

Variables

  1. selected_atoms : PyMol selection of atoms onto which the chosen spherical harmonic function will be plotted.
  2. molobj : PyMol molecule object. This can be a sub-selection of your system or your entire system as loaded.
  3. r : magnitude of the chosen spherical harmonic function.
  4. m : order of the spherical harmonic function.
  5. l : degree of the spherical harmonic function.
  6. n_points : number of points for the meshgrid.
  7. cmap (=viridis by default): any colormap from the matplotlib package. Examples can be found here.
  8. ax (=0 by default): shows global cartesian axes.
  9. transparency : sets the transparency of the chosen spherical harmonics function.
  10. mesh_type (='triangles' by default) : sets the type of mesh for the CGO object. Options are t = triangles, p = points, l = lines.

To do

  • Add a QTWidget in PyMol GUI

License

The MIT License makes this plugin available for everyone. You are more than welcome to help with the development of this repository. Please cite this github page if you use the plugin for your studies/research. A DOI is also available for citation at: DOI