RMSF Analysis: Quick Start
Run RMSF (Root Mean Square Fluctuation) in minutes and compare flexibility across conditions.
Note
Need field-by-field settings, output schemas, plot options, or troubleshooting? Use RMSF Plugin Reference.
Environment Setup
All commands below assume you have activated the PolyzyMD pixi environment:
pixi shell -e build
Alternatively, prefix each command with pixi run -e build.
TL;DR
# Run RMSF for conditions in comparison.yaml
polyzymd compare run rmsf -f comparison.yaml --eq-time 10ns
# Run all enabled analyses
polyzymd compare run-all -f comparison.yaml --eq-time 10ns
# Force recompute and write machine-readable output
polyzymd compare run rmsf -f comparison.yaml --eq-time 10ns --recompute --format json
Prerequisites
Before you run RMSF, confirm you have:
Completed production trajectories for at least one replicate
A
comparison.yamlwith one or more conditionsThe original simulation
config.yamlpaths still valid
Quick check:
ls $(polyzymd info -c config.yaml --scratch-dir)/production_*/
What RMSF gives you
RMSF reports per-residue flexibility plus condition-level summary statistics.
Output |
Use |
|---|---|
Mean RMSF ± SEM |
Compare overall flexibility between conditions |
Per-residue RMSF profile |
Find flexible loops and rigid core regions |
Pairwise statistics |
Quantify condition differences |
Ranking |
Order conditions by stability (lower RMSF first) |
Set up comparison.yaml
Use plugins.rmsf for RMSF-specific controls.
# comparison.yaml
name: "rmsf_quickstart"
control: "No Polymer"
conditions:
- label: "No Polymer"
config: "configs/no_polymer.yaml"
replicates: [1, 2, 3]
- label: "With Polymer"
config: "configs/with_polymer.yaml"
replicates: [1, 2, 3]
defaults:
equilibration_time: "10ns"
plugins:
rmsf:
selection: "protein and name CA"
reference_mode: "centroid"
Run RMSF
# RMSF only
polyzymd compare run rmsf -f comparison.yaml --eq-time 10ns
# RMSF + all other enabled plugins
polyzymd compare run-all -f comparison.yaml --eq-time 10ns
# Generate plots in the same run
polyzymd compare run-all -f comparison.yaml --eq-time 10ns --plot
Compare conditions
By default, compare run rmsf produces:
Condition means with SEM
Pairwise tests and effect sizes
Ranking (lowest RMSF = most stable)
Example:
polyzymd compare run rmsf -f comparison.yaml --format table
For broader multi-plugin workflows, see How to Compare Simulation Conditions.
Comparing Two Conditions
Use this minimal two-condition template:
name: "polymer_stabilization"
control: "No Polymer"
conditions:
- label: "No Polymer"
config: "../no_polymer/config.yaml"
replicates: [1, 2, 3]
- label: "With Polymer"
config: "../with_polymer/config.yaml"
replicates: [1, 2, 3]
plugins:
rmsf:
selection: "protein and name CA"
reference_mode: "centroid"
Then run:
polyzymd compare run rmsf -f comparison.yaml --eq-time 10ns
Common task patterns
Change equilibration cutoff
polyzymd compare run rmsf -f comparison.yaml --eq-time 100ns
Restrict analysis to a region
plugins:
rmsf:
selection: "protein and name CA and resid 50-150"
Trim flexible termini
plugins:
rmsf:
selection: "protein and name CA and resid 5:175"
Use an external reference structure
plugins:
rmsf:
selection: "protein and name CA"
reference_mode: "external"
reference_file: "/path/to/crystal_structure.pdb"
Re-run from scratch
polyzymd compare run rmsf -f comparison.yaml --eq-time 10ns --recompute
Save results for scripting
polyzymd compare run rmsf -f comparison.yaml --format json -o rmsf_result.json
Python API (programmatic run)
from polyzymd.analyses.discovery import get_analysis
from polyzymd.analyses.orchestrator import run_comparison
from polyzymd.config.comparison import ComparisonConfig
config = ComparisonConfig.from_yaml("comparison.yaml")
analysis = get_analysis("rmsf")()
pipeline_result = run_comparison(
analysis,
config,
equilibration="10ns",
)
result = pipeline_result["comparison"]
print(result.ranking)
print(pipeline_result["comparison_path"])
Where to find details
Full settings tables: RMSF Plugin Reference
Output file tree and JSON schemas: RMSF Plugin Reference
Plot types and plot settings: RMSF Plugin Reference
CLI options and troubleshooting: RMSF Plugin Reference
Statistical interpretation: RMSF Analysis: Statistical Best Practices
Reference mode guidance: How RMSF reference selection changes interpretation
Next steps
Compare multiple plugins together: How to Compare Simulation Conditions
Run RMSD alongside RMSF: RMSD Analysis: Quick Start
Add distance checks: Distance Analysis: Quick Start