Skip to main content

Streamd Python module to facilitate molecular dynamics

Project description

StreaMD Logo

StreaMD: a tool to perform high-throughput automated molecular dynamics simulations

StreaMD provides an end-to-end molecular dynamics workflow that takes a PDB structure as input and automatically performs system preparation, equilibration, production and continuation runs, and analysis, producing XTC trajectories together with ready-to-use plots and CSV outputs.

Features:

  • Run multiple simultaneous molecular dynamics simulations

  • Run multiple replicas of the same system for multiple complexes in a single command

  • Simulation for different systems:

    • Protein in Water;
    • Protein - Ligand;
    • Protein - Cofactor (multiple);
    • Protein - Ligand - Cofactor (multiple);
  • Simulations of boron-containing molecules using Gaussian software

  • Simulations of ligand-binding metalloproteins with MCPB.py

  • Distributed computing using dask library

  • Running parallel simulations on multiple servers

  • Extending the time of MD simulations

  • Continuing interrupted MD simulations

  • Restarting interrupted MD preparation by invoking the same command

  • Implemented tools for end-state free energy calculations (gmx_MMPBSA) and protein–ligand interaction analysis (ProLIF)

  • Support for customized .mdp files

  • Interactive trajectory convergence analysis for multiple complexes

  • GPU support

Quick start

# Create environment (choose CPU-only or GPU)
conda env create --file env.yml -n md          # or env_gpu.yml on GPU-capable hosts
conda activate md

# Install
pip install streamd
# or latest main branch
pip install git+https://github.com/ci-lab-cz/streamd.git

Minimal protein-ligand run (1 ns)

run_md -p protein.pdb -l ligand.mol --md_time 1

Protein - multiple ligands multiple replicas runs (1 ns)

run_md -p protein.pdb -l ligands.sdf --md_time 1 --replicas 3 --seed 1024

Extend successfully finished simulations

run_md --wdir_to_continue md_files/md_run/protein_H_HIS_ligand_*/ --md_time 10

GPU-accelerated simulations

run_md -p protein_HIS.pdb -l ligand.mol --md_time 1 --device gpu --ncpu 32

MM-PBSA/MM-GBSA calculation support

run_gbsa --wdir_to_run md_files/md_run/protein_H_HIS_ligand_1 md_files/md_run/protein_H_HIS_ligand_2 -c 128 -m mmpbsa.in

This functionality is based on the gmx_MMPBSA tool

ProLIF (Protein-Ligand Interaction Fingerprints) Analysis

run_prolif --wdir_to_run md_files/md_run/protein_H_HIS_ligand_1 md_files/md_run/protein_H_HIS_ligand_2 -c 128 -s 5

This functionality is based on the ProLIF tool

More examples can be found in the documentation

Documentation

https://streamd.readthedocs.io/

License

MIT

Ready-to-use containers (Apptainer)

Pre-built .sif images are available (CPU and GPU) in the Zenodo record
CPU: apptainer run --cleanenv streamd_cpu.sif run_md --help
GPU: apptainer run --nv --cleanenv streamd_gpu.sif run_md --help

The provided .sif images are intended for Apptainer on Linux/HPC systems. GPU usage requires an NVIDIA GPU node and launching with --nv and run_md --device gpu.

Citation

Ivanova A, Mokshyna O, Polishchuk P.
StreaMD: the toolkit for high-throughput molecular dynamics simulations.
J. Cheminf. 2024, 16 (1), 123.
https://doi.org/10.1186/s13321-024-00918-w

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

streamd-0.4.1.tar.gz (168.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

streamd-0.4.1-py3-none-any.whl (189.1 kB view details)

Uploaded Python 3

File details

Details for the file streamd-0.4.1.tar.gz.

File metadata

  • Download URL: streamd-0.4.1.tar.gz
  • Upload date:
  • Size: 168.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.8

File hashes

Hashes for streamd-0.4.1.tar.gz
Algorithm Hash digest
SHA256 a0d804b2971a5d8269e5867966e4dd365a4c8d9e46f0bf21dea8e720c13a5eaa
MD5 647ef2ccd224c20d16ff1d180a305633
BLAKE2b-256 4b52a7c8d8f9516c8776a9c75ca0438e955cbc0899e6c12279080735dd580832

See more details on using hashes here.

File details

Details for the file streamd-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: streamd-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 189.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.8

File hashes

Hashes for streamd-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eaf2330479dd1ced3849a250887f57c81d1a9dc53d15205cfa121839625c02a6
MD5 c6e44c71d1b6216feeff1a1ee2f226ab
BLAKE2b-256 1922781e35e924eb021c95fcfd3301f7305d1a3a10c2bd3ad5c34eb2c2ff80b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page