Skip to main content

PyMOL integration for Claude Code - control molecular visualization via natural language

Project description

claudemol: Control PyMOL with Claude Code

Control PyMOL through natural language using Claude Code. This integration enables conversational structural biology, molecular visualization, and analysis.

Features

  • Natural language control: Tell Claude what you want to visualize and it executes PyMOL commands
  • Direct socket communication: Claude Code talks directly to PyMOL (no intermediary server)
  • Full PyMOL access: Manipulate representations, colors, views, perform measurements, alignments, and more
  • Skill-based workflows: Built-in skills for common tasks like binding site visualization and publication figures

Architecture

Claude Code → TCP Socket (port 9880) → PyMOL Plugin → cmd.* execution

Quick Start

Prerequisites

  • PyMOL installed on your system
  • Claude Code CLI installed
  • Python 3.10+

Installation

pip install claudemol
claudemol setup

This installs the package and configures PyMOL to auto-load the socket plugin.

Start Using It

Open Claude Code and say:

"Open PyMOL and load structure 1UBQ"

Claude will launch PyMOL (with the socket listener active) and load the structure.

Usage

Starting a Session

Simply ask Claude to open PyMOL or load a structure:

  • "Open PyMOL"
  • "Load PDB 4HHB and show as cartoon"
  • "Fetch 1UBQ from the PDB"

Claude will launch PyMOL if it's not already running.

Example Commands

  • "Color the protein by secondary structure"
  • "Show the binding site residues within 5Å of the ligand as sticks"
  • "Align these two structures and calculate RMSD"
  • "Create a publication-quality figure with ray tracing"
  • "Make a 360° rotation movie"

PyMOL Console Commands

Check or control the socket listener from PyMOL's command line:

claude_status   # Check if listener is running
claude_stop     # Stop the listener
claude_start    # Start the listener

Available Skills

Claude Code has built-in skills for common workflows:

  • pymol-fundamentals - Basic visualization, selections, coloring
  • protein-structure-basics - Secondary structure, B-factor, representations
  • binding-site-visualization - Protein-ligand interactions
  • structure-alignment-analysis - Comparing and aligning structures
  • antibody-visualization - CDR loops, epitopes, Fab structures
  • publication-figures - High-quality figure export
  • movie-creation - Animations and rotations

Troubleshooting

Connection Issues

  • "Could not connect to PyMOL": Make sure PyMOL is running and the plugin is loaded
  • Check listener status: Run claude_status in PyMOL's command line
  • Restart listener: Run claude_stop then claude_start in PyMOL

Plugin Not Loading

  • Run claudemol setup to configure PyMOL
  • Check PyMOL's output for any error messages on startup

First-Time Setup Help

Run the /pymol-setup skill in Claude Code for guided setup assistance.

Configuration

The default socket port is 9880. Both the plugin and Claude Code connection module use this port.

Key files:

  • src/claudemol/plugin.py - PyMOL plugin (auto-loads via pymolrc)
  • src/claudemol/connection.py - Python module for socket communication
  • claude-plugin/skills/ - Claude Code skills for PyMOL workflows

Limitations

  • PyMOL and Claude Code must run on the same machine (localhost connection)
  • One active connection at a time
  • Some complex multi-step operations may need guidance

Contributing

Contributions welcome! This project aims to build comprehensive skills for Claude-PyMOL interaction. If you discover useful patterns or workflows, consider adding them as skills.

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

claudemol-0.2.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

claudemol-0.2.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file claudemol-0.2.0.tar.gz.

File metadata

  • Download URL: claudemol-0.2.0.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for claudemol-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f603182f3db82843d91a6fea3d556f694ecfce4235e135ef351e08b737f396e3
MD5 257ee8ca6dc697f39f4cd62bf5e78775
BLAKE2b-256 46b3e5c18f3648abdc112ead735b6351155f4be824fd13ff680040188bc7c809

See more details on using hashes here.

File details

Details for the file claudemol-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: claudemol-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for claudemol-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5dcec52d89d21d518d478aaf906e7d6ae98a19ea376be257c914c2eee7409fcb
MD5 4074f6f81747c07234d9c31774d21165
BLAKE2b-256 cbefef2c3e3ff82a88cdb1182ea81b4dbe311e7b3f38c5ea7561db1aa44a32e2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page