Welcome to spib’s documentation!

spib

https://img.shields.io/pypi/v/spib.svg https://img.shields.io/travis/wangdedi1997/spib.svg Documentation Status

State Predictive Information Bottleneck (SPIB)

What is it?

SPIB is a deep learning-based framework for dimension reduction and Markov model construction of MD trajectories. Please read and cite this manuscript when using SPIB: https://aip.scitation.org/doi/abs/10.1063/5.0038198. Here is an implementation of SPIB in Pytorch.

Installation

Stable release:

The preferred installation mechanism for spib is with pip:

$ pip install spib

From sources:

The sources for spib can be downloaded from the Github repo.

You can clone the public repository:

$ git clone git://github.com/wangdedi1997/spib

Once you have a copy of the source, you can install it with:

$ python setup.py install

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Indices and tables