Skip to content

aysebercin/DynaPIN

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

67 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DynaPIN: Analysis of Dynamic Protein INterfaces

Version Python License Platform

DynaPIN is a powerful and flexible analysis pipeline designed for Molecular Dynamics (MD) simulations. It specializes in dissecting protein-protein interactions, assessing structural stability, calculating energetic contributions and intermolecular interactions at the residue level.

Whether you are running a quick quality check or a deep-dive interface analysis, DynaPIN streamlines the process from trajectory to visualization.

πŸš€ Key Features

DynaPIN performs analysis in three distinct yet integrated modules:

1. Quality Control

Assess the stability and reliability of your simulation.

  • Structural Metrics: Root Mean Square Deviation (RMSD), Radius of Gyration (RG), Root Mean Square Fluctuation (RMSF).
  • Interface Quality with CAPRI Metrics: Interface RMSD (iRMSD), Ligand RMSD (lRMSD), DockQ Score, Fraction of Native (Fnat) and Non-Native (Fnonnat) contacts.

2. Residue Based Analysis

Characterize the physicochemical evolution of interface residues.

  • Dynamic Classification: Categorizes residues as Core, Rim, Support, Surface, or Interior based on the Levy (2010) model.
  • Surface Analysis: Relative and Absolute Solvent Accessible Surface Area of complex and monomers (rASA/SASA).
  • Energetics: Decomposition of binding energy (Van der Waals, Electrostatic) per residue using FoldX.
  • Secondary Structure: Dynamic monitoring of structural changes at interface.

3. Interaction Based Analysis

Map the specific atomic interaction networks over time.

  • Bond Tracking: Detects Hydrogen bonds, Hydrophobic interactions, and Salt bridges (Ionic bonds).

πŸ— System Architecture

DynaPIN is built on an object-oriented and modular Python architecture, integrating powerful libraries such as MDAnalysis and pdb-tools for trajectory handling, DockQ for interface quality assessment, FreeSASA for accessible surface area calculations, FoldX for energy analysis, DSSP for secondary structure tracking, and interfacea for interaction profiling. Results are automatically organized into tabular data (.csv) and visual plots (.png).

DynaPIN Architecture

πŸ’» System Requirements

Before installing DynaPIN, please ensure you have the following:

  • Operating System: Linux and macOS.
    • Note for Windows Users: It is recommended to use WSL (Windows Subsystem for Linux) for the best compatibility with DynaPIN.
  • Package Manager: Anaconda or Miniconda is required to manage the environment.
  • Version Control: Git is recommended for cloning the repository.
  • Python: The package supports Python 3.10 and higher.

πŸ›  External Dependencies (Optional but Recommended)

The dynapin Conda environment automatically installs all core libraries. However, the energy calculation module relies on FoldX, which requires a separate, manual installation due to academic licensing restrictions.

How to use FoldX with DynaPIN:

  1. Download the FoldX executable from the FoldX Suite website.
  2. When executing DynaPIN, pass the path to this executable using the --foldx_path argument.

Note: FoldX is entirely optional. If you do not provide the --foldx_path argument, DynaPIN will still run perfectly, but it will automatically bypass the energy calculation module.

πŸ“¦ Installation

DynaPIN utilizes a unified Conda environment to manage Python dependencies and system binaries (including the custom C-extensions for interfacea).

1. Clone the Repository

git clone https://github.com/aysebercin/DynaPIN.git
cd DynaPIN

2. Create the Environment

This command installs all necessary dependencies

conda env create -f environment.yml
conda activate dynapin

DynaPIN is ready to use!

⚑ Quick Start

DynaPIN offers two primary ways to run analyses: via the Command Line Interface (CLI) for standard pipelines, or through the Python API for interactive exploration.

Option 1: Command Line Interface (CLI)

Run a complete analysis pipeline (Quality Control, ResidueBased, and InteractionBased modules) with a single command:

# Using a PDB trajectory
dynapin --output_dir=TestRun --trajectory_file=sim.pdb --commands=all_analysis,all_plots

# Using a DCD trajectory with topology
dynapin --output_dir=TestRun --trajectory_file=sim.dcd --topology_file=top.psf --stride=10 --foldx_path=/path/to/foldx --commands=all_analysis,all_plots

Key Arguments

Argument Description
-o, --output_dir Name of the output directory where results will be saved.
-t, --trajectory_file Path to the input trajectory (.dcd, .xtc, .trr, .pdb).
--topology_file Topology file (.psf, .pdb) required for .dcd inputs. Be sure that your topology file includes chain identifiers.
-c, --commands Modules to run (e.g., QualityControl, ResidueBased, all_analysis).
-s, --stride Step size for reading frames (default: 1).
-ch, --chains Select specific two chains for analysis in heteromers (e.g., 'A,B').
--threshold Threshold percentage for dynamic interface residues (default: 50).
--foldx_path Path to the FoldX executable (required for energy analysis).
-sm, --split_models Splits multi-model PDBs into separate frames (default: True).

Option 2: Interactive API Workflow

Beyond the command line, DynaPIN serves as a powerful Python library. We provide a comprehensive Jupyter Notebook that demonstrates this usage, allowing for inline 3D visualization and granular control over every analysis step.

  • Notebook: DynaPIN_API_workflow.ipynb
  • Use Case: Ideal for users who prefer an interactive environment (Jupyter/Lab) or wish to integrate DynaPIN into custom Python scripts.

To run the workflow interactively:

conda activate dynapin
jupyter notebook DynaPIN_API_Workflow.ipynb

πŸ“‚ Output Files

DynaPIN organizes the analysis outputs into a structured directory as shown below. Results are automatically organized into tables/ (CSV data) and figures/ (High-quality Plots). (Note: *.png indicates multiple plot files generated for different metrics)

output_dir/
β”‚
β”œβ”€β”€ figures/                         # Visualization Plots
β”‚   β”œβ”€β”€ int_pairwise_*.png           # Interaction frequency plots (H-bond, Hydrophobic, Ionic)
β”‚   β”œβ”€β”€ qc_*.png                     # Quality control plots (RMSD, RMSF, DockQ, Rg, etc.)
β”‚   └── res_*.png                    # Residue analysis plots (SASA, DSSP, FoldX, etc.)
β”‚
β”œβ”€β”€ tables/                          # Numerical Data (CSV)
β”‚   β”œβ”€β”€ int_pairwise_trajectory.csv  # Detailed list of atomic interactions per frame
β”‚   β”œβ”€β”€ qc_residue_rmsf.csv          # RMSF values per residue
β”‚   β”œβ”€β”€ qc_trajectory_metrics.csv    # Time-series data for global metrics (RMSD, Rg, DockQ)
β”‚   β”œβ”€β”€ res_interface_stats.csv      # Interface occupancy statistics (Core/Rim classification)
β”‚   └── res_trajectory_props.csv     # Residue-wise properties (Energy, SASA, Secondary Structure)
β”‚
β”œβ”€β”€ models.zip                       # Archive of extracted PDB frames used for analysis
β”œβ”€β”€ *_fixed_standardized.pdb         # Pre-processed structure files
β”œβ”€β”€ plot_params.json                 # Configuration used for generating plots
└── table_params.json                # Configuration used for calculations

❗The full datasets (input MD trajectories) and application examples (DynaPIN analysis outputs) for the test cases presented in our manuscript are openly available on Zenodo: DOI

This dataset includes:

  • Trajectory_Inputs/: Raw trajectory (.dcd) and topology (.pdb) files for the Rigid, Medium, and Difficult test cases.
  • DynaPIN_Outputs/: Full sets of outputs including tables, figures and intermediate datas generated by DynaPIN for these systems.

πŸ“ Citation

DynaPIN is currently under peer review. If you use DynaPIN in your research, please cite our upcoming paper:

@article{barlas_dynapin_2026,
  title={DynaPIN: A tool for characterizing dynamic protein interfaces},
  author={Barlas, Ayşe BerΓ§in and Γ–zsan, Atakan and PrΓ©vost, Chantal and Sacquin-Mora, Sophie and Karaca, Ezgi},
  journal={Under Review},
  year={2026}
}

πŸ“š Integrated Tools & References

DynaPIN seamlessly integrates several powerful structural analysis tools and methodologies to perform comprehensive interface profiling. If you use DynaPIN in your research, we highly encourage you to consider citing the underlying software and definitions that make this pipeline possible:

πŸ“œ Acknowledgements & Funding

This project is supported by TÜBİTAK (The Scientific and Technological Research Council of Türkiye) under the 2509 Bosphorus Türkiye-France Bilateral Cooperation Program (Project No: 122N790).

Developed by the Computational Structural Biology Lab (CSB) at Izmir Biomedicine and Genome Center (IBG).

πŸ“§ Contact

If you have any questions, feedback, or issues related to DynaPIN, please feel free to contact the project team:

About

An open-source analysis toolkit to characterize dynamic protein interfaces from MD trajectories.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors