ChimeraX Programming Manual

This manual covers programming APIs for the ChimeraX Core, tools and libraries. They are implemented in Python with routines that need to run fast implemented in C++. This code is free for non-commercial use, see the license for details.

User documentation for the ChimeraX application is in the User’s Manual.

  • Python Classes
  • Atom - a molecule atom
  • AtomicStructure - molecular data
  • Atoms - a collection of atoms
  • Bond - a molecule bond
  • Camera - position the scene is rendered from
  • Chain - a polymer chain
  • Command - user command
  • Drawing - 3-d graphical object
  • Grid_Data - density map data
  • Lighting - lighting paramters
  • Log - text command log
  • Material - material reflectivity parameters
  • Model - Displayed data with id number
  • MolecularSurface - molecular surfaces
  • Place - position and orientation in space
  • Residue - a molecule residue
  • Session - application state
  • Settings - save tool preferences
  • ToolInfo - information about an available tool
  • ToolInstance - running tools
  • Toolshed - manages tool updates
  • TriggerSet - event notifications
  • View - graphics window
  • Volume - density map

API Status

Supported API

Items marked as Supported API are guaranteed to continue to work in subsequent ChimeraX releases with the same major version number.

Experimental API

Items marked as Experimental API are likely to be added as Supported API in the future but the exact arguments, return values, and even functionality may still change.

Indices and Tables


Non-Commercial Software License Agreement

Copyright 2016-2018 Regents of the University of California. All rights reserved. This software provided pursuant to a license agreement containing restrictions on its disclosure, duplication and use. For details see: This notice must be embedded in or attached to all copies, including partial copies, of the software or any revisions or derivations thereof.