Skip to main content

mdciao: Accessible Analysis and Visualization of Molecular Dynamics Simulation Data

Project description

mdciao: Accessible Analysis and Visualization of Molecular Dynamics Simulation Data

Pip Package Python Package MacOs Package Coverage DOI License

mdciao is a Python module that provides quick, “one-shot” command-line tools to analyze molecular simulation data using residue-residue distances. mdciao tries to automate as much as possible for non-experienced users while remaining highly customizable for advanced users, by exposing an API to construct your own analysis workflow.

Under the hood, the module mdtraj is doing most of the computation and handling of molecular information, using BioPython for sequence alignment, pandas for many table and IO related operations, and matplotlib for visualization. It tries to automatically use the consensus nomenclature for

using local files or on-the-fly lookups of the GPCRdb and/or KLIFS.

Licenses

Documentation

Currently, docs are hosted at https://mdciao.org.

System Requirements

mdciao is developed in GNU/Linux, and CI-tested via github actions for GNU/Linux and MacOs. Tested Python versions are:

So everything should work out of the box in these conditions.

Authors

mdciao is written and maintained by Guillermo Pérez-Hernández (ORCID) currently at the Institute of Medical Physics and Biophysics in the Charité Universitäsmedizin Berlin.

Please cite:
  • mdciao: Accessible Analysis and Visualization of Molecular Dynamics Simulation Data
    Guillermo Pérez-Hernández, Peter-Werner Hildebrand
    bioRxiv 2022.07.15.500163
  • mdciao: Accessible Analysis and Visualization of Molecular Dynamics Simulation Data
    Guillermo Pérez-Hernández, Peter-Werner Hildebrand
    PLOS Computational Biology, 2025 (accepted, will supersede the bioRxiv reference)

Scope

mdciao originated as a loose collection of CLI scripts used in our lab to streamline contact-frequency analysis of MD simulations with mdtraj, which is doing a lot of the heavy work under the hood of mdciao. The goal was to take the less scripting-affine lab members from their raw data to informative graphs about the general vicinity of their residues of interest without much hassle. From there, it grew to incorporate many of the things routinely done in the lab (with a focus on GPCRs and G proteins) and ultimately a package available for third-party use was made.

The main publications which have driven the development of mdciao are:

TODOs

You can find an informal list of TODOs and known issues here.

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

mdciao-1.0.0.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

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

mdciao-1.0.0-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file mdciao-1.0.0.tar.gz.

File metadata

  • Download URL: mdciao-1.0.0.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for mdciao-1.0.0.tar.gz
Algorithm Hash digest
SHA256 36fe4b459b889749caefcb2273790eb6458c455a8a3ddff0d4374bcd407969e9
MD5 8cbb59402f4f0351828b615d44d88ce0
BLAKE2b-256 dd4430aa0a60088ed1e14e879326ff3fe5c180d977725de1affed3da2e58aa5f

See more details on using hashes here.

File details

Details for the file mdciao-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mdciao-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for mdciao-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 879da03e661a5881a5697e8eaf14c2a3d6bfb356c39459ceef3f4be864484480
MD5 ff6f80f973bec6d7490689ddcc731c56
BLAKE2b-256 570f65b08cd393b0b5fae324ea38cf1148387f40ca16d699d54896a4ad4b13a4

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