> ## Documentation Index
> Fetch the complete documentation index at: https://proto.evodesign.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Structure Ensemble RMSD

> Generate a conformational ensemble and compute RMSD against a target structure via PyMOL.

<div class="page-hero">
  <img class="page-hero-banner" src="https://proto-bio.github.io/proto-assets/images/constraint/structure-ensemble-rmsd/hero.png" alt="Structure Ensemble RMSD" />
</div>

<Note>
  **License:** This constraint can use multiple tools, each under its own license. See the **Tools Used** tab and each tool's page for license details.
</Note>

<p class="entity-disclaimer">This constraint is open source. Any third-party models, product names, or trademarks referenced are the property of their respective owners, and Proto is not affiliated with them.</p>

<hr class="entity-rule" />

<input type="radio" name="tab-constraint-structure-ensemble-rmsd" id="none-constraint-structure-ensemble-rmsd" class="tab-radio-input" />

<input type="radio" name="tab-constraint-structure-ensemble-rmsd" id="tools-constraint-structure-ensemble-rmsd" class="tab-radio-input" defaultChecked />

<input type="radio" name="tab-constraint-structure-ensemble-rmsd" id="source-constraint-structure-ensemble-rmsd" class="tab-radio-input" />

<div class="tool-tab-bar"><span class="tool-tab-wrap"><label for="tools-constraint-structure-ensemble-rmsd" class="tool-tab tab-open badge-tools"><svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect width="7" height="7" x="3" y="3" rx="1" /><rect width="7" height="7" x="14" y="3" rx="1" /><rect width="7" height="7" x="14" y="14" rx="1" /><rect width="7" height="7" x="3" y="14" rx="1" /></svg> Tools Used</label><label for="none-constraint-structure-ensemble-rmsd" class="tool-tab tab-close badge-tools"><svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect width="7" height="7" x="3" y="3" rx="1" /><rect width="7" height="7" x="14" y="3" rx="1" /><rect width="7" height="7" x="14" y="14" rx="1" /><rect width="7" height="7" x="3" y="14" rx="1" /></svg> Tools Used</label></span> <span class="tool-tab-wrap"><label for="source-constraint-structure-ensemble-rmsd" class="tool-tab tab-open badge-source"><svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="16 18 22 12 16 6" /><polyline points="8 6 2 12 8 18" /></svg> Source</label><label for="none-constraint-structure-ensemble-rmsd" class="tool-tab tab-close badge-source"><svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="16 18 22 12 16 6" /><polyline points="8 6 2 12 8 18" /></svg> Source</label></span></div>

<div class="tab-panel tools-panel" data-tab="tools-constraint-structure-ensemble-rmsd">
  <div class="tools-used-grid">
    <a href="/docs/tools/structure-dynamics/bioemu" class="tools-used-tile">
      <img noZoom src="https://proto-bio.github.io/proto-assets/images/tool/bioemu/social.png" alt="" loading="lazy" />
    </a>

    <a href="/docs/tools/structure-alignment/pymol-rmsd" class="tools-used-tile">
      <img noZoom src="https://proto-bio.github.io/proto-assets/images/tool/pymol_rmsd/social.png" alt="" loading="lazy" />
    </a>
  </div>
</div>

<a href="https://github.com/evo-design/proto-language/blob/d3b7822f74ea64747cc751a3b2ab1aa6b799ac47/proto_language/constraint/protein_structure/structure_ensemble_similarity_constraint.py#L412" target="_blank" class="tab-panel source-panel" data-tab="source-constraint-structure-ensemble-rmsd">
  <div class="source-info">
    <img noZoom src="https://github.com/evo-design.png?size=40" class="source-avatar" width="36" height="36" />

    <span class="source-path">evo-design/proto-language<span class="source-subpath">/proto\_language/constraint/protein\_structure/structure\_ensemble\_similarity\_constraint.py</span></span>
  </div>

  <span class="panel-goto-btn source-goto-btn"><span><svg width="14" height="14" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" /></svg> View source</span></span>
</a>

<div class="entity-contributors"><span class="entity-contributors-label">Constraint contributors</span><span class="entity-contributors-people"><a class="entity-contributor" href="https://github.com/dguo8412" target="_blank" rel="noopener" title="dguo8412: 3 commits"><img noZoom class="entity-contributor-avatar" src="https://avatars.githubusercontent.com/u/46211285?v=4&s=64" alt="" loading="lazy" /><span class="entity-contributor-login">dguo8412</span></a><a class="entity-contributor" href="https://github.com/brianhie" target="_blank" rel="noopener" title="brianhie: 1 commit"><img noZoom class="entity-contributor-avatar" src="https://avatars.githubusercontent.com/u/6365340?v=4&s=64" alt="" loading="lazy" /><span class="entity-contributor-login">brianhie</span></a><a class="entity-contributor" href="https://github.com/bviggiano" target="_blank" rel="noopener" title="bviggiano: 1 commit"><img noZoom class="entity-contributor-avatar" src="https://avatars.githubusercontent.com/u/21143637?v=4&s=64" alt="" loading="lazy" /><span class="entity-contributor-login">bviggiano</span></a></span></div>
Generate conformational ensembles and compute RMSD against an experimental.

target structure.

This constraint:

1. Prepares the target structure (extracting chain/residue range if specified).
2. For each proposal sequence, generate a conformational ensemble.
3. Computes PyMOL-aligned RMSD between each ensemble frame and the target.
4. Summarizes the RMSDs using the specified aggregation method.
5. Converts the summarized RMSD to a 0-1 score using a sigmoid function.

## API Reference

<div class="api-model-section api-model-static api-config-section">
  <div class="api-model-header"><span class="api-model-badge api-config-badge">Config</span><span class="api-model-name">StructureEnsembleSimilarityConfig</span><a href="https://github.com/evo-design/proto-language/blob/d3b7822f74ea64747cc751a3b2ab1aa6b799ac47/proto_language/constraint/protein_structure/structure_ensemble_similarity_constraint.py#L260" target="_blank" class="func-table-btn func-source-btn api-model-source"><svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="16 18 22 12 16 6" /><polyline points="8 6 2 12 8 18" /></svg> Source</a></div>

  Configuration for structure ensemble similarity constraints.

  This constraint generates a conformational ensemble for a proposal protein
  sequence and computes the RMSD between ensemble members and an experimental
  target structure using PyMOL alignment.

  <ParamField path="target_structure" type="Structure | string" required>
    Target structure: a Structure object, file path (.pdb/.cif), or raw PDB/CIF content string.
  </ParamField>

  <ParamField path="target_chain_id" type="string">
    Chain ID to extract from the target structure (e.g., 'A').
  </ParamField>

  <ParamField path="target_residue_range" type="array">
    Residue range (start, end) to extract from target (1-indexed, inclusive).
  </ParamField>

  <ParamField path="proposal_residue_range" type="array">
    Residue range (start, end) of the proposal sequence to use.
  </ParamField>

  <ParamField path="bioemu_config" type="BioEmuConfig">
    Dictionary of configuration parameters passed to the ensemble prediction tool.
  </ParamField>

  <ParamField path="rmsd_aggregation" type="enum" default="min">
    How to summarize ensemble RMSD values: min (best match), p10, mean, or median.

    Options: `min`, `p10`, `mean`, `median`
  </ParamField>

  <ParamField path="pymol_alignment_method" type="enum" default="align">
    PyMOL alignment routine for ensemble RMSD calculation.

    Options: `cealign`, `align`
  </ParamField>

  <ParamField path="inflection_point_angstroms" type="number" default="3.0">
    RMSD in Ångströms where the sigmoid score equals 0.5; values below 3 Å are generally a good match.
  </ParamField>

  <ParamField path="sigmoid_slope" type="number" default="3.0">
    Steepness of the penalty curve.
  </ParamField>

  <ParamField path="verbose" type="boolean" default="False">
    Whether to print progress messages.
  </ParamField>
</div>

<div class="api-model-section api-model-static api-output-section">
  <div class="api-model-header"><span class="api-model-badge api-output-badge">Returns</span><span class="api-model-name">ConstraintOutput</span></div>

  Per-proposal score in `[0, 1]` (0 is a perfect match)
  with ensemble RMSD summary/distribution metadata.
</div>

## Usage

```python python icon="python" theme={null}
from proto_language.core import Constraint
from proto_language.constraint import structure_ensemble_rmsd_constraint, StructureEnsembleSimilarityConfig

constraint = Constraint(
    inputs=[segment],
    function=structure_ensemble_rmsd_constraint,
    function_config=StructureEnsembleSimilarityConfig(
        # Configure parameters here
    ),
)

scores = constraint.evaluate()
```

## Metadata

| Property        | Value                                |
| --------------- | ------------------------------------ |
| Key             | `structure-ensemble-rmsd`            |
| Function        | `structure_ensemble_rmsd_constraint` |
| Category        | `protein_structure`                  |
| Mode            | `discrete`                           |
| Uses GPU        | `True`                               |
| Supported Types | `protein`                            |
