Workflows¶
1. First-Time Use¶
Use this if you are starting from scratch.
- Open the relevant models in ChimeraX.
- Run:
circoscontacts
- In the browser:
- set
Contact modetoResiduefor ensemble recurrence - raise the threshold until noisy links disappear
- reorder or hide chains if needed
- Export:
Save Sessionfor later editingDownload SVGfor figures
2. Ensemble Summary With DNA Merge¶
Use this when protein contacts to dsDNA are the main target.
- Open the full model set.
- Run:
circoscontacts title "Protein–DNA ensemble contacts"
- Confirm the DNA arc is merged as expected.
- Switch between:
Atommode for dense contact detailResiduemode for per-model recurrence- Use thresholding to find persistent contacts.
3. Restrict Contacts To A Source Window¶
Use the plugin the way you would use ChimeraX contacts with a source and a target.
Example:
circoscontacts #1,2/S,T:100-120 restrict /S,T,C interModel false intramol false
Recommended follow-up in the HTML:
- inspect active masked arc regions to confirm the input window,
- use shift-click residue isolation to inspect specific sites,
- use
Contacts @ thresholdin the selection menu to copy back only the currently supported contacts.
4. Match Arc Colors To Structure Colors¶
If your ChimeraX ribbons are already colored meaningfully:
- color ribbons in ChimeraX first
- run
circoscontacts - in the HTML, uncheck
Default colors
The arcs will switch to the captured ChimeraX ribbon colors.
This is useful when you want the circos arc colors to match the structure view.
5. Build An Annotated Figure¶
- Choose final threshold and contact mode.
- Set chain order and optional bottom lock.
- Add selections for motifs or domains.
- Create sequence or comment callouts.
- Adjust callout placement and size.
- Export SVG.
Recommended discipline:
Save Sessionbefore major annotation changesSave HTMLonce the figure state is stable
6. Send Selections Back To ChimeraX¶
There are two useful routes.
From a clicked link¶
Click a visible contact arc.
This copies a ChimeraX select command for the actual contributing residues.
From a selected region¶
Use the selection popup:
All models: select the whole region across all modelsContacts @ threshold: select only the residues supporting visible contacts at the current threshold
This is useful for jumping back from the circos view to structural inspection.
7. Recolor Structures To Match The Plot¶
After tuning the visible links in the HTML:
- click
ChimeraX Colors - in ChimeraX, run:
open /path/to/contacts_circos_colors.cxc
This recolors residues corresponding to the currently visible links.
8. Preserve Provenance¶
When you need the output to remain self-describing:
- use
Save HTML - use the
Infopopup to verify the embedded metadata
Stored provenance includes:
- version
- timestamp
- invocation
- model names
- file names / paths when available