Γ—

nf-core/moleculardynamics

Version: 0.0.0-c94861c Git revision: c94861ceb7665b22ac1789bb3257ae8da6b6643f Commit: Content hash:
Run:
Workflow: main.nf

nf-core/moleculardynamics

πŸ‘©β€πŸ’» I'm working on it, so please be patient.

GitHub Actions CI Status GitHub Actions Linting StatusAWS CICite with Zenodo nf-test

Nextflow nf-core template version run with conda run with docker run with singularity Launch on Seqera Platform

Get help on SlackFollow on BlueskyFollow on MastodonWatch on YouTube

Introduction

nf-core/moleculardynamics is a bioinformatics pipeline for running molecular dynamic simulations (MD) using GROMACS open-source software. This workflow enables researchers to perform standard protein simulations in a fully automated manner, with minimal configuration, on both local and high-performance computing (HPC) environments.

We are currently working on the following tasks:

  1. πŸš€πŸ“† Official release of the nf-core/moleculardynamics pipeline.
  2. πŸ› πŸ‘©β€πŸ’» Expanding the pipeline’s capabilities to include more analysis modules (e.g., RMSF, distances), and integrating specialized tools for membrane proteins and protein-ligand complexes.
  3. πŸ“šπŸ“ Generating a comprehensive test dataset.

Pipeline

nf-core/moleculardynamics

The nf-core/moleculardynamics pipeline automates a standard GROMACS MD simulation workflow. The major steps are:

  • Input pre-processing: From the PDB structure, remove the missing atoms.
  • Production run: Main subworkflow of the pipeline.
    • Generation of molecular topology,
    • System solvation, and ion addition to neutralize the system.
    • Energy Minimization: Removal of steric clashes and relaxation of the initial structure.
    • Equilibration: NVT (constant Number, Volume, Temperature) and NPT (constant Number, Pressure, Temperature) equilibration to bring the system to the desired temperature and density.
    • Production MD: Execution of the main molecular dynamics simulation.
  • Post-processing: Centering the protein and remove periodic boundary condition (PBC).
  • Analysis: Preliminary analysis of the Root-Mean-Square Deviation (RMSD).

Usage

[πŸ‘©β€πŸ’» working on it]

Note

If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

Warning

Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

[πŸ‘©β€πŸ’» working on it]

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Credits

nf-core/moleculardynamics has been developed by Sara Tolosa AlarcΓ³n (@sarata00) from the Computational Biology Group at the Barcelona Supercomputing Center under the deCYPher project and supervision of Miguel Romero-Durana (@migromero).

Contributions and Support

[πŸ‘©β€πŸ’» working on it]

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #moleculardynamics channel (you can join with this invite).

Citations

[πŸ‘©β€πŸ’» working on it]

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

18 parameter(s) in 3 group(s)

Generic options#

Less common options for the pipeline, typically set in a config file.

Display version and exit.

type boolean

Incoming hook URL for messaging service

More detail

Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.

type string

Email address for completion summary, only when pipeline fails.

More detail

An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.

type string
pattern ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Do not use coloured log outputs.

type boolean

Send plain-text email instead of HTML.

type boolean

Boolean whether to validate parameters against the schema at runtime

type boolean
default true

Method used to save pipeline results to output directory.

More detail

The Nextflow publishDir option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.