Jump to content

Main Page

From PyMOL Wiki
hosted by
Welcome to the PyMOL Wiki!
The community-run support site for the PyMOL molecular viewer.
If you want to contribute new content to this wiki, request an account by emailing accounts (@) sbgrid dot org from your institutional email address.
Quick Links
Tutorials Table of Contents Commands
Script Library Plugins FAQ
Gallery | Covers PyMOL Cheat Sheet (PDF) Getting Help
News & Updates
New Setup PyMOL-open-source-windows-setup v3.1 has been released on January 20, 2025. More information under Windows Install.
New Plugin PySSA aims to combine PyMOL and ColabFold to enable the prediction and analysis of 3D protein structures for the scientific end-user. v1.0 has been released on July 10, 2024.
Official Release PyMOL v3.0 has been released on March 12, 2024.
New Plugin CavitOmiX calculate Catalophore™ cavities, predict protein structures with OpenFold by NVIDIA-BioNeMo, ESMFold and retrieve Alphafold models
Official Release PyMOL v2.5 has been released on May 10, 2021.
Python 3 New Python 3 compatibility guide for scripts and plugins
POSF New PyMOL fellowship announced for 2022-2023
Tutorial Plugins Tutorial updated for PyQt5
New Plugin PICv is a new plugin for clustering protein-protein interactions and visualization with available data from PDBe
Selection keywords New polymer.protein and polymer.nucleic selection keywords. Thanks everyone who participated in the poll!
Plugin Update MOLE 2.5 is an updated version of channel analysis software in PyMOL
New Script dssr_block is a wrapper for DSSR (3dna) and creates block-shaped nucleic acid cartoons
Older News See Older News.
Did you know...
Type Python Script
Download check_key.py
Author(s) Sean M. Law
License -
This code has been put under version control in the project Pymol-script-repo

DESCRIPTION

A simple script used to check if a given key is valid for for the Set Key command. This is useful when the user would like to use a keyboard key as shortcut/hotkey in their script but need to check if the key is a valid one.

USAGE

load the script using the run command

check_key (keystroke)

If the key specified is a valid one as defined in Set Key then it returns the value of the keystroke. Otherwise, it returns None.

For an example that calls this script, see Jump.

PyMOL API

<source lang="python"> from pymol import cmd import re

allowed_keys=re.compile('(F1|F2|left|right|pgup|pgdn|home|insert|(CTRL-[A-Z])|ALT-[A-Z0-9])')

def check_key (keystroke):

   """
   Author Sean M. Law
   University of Michigan
   seanlaw_(at)_umich_dot_edu
   """
   keystroke=keystroke.strip('\"\)
   out=allowed_keys.search(keystroke)
..→
A Random PyMOL-generated Cover. See Covers.