<< All versions

Skill v1.0.0

currentAutomated scan100/100
openscientist-io/openscientist/phenix-tools-reference
──Details
PublishedOctober 28, 2026 at 06:24 AM
Content Hashsha256:5015ecb6cd5dff1e...
Git SHA34e5b911f2b4
──Files
Files (1 file, 9.1 KB)
SKILL.md9.1 KBactive
SKILL.md · 197 lines · 9.1 KB

name: phenix-tools-reference description: Reference of available Phenix commands for structural biology analysis category: domain metadata: version: "1.0.0"


Phenix Tools Reference

If Phenix is available, prefer run_phenix_tool over execute_code for structural biology tasks like validation, superposition, refinement, and map analysis. Phenix is the gold standard for these tasks.

Call run_phenix_tool(tool_name="phenix.<command>", input_files=["file.pdb"], description="..."). This reference lists the most useful commands grouped by task. Most commands accept PDB or mmCIF files, but some take map files, reflection data, sequences, or other formats — check each tool's --help if you are unsure.

Validation and Quality Assessment

CommandPurpose
phenix.molprobityComprehensive validation: Ramachandran, rotamers, clashes, C-beta deviations; the single best overall quality check
phenix.clashscoreAll-atom steric clash analysis
phenix.ramalyzeRamachandran backbone analysis
phenix.rotalyzeSide-chain rotamer analysis
phenix.cablamC-alpha based backbone validation
phenix.cbetadevC-beta deviation analysis
phenix.omegalyzeCis/trans peptide bond validation
phenix.model_vs_dataModel versus diffraction data statistics
phenix.model_statisticsSummary geometry statistics for a model
phenix.emringerMap-model validation for cryo-EM structures
phenix.validation_cryoemComprehensive cryo-EM validation
phenix.undowser_validationCheck waters for clashes and poor contacts
phenix.clashscore2Updated all-atom clash score (prefer over clashscore when available; slightly different scoring)
phenix.undowser2_validationUpdated water validation (same relationship to undowser_validation as above)
phenix.holton_geometry_validationHolton-method geometry validation — complementary signal to molprobity; useful for second-opinion checks

Example: Full validation

python
run_phenix_tool(
tool_name="phenix.molprobity",
input_files=["structure.pdb"],
description="Comprehensive structure quality check",
)

Structure Comparison and Superposition

CommandPurpose
phenix.superpose_pdbsSuperpose two structures and report RMSD
phenix.chain_comparisonChain-level comparison between structures
phenix.structure_comparisonBroader structural comparison
phenix.model_model_distancesPer-residue distance between two models
phenix.superpose_and_morphSuperpose and morph one structure onto another
phenix.superpose_modelsSuperpose with optional morphing and trimming (more flexible variant of superpose_and_morph)
phenix.find_referenceFind reference models (e.g., homologs in the PDB) for a supplied model

Example: Per-residue distances

python
run_phenix_tool(
tool_name="phenix.model_model_distances",
input_files=["experimental.pdb", "predicted.pdb"],
description="Per-residue distances between experimental and predicted",
)

AlphaFold and Predicted Models

CommandPurpose
phenix.process_predicted_modelProcess AlphaFold or predicted structures
phenix.dock_predicted_modelDock a predicted model into a cryo-EM map

Example: Process AlphaFold model

python
run_phenix_tool(
tool_name="phenix.process_predicted_model",
input_files=["alphafold_model.pdb"],
arguments={"pae_json_file_name": "alphafold_pae.json"},
description="Process AlphaFold model and trim low-confidence regions",
)

Refinement

CommandPurpose
phenix.refineReciprocal-space refinement against diffraction data
phenix.real_space_refineReal-space refinement, primarily for cryo-EM
phenix.geometry_minimizationEnergy minimization without data
phenix.dynamicsMolecular dynamics refinement
phenix.fit_hFit hydrogen positions with rotational DOF into a map (use after phenix.reduce when H positions matter for interpretation)
phenix.rocketWrapper for ROCKET refinement (external tool — see rocket-9.gitbook.io for docs)
phenix.aquarefQuantum-mechanical (QM) refinement via qr.refine — specialized; only use when QM restraints are specifically required
phenix.mopacSemiempirical QM refinement via MOPAC — specialized. Prefer phenix.refine (X-ray) or phenix.real_space_refine (cryo-EM) unless the task explicitly asks for QM
phenix.magrefMagnetic / spin-dependent refinement — specialized; only for data with magnetic scattering
phenix.TAAM_minus_IAMDifference between Transferable Aspherical Atom Model and Independent Atom Model refinements — specialized, for ultra-high-resolution data only

Refinement commands are compute-intensive and may approach the 5-minute timeout. Use targeted refinement when possible. The last four rows above are narrow-use — do not invoke unless the task explicitly calls for QM/magnetic/aspherical refinement.

Map Operations

CommandPurpose
phenix.mapsCompute electron density map coefficients
phenix.map_boxExtract map region around a model
phenix.map_model_ccMap-model correlation coefficient
phenix.map_correlationsCorrelation between two maps, or map vs model (use when comparing maps to each other — map_model_cc is map-vs-model only)
phenix.map_sharpeningMap sharpening via scale-factor optimization (newer, more flexible than auto_sharpen; supports half-maps and model-guided modes)
phenix.reduce_cryoem_resolutionArtificially limit cryo-EM half-maps to a target resolution (for testing resolution dependence)
phenix.mtriageCryo-EM map analysis
phenix.local_resolutionLocal resolution estimation
phenix.auto_sharpenMap sharpening
phenix.map_to_modelBuild atomic model from a cryo-EM map
phenix.dock_in_mapDock a model into a map
phenix.segment_and_split_mapSegment map into domains

Model Building and Manipulation

CommandPurpose
phenix.autobuildAutomated model building into density
phenix.fit_loopsFit or rebuild loop regions
phenix.pdbtoolsPDB manipulation, including selections and B-factor edits
phenix.reduceAdd hydrogens to a structure
phenix.ready_setAdd hydrogens and generate ligand restraints
phenix.find_helices_strandsIdentify secondary structure elements
phenix.analyze_alt_confAnalyze alternate conformations in a model; can compare against another model
phenix.create_alt_confGenerate alternate conformations from a single-conformation starting model and data
phenix.merge_models_as_alt_confCombine several models with identical hierarchies into one multi-conformer model

Example: Extract a single chain

python
run_phenix_tool(
tool_name="phenix.pdbtools",
input_files=["multimer.pdb"],
arguments={"selection": '"chain A"', "output.file_name": "chain_A.pdb"},
description="Extract chain A from multimer",
)

Ligand Tools

CommandPurpose
phenix.elbowGenerate ligand geometry and restraints
phenix.ligandfitFit a ligand into electron density
phenix.ligand_identificationIdentify unknown ligand density
phenix.find_all_ligandsFind all ligand binding sites

Data Analysis

CommandPurpose
phenix.xtriageDiffraction data analysis
phenix.merging_statisticsData merging statistics
phenix.french_wilsonFrench-Wilson scaling
phenix.cif_as_mtz / phenix.mtz_as_cifReflection file format conversion
phenix.pdb_as_cif / phenix.cif_as_pdbModel file format conversion

Molecular Replacement

CommandPurpose
phenix.phaserMolecular replacement
phenix.ensemblerPrepare search ensembles for molecular replacement
phenix.sculptorEdit search models for molecular replacement
phenix.mr_model_preparationPrepare molecular replacement search models

Sequence and Annotation

CommandPurpose
phenix.print_sequenceExtract sequence from PDB
phenix.assign_sequenceAssign a sequence to a model using a map and sequence file
phenix.fetch_pdbDownload PDB entries by ID

Useful Utilities

CommandPurpose
phenix.b_factor_statisticsB-factor distribution analysis
phenix.find_ncsDetect non-crystallographic symmetry
phenix.hbondHydrogen bond analysis
phenix.table_oneGenerate publication-ready Table 1 statistics

Tips for Using run_phenix_tool

  1. Start with phenix.molprobity for a quick quality overview.
  2. Input files are relative to data/.
  3. Pass CLI arguments as arguments={"flag": "value"}.
  4. Avoid large refinement jobs that are likely to hit the 5-minute timeout.
  5. Check phenix.pdbtools before writing custom PDB manipulation code.
  6. Use phenix.pdb_as_cif or phenix.cif_as_pdb for format conversion.
All versions