API reference

Binning Functions

mdentropy.core.binning.doanes_rule(x)	Convenience function for choosing an optimal number of bins using Doane’s Rule.
mdentropy.core.binning.hist(n_bins, rng, *args)	Convenience function for histogramming N-dimentional data
mdentropy.core.binning.symbolic(n_bins, rng, …)	Symbolic binning of data

Entropy Calculations

mdentropy.entropy(n_bins, rng, method, *args)	Entropy calculation
mdentropy.centropy(n_bins, x, y[, rng, method])	Conditional entropy calculation

Information Calculations

mdentropy.mutinf(n_bins, x, y[, rng, method])	Mutual information calculation
mdentropy.nmutinf(n_bins, x, y[, rng, method])	Normalized mutual information calculation
mdentropy.cmutinf(n_bins, x, y, z[, rng, method])	Conditional mutual information calculation
mdentropy.ncmutinf(n_bins, x, y, z[, rng, …])	Normalized conditional mutual information calculation

Feature Metrics

mdentropy.metrics.AlphaAngleMutualInformation(…)	Mutual information calculations for alpha angles
mdentropy.metrics.AlphaAngleTransferEntropy(…)	Transfer entropy calculations for alpha angles
mdentropy.metrics.ContactMutualInformation([…])	Mutual information calculations for contacts
mdentropy.metrics.ContactTransferEntropy([…])	Transfer entropy calculations for contacts
mdentropy.metrics.DihedralMutualInformation([…])	Mutual information calculations for dihedral angles
mdentropy.metrics.DihedralTransferEntropy([…])	Transfer entropy calculations for dihedral angles