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
- Connect to anything: Because Claude is the bridge, it can pull in data from online databases (UniProt, PDB, OPM), literature, protein language model annotations, or local analysis scripts and map them directly onto your structure
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+
1. Install claudemol
pip install claudemol
claudemol setup
This configures PyMOL to auto-load the socket plugin and saves your Python path to ~/.claudemol/config.json so future Claude Code sessions can find it automatically.
2. Install the Claude Code plugin
/plugin marketplace add ANaka/claudemol?path=claude-plugin
/plugin install claudemol-skills
This gives Claude the skills and hooks to work with PyMOL.
3. Start using it
Open Claude Code and say:
"Open PyMOL and load structure 1UBQ"
Claude will launch PyMOL, connect via socket, and load the structure.
Optional: Seamless permissions
By default, Claude asks for approval before running each command. To auto-approve PyMOL-related commands, add to your project's .claude/settings.json:
{
"permissions": {
"allow": [
"Bash(claudemol*)",
"Bash(*python*claudemol*)",
"Bash(pymol*)"
]
}
}
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 connects to an existing PyMOL if one is running, or launches a new instance.
Example Commands
- "Color the protein by secondary structure"
- "Show the binding site residues within 5A of the ligand as sticks"
- "Align these two structures and calculate RMSD"
- "Create a publication-quality figure with ray tracing"
- "Make a 360 degree 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
The plugin includes 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
How It Works
Connection Lifecycle
- On session start, a hook runs
claudemol statusto check if PyMOL is reachable - When you ask Claude to work with PyMOL, it uses
connect_or_launch()— connecting to an existing instance or starting a new one - Commands are sent as Python code over TCP and executed inside PyMOL via the socket plugin
- If the connection drops,
conn.execute()auto-reconnects (up to 3 attempts)
Venv Support
claudemol setup saves your Python interpreter path to ~/.claudemol/config.json. This means claudemol works even when installed in a project virtualenv — the SessionStart hook and skills read the config to find the right Python.
Troubleshooting
Connection Issues
- "Could not connect to PyMOL": Make sure PyMOL is running and the plugin is loaded
- Check listener status: Run
claude_statusin PyMOL's command line - Restart listener: Run
claude_stopthenclaude_startin PyMOL
Plugin Not Loading
- Run
claudemol setupto configure PyMOL - Check PyMOL's output for any error messages on startup
claudemol Not Found
If Claude reports ModuleNotFoundError, claudemol may be installed in a venv that isn't active. Fix:
# Re-run setup from the venv that has claudemol
.venv/bin/claudemol setup
This updates ~/.claudemol/config.json so future sessions find it.
First-Time Setup Help
Run /pymol-setup in Claude Code for guided setup assistance.
Configuration
The default socket port is 9880. Both the plugin and connection module use this port.
Key files:
~/.pymolrc- PyMOL startup script (loads the socket plugin)~/.claudemol/config.json- Persisted Python path for venv discoverysrc/claudemol/plugin.py- Socket listener plugin (runs inside PyMOL)src/claudemol/connection.py- Python module for socket communication
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file claudemol-0.4.0.tar.gz.
File metadata
- Download URL: claudemol-0.4.0.tar.gz
- Upload date:
- Size: 14.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5134fe3e08018e3f90f3abda1d400abddb44b030a4714c6eba99e5355c95a1a2
|
|
| MD5 |
b3fd7ad480997f7663c31292c1453c7e
|
|
| BLAKE2b-256 |
8775ce7f9bc4b6d3dbc9203a07cd18dbe6e50ac7b7406f61403bd0d36fce8129
|
File details
Details for the file claudemol-0.4.0-py3-none-any.whl.
File metadata
- Download URL: claudemol-0.4.0-py3-none-any.whl
- Upload date:
- Size: 16.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f462e33cd1bc032646c5f03094205370e93977df0a262bbec082ac0d0211629
|
|
| MD5 |
86a41318a8df201bc3d3baac98e49489
|
|
| BLAKE2b-256 |
ac17656ad307f08f233383b788339304e5a507f6da4ca50f9531a0443a1b9e88
|