This is a read-only mirror of pymolwiki.org

Difference between revisions of "SuperSym"

From PyMOL Wiki
Jump to navigation Jump to search
m (1 revision)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
SuperSym is a PyMOL plugin providing a large number of tools for visualization of space groups; unit cells; and symmetry axes, operators, and partners. Source code for version 1.0 is available from [https://sourceforge.net/projects/supersym/ https://sourceforge.net/projects/supersym/] or [[SuperSymSource]].
+
{{Infobox script-repo
 +
|type      = plugin
 +
|filename  = plugins/SuperSymPlugin.py
 +
|author    = [[User:Srballard|Stuart Ballard]]
 +
|license  =
 +
}}
  
−
==Dependencies, Bugs, and Acknowledgments==
+
[[File:SuperSymExample.png|300px|thumb|right|Symmetry partners for 1hpv showing 6-1 screw axis]]
 +
[[File:SuperSymExample2.png|300px|thumb|right|Full cell of symmetry partners with symmetry axes displayed]]
 +
SuperSym is a PyMOL plugin providing a large number of tools for visualization of space groups; unit cells; and symmetry axes, operators, and partners.
  
−
This plugin has only been tested for PyMOL version 1.2b6pre and 1.2r1.
+
The original source code is available from https://sourceforge.net/projects/supersym/
  
−
Pre-v1.0 PyMOL may not display objects created by this plugin properly, even if the pse file displays normally in other versions. Use at your own risk.
+
== Dependencies ==
  
−
SuperSym has failed to load properly in OSX 10.6 (Snow Leopard), but functions normally in OSX 10.5. Bug fixing is underway.
+
* [[CCTBX|cctbx]]
 +
* numpy
  
−
This plugin requires cctbx and numeric python.
+
'''PyMOL, cctbx and numpy must all be compiled with the same Python distribution!'''
 +
See [[CCTBX]].
 +
 
 +
This plugin was developed in 2010 for PyMOL version 1.2r1 and has not been updated since.
 +
 
 +
== Bugs ==
 +
 
 +
Symmetry axes are not defined for all space groups, and do not display properly for some.
 +
 
 +
== Acknowledgments ==
 +
 
 +
Primary coding and development was done by Stuart Ballard. All comments, questions, and issues should be directed to him at srballard@wisc.edu.
  
 
Code for unit cell and symmetry axis building is borrowed from scripts created by Robert Campbell and Ralf W. Grosse-Kunstleve, available at [http://pldserver1.biochem.queensu.ca/~rlc/work/pymol/ http://pldserver1.biochem.queensu.ca/~rlc/work/pymol/]. Some of this code has been modified for use in SuperSym.
 
Code for unit cell and symmetry axis building is borrowed from scripts created by Robert Campbell and Ralf W. Grosse-Kunstleve, available at [http://pldserver1.biochem.queensu.ca/~rlc/work/pymol/ http://pldserver1.biochem.queensu.ca/~rlc/work/pymol/]. Some of this code has been modified for use in SuperSym.
Line 17: Line 36:
 
==Installing SuperSym==
 
==Installing SuperSym==
  
−
To install SuperSym, first copy the text of source files to corresponding .py files or download them from SourceForge. Place SuperSymMenu.py in pymol/modules/pmg_tk/startup, and all other files in pymol/modules. This will make all of SuperSym's functions available through a drop-down menu in the PyMOL GUI
+
To install SuperSym v1.2, download SuperSymPlugin12.py from [https://sourceforge.net/projects/supersym/ https://sourceforge.net/projects/supersym/]. In PyMOL, go to:
 +
*Plugin > Manage Plugins > Install...
 +
A file selector dialog will appear. Select SuperSymPlugin12.py. PyMOL will direct you to restart, and upon doing so SuperSym will be accessible through the Plugin menu.
 +
 
 +
To use functions of SuperSym directly, without creating a drop-down menu, use the run command in PyMOL on SuperSymPlugin12.py.
 +
 
 +
Note: previous errors resulting from incorrect naming of the plugin file have been resolved in v1.2.
  
−
To use functions of SuperSym directly, without creating a drop-down menu, ignore SuperSymMenu.py and use the run command on the other files in PyMOL as you would for any other script.
+
==Feedback==
  
−
==Using SuperSym==
+
Please post any comments, complaints, bug fix requests, useful tricks, or cool adaptations of SuperSym here.
  
−
The SuperSym dropdown menu on the PyMOL GUI provides the following options:
+
==The Menu==
−
*Default Symmetry Partner Set
+
*'''Default Symmetry Partner Set'''
−
*Draw Unit Cell
+
** See '''Build Symmetry Partners > Cell [0,0,0] (default)'''
−
*Build Symmetry Partners >
+
*'''Draw Unit Cell'''
−
**Cell [0,0,0] (default)
+
**Creates a cgo object with unit cell axes as cylinders. This functions similarly to ''show cell'', but the cell axes are cylinders instead of lines, allowing for printing.
−
**Cell [x,y,z] (custom)
+
*'''Build Symmetry Partners >'''
−
**2x2x2 Block
+
**All options in this submenu generate sets of symmetry partners
−
**3x3x3 Block
+
**'''Cell [0,0,0] (default)'''
−
*Coloring >
+
***Generates a suite of symmetry partners for a given object for the default unit cell, which is lattice position [0,0,0]
−
**Default Rainbow
+
**'''Cell [x,y,z] (custom)'''
−
**Select color for each operation
+
***Generates a suite of symmetry partners for a given object for a lattice position which you specify
−
**Select one color for custom set of operations
+
**'''2x2x2 Block'''
−
*Graphics >
+
***Generates 8 sets of symmetry partners for a given object, filling lattice positions [0,0,0] through [1,1,1]
−
**Lines
+
**'''3x3x3 Block'''
−
**Ribbon
+
***Generates 27 sets of symmetry partners for a given object, filling lattice positions [-1,-1,-1] through [1,1,1]. This option may take a long time to execute
−
**Sphere Surface (best for printing)
+
**'''By Partner'''
−
**Surface (high load render)
+
***Generates only those symmetry partners which the user specifies by their defining symmetry operators
−
*Symmetry Axes >
+
*'''Coloring >'''
−
**Build Axes
+
**'''Default Rainbow'''
−
*Move symmetry partners
+
***Colors all symmetry objects with a specified by their symmetry operations automatically
−
*About
+
**'''Select color for each operation'''
−
*Help
+
***Select symmetry partners to color by their defining symmetry operation and select the color for each
 +
**'''Select one color for custom set of operations'''
 +
***Select a set of symmetry partners defined by symmetry operations and select one color for all of them
 +
*'''Graphics >'''
 +
**'''Lines'''
 +
***Convenience function to display symmetry partners as lines
 +
**'''Ribbon'''
 +
**Convenience function to display symmetry partners as ribbons
 +
**'''Cartoon'''
 +
***Convenience function to display symmetry partners as cartoons
 +
**'''Sphere Surface (best for printing)'''
 +
***Uses the findSurfaceResidues function and shows surface residues as spheres. If printing, this option saves at least 60% of materials relative to regular surfaces, with minimal loss in resolution
 +
**'''Surface (high load render)'''
 +
***Displays symmetry partners as surfaces. This option may take a very long time to execute
 +
*'''Symmetry Axes >'''
 +
**'''Build Axes'''
 +
***Builds all symmetry axes for the given object. This functionality will be customizable and extended in future versions
 +
*'''Move symmetry partners'''
 +
**Merely displays instructions for using built in hotkeys to move symmetry partners
 +
*'''About'''
 +
**Developer info
 +
*'''Help'''
 +
**Reference to this page
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Script_Library]]
 
[[Category:Script_Library]]
 
[[Category:Math_Scripts]]
 
[[Category:Math_Scripts]]

Latest revision as of 16:19, 20 July 2020

Type PyMOL Plugin
Download plugins/SuperSymPlugin.py
Author(s) Stuart Ballard
License
This code has been put under version control in the project Pymol-script-repo
Symmetry partners for 1hpv showing 6-1 screw axis
Full cell of symmetry partners with symmetry axes displayed

SuperSym is a PyMOL plugin providing a large number of tools for visualization of space groups; unit cells; and symmetry axes, operators, and partners.

The original source code is available from https://sourceforge.net/projects/supersym/

Dependencies

PyMOL, cctbx and numpy must all be compiled with the same Python distribution! See CCTBX.

This plugin was developed in 2010 for PyMOL version 1.2r1 and has not been updated since.

Bugs

Symmetry axes are not defined for all space groups, and do not display properly for some.

Acknowledgments

Primary coding and development was done by Stuart Ballard. All comments, questions, and issues should be directed to him at srballard@wisc.edu.

Code for unit cell and symmetry axis building is borrowed from scripts created by Robert Campbell and Ralf W. Grosse-Kunstleve, available at http://pldserver1.biochem.queensu.ca/~rlc/work/pymol/. Some of this code has been modified for use in SuperSym.

FindSurfaceResidues is utilized for some of SuperSym's graphics generation, with some modifications.

Installing SuperSym

To install SuperSym v1.2, download SuperSymPlugin12.py from https://sourceforge.net/projects/supersym/. In PyMOL, go to:

  • Plugin > Manage Plugins > Install...

A file selector dialog will appear. Select SuperSymPlugin12.py. PyMOL will direct you to restart, and upon doing so SuperSym will be accessible through the Plugin menu.

To use functions of SuperSym directly, without creating a drop-down menu, use the run command in PyMOL on SuperSymPlugin12.py.

Note: previous errors resulting from incorrect naming of the plugin file have been resolved in v1.2.

Feedback

Please post any comments, complaints, bug fix requests, useful tricks, or cool adaptations of SuperSym here.

The Menu

  • Default Symmetry Partner Set
    • See Build Symmetry Partners > Cell [0,0,0] (default)
  • Draw Unit Cell
    • Creates a cgo object with unit cell axes as cylinders. This functions similarly to show cell, but the cell axes are cylinders instead of lines, allowing for printing.
  • Build Symmetry Partners >
    • All options in this submenu generate sets of symmetry partners
    • Cell [0,0,0] (default)
      • Generates a suite of symmetry partners for a given object for the default unit cell, which is lattice position [0,0,0]
    • Cell [x,y,z] (custom)
      • Generates a suite of symmetry partners for a given object for a lattice position which you specify
    • 2x2x2 Block
      • Generates 8 sets of symmetry partners for a given object, filling lattice positions [0,0,0] through [1,1,1]
    • 3x3x3 Block
      • Generates 27 sets of symmetry partners for a given object, filling lattice positions [-1,-1,-1] through [1,1,1]. This option may take a long time to execute
    • By Partner
      • Generates only those symmetry partners which the user specifies by their defining symmetry operators
  • Coloring >
    • Default Rainbow
      • Colors all symmetry objects with a specified by their symmetry operations automatically
    • Select color for each operation
      • Select symmetry partners to color by their defining symmetry operation and select the color for each
    • Select one color for custom set of operations
      • Select a set of symmetry partners defined by symmetry operations and select one color for all of them
  • Graphics >
    • Lines
      • Convenience function to display symmetry partners as lines
    • Ribbon
    • Convenience function to display symmetry partners as ribbons
    • Cartoon
      • Convenience function to display symmetry partners as cartoons
    • Sphere Surface (best for printing)
      • Uses the findSurfaceResidues function and shows surface residues as spheres. If printing, this option saves at least 60% of materials relative to regular surfaces, with minimal loss in resolution
    • Surface (high load render)
      • Displays symmetry partners as surfaces. This option may take a very long time to execute
  • Symmetry Axes >
    • Build Axes
      • Builds all symmetry axes for the given object. This functionality will be customizable and extended in future versions
  • Move symmetry partners
    • Merely displays instructions for using built in hotkeys to move symmetry partners
  • About
    • Developer info
  • Help
    • Reference to this page
Retrieved from "http://wiki.pymol.org/index.php?title=SuperSym&oldid=14771"