ChimeraX Programming Manual

This manual covers programming APIs for ChimeraX. They are implemented in Python with routines that need to run fast implemented in C++.

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

Tutorials and Examples

• ChimeraX Developer Tutorial
• Command and Python recipes

Developer Guide

Bundle developers can optionally skip Compiling ChimeraX and Code Conventions. It is recommended that developers intending to contribute to ChimeraX read all sections.

• Setting Up a ChimeraX Development Environment
• Obtaining Code
• Compiling ChimeraX
• IDEs, Debugging, and Profiling
• Code Conventions
• Testing
• ChimeraX Startup
• Building and Distributing Bundles
• Intro to ChimeraX Design

API Reference

• Supported and Experimental APIs
• Python Modules
• Python Functions implementing User Commands
• Python Classes
• C++ Libraries
• Included third-party packages

Index

• Index

• Module Index

• Search Page

License

This code is free for non-commercial use, see the license for details.

Copyright 2016-2024 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: https://www.rbvi.ucsf.edu/chimerax/docs/licensing.html This notice must be embedded in or attached to all copies, including partial copies, of the software or any revisions or derivations thereof.