Skip to main content

PyPI Conda Cite Zenodo CI Documentation Coverage License PyPI - Downloads

pyGPCCA - Generalized Perron Cluster Cluster Analysis

Generalized Perron Cluster Cluster Analysis program to coarse-grain reversible and non-reversible Markov state models.

Markov state models (MSM) enable the identification and analysis of metastable states and related kinetics in a very instructive manner. They are widely used, e.g., to model molecular or cellular kinetics.

Common state-of-the-art Markov state modeling methods and tools are very well suited to model reversible processes in closed equilibrium systems. However, most are not well suited to deal with non-reversible or even non-autonomous processes of non-equilibrium systems.

To overcome this limitation, the Generalized Robust Perron Cluster Cluster Analysis (GPCCA or G-PCCA) was developed. The GPCCA method implemented in the pyGPCCA program readily handles equilibrium as well as non-equilibrium data by utilizing real Schur vectors instead of eigenvectors.

pyGPCCA enables the semiautomatic coarse-graining of transition matrices representing the dynamics of the system under study. Utilizing pyGPCCA, metastable states as well as cyclic kinetics can be identified and modeled.

How to cite pyGPCCA

If you use pyGPCCA or parts of it to model molecular dynamics, e.g. to coarse-grain protein conformational dynamics, cite [Reuter18] as:

@article{Reuter18,
    author = {Reuter, Bernhard and Weber, Marcus and Fackeldey, Konstantin and Röblitz, Susanna and Garcia, Martin E.},
    title = {Generalized Markov State Modeling Method for Nonequilibrium Biomolecular Dynamics:
    Exemplified on Amyloid β Conformational Dynamics Driven by an Oscillating Electric Field},
    journal = {Journal of Chemical Theory and Computation},
    volume = {14},
    number = {7},
    pages = {3579-3594},
    year = {2018},
    doi = {10.1021/acs.jctc.8b00079},
    note  = {PMID: 29812922},
}

If you use pyGPCCA or parts of it in a more general context, e.g. to model cellular dynamics, cite [Reuter19] as:

@article{Reuter19,
    author = {Reuter,Bernhard and Fackeldey,Konstantin and Weber,Marcus },
    title = {Generalized Markov modeling of nonreversible molecular kinetics},
    journal = {The Journal of Chemical Physics},
    volume = {150},
    number = {17},
    pages = {174103},
    year = {2019},
    doi = {10.1063/1.5064530},
}

Please consider also citing [Reuter22].

Installation

We support multiple ways of installing pyGPCCA. If any problems arise, please consult the troubleshooting section in the documentation.

Conda

pyGPCCA is available as a conda package and can be installed as:

conda install -c conda-forge pygpcca

This is the recommended way of installing, since this package also includes PETSc/SLEPc libraries. We use PETSc/SLEPc internally to speed up the computation of leading Schur vectors (both are optional).

PyPI

In order to install pyGPCCA from The Python Package Index, run:

pip install pygpcca
# or with libraries utilizing PETSc/SLEPc
pip install pygpcca[slepc]

Example

Please refer to our example usage in the documentation.

Key Contributors

Acknowledgments

We thank Marcus Weber and the Computational Molecular Design (CMD) group at the Zuse Institute Berlin (ZIB) for the longstanding and productive collaboration in the field of Markov modeling of non-reversible molecular dynamics. M. Weber, together with Susanna Röblitz and K. Fackeldey, had the original idea to employ Schur vectors instead of eigenvectors in the coarse-graining of non-reversible transition matrices.

Further, we would like to thank Fabian Paul for valuable discussions regarding the sorting of Schur vectors and his effort to translate the original sorting routine for real Schur forms, SRSchur published by Jan Brandts, from MATLAB into Python code, M. Weber and Alexander Sikorski for pointing us to SLEPc for sorted partial Schur decompositions, and A. Sikorski for supplying us with an code example and guidance how to interface SLEPc in Python. The development of pyGPCCA started - based on the original GPCCA program written in MATLAB - at the beginning of 2020 in a fork of MSMTools, since it was planned to integrate GPCCA into MSMTools at this time. Due to this, some similarities in structure and code (indicated were evident) can be found. Further, utility functions found in pygpcca/utils/_utils.py originate from MSMTools.

Metadata

Release files for pygpcca 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pygpcca 1.0.4
File Size Uploaded
pygpcca-1.0.4.tar.gz 106.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pygpcca 1.0.4
File Interpreter ABI Platform
pygpcca-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 175.0 kB

Release files / pygpcca-1.0.4.tar.gz

Download URL pygpcca-1.0.4.tar.gz
Size 106.2 kB
Tags Source
SHA-256 checksum
How to use checksums
5e3b49279abc62d25133811daeee050715f995ff02042c46e2a2034331d090d1
BLAKE2b-256 checksum
How to use checksums
955d6cd08d5822de8c482e8fc5c4299e6f139e4e1eb39cf5d999e5ba374a4baa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.15

Release files / pygpcca-1.0.4-py3-none-any.whl

Download URL pygpcca-1.0.4-py3-none-any.whl
Size 68.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e541059418032cd51d2997638adfe6aac9629717bbd6b78d8876ffb4bf4018c7
BLAKE2b-256 checksum
How to use checksums
82a6c415c9faa7c4c8749fbac0c54523def0cf9efb94d70f09188370c0da74c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.15

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page