From b05ae81801dab5b95e08b4347cd29381956d5e1e Mon Sep 17 00:00:00 2001 From: Lily Wang Date: Thu, 24 Aug 2023 09:52:58 +1000 Subject: [PATCH] change bibliography to footbibliography --- mdaencore/similarity.py | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/mdaencore/similarity.py b/mdaencore/similarity.py index 3fbc0da..0e21f10 100644 --- a/mdaencore/similarity.py +++ b/mdaencore/similarity.py @@ -28,8 +28,8 @@ :Author: Matteo Tiberti, Wouter Boomsma, Tone Bengtsen The module contains implementations of similarity measures between protein -ensembles described in :cite:p:`b-LindorffLarsen2009`. The implementation and -examples are described in :cite:p:`b-Tiberti2015`. +ensembles described in :footcite:p:`LindorffLarsen2009`. The implementation and +examples are described in :footcite:p:`Tiberti2015`. The module includes facilities for handling ensembles and trajectories through the :class:`Universe` class, performing clustering or dimensionality reduction @@ -50,7 +50,7 @@ + **Clustering based convergence evaluation** : :func:`ces_convergence` + **Dimensionality-reduction based convergence evaluation** : :func:`dres_convergence` -When using this module in published work please cite :cite:p:`b-Tiberti2015`. +When using this module in published work please cite :footcite:p:`Tiberti2015`. .. _Examples: Examples @@ -160,13 +160,8 @@ .. rubric:: References -.. bibliography:: - :filter: False - :keyprefix: b- - :labelprefix: ᵇ +.. footbibliography:: - Tiberti2015 - LindorffLarsen2009 """ import warnings import logging @@ -252,7 +247,7 @@ def harmonic_ensemble_similarity(sigma1, x2): """ Calculate the harmonic ensemble similarity measure - as defined in :cite:p:`b-Tiberti2015`. + as defined in :footcite:p:`Tiberti2015`. Parameters ---------- @@ -725,7 +720,7 @@ def hes(ensembles, r"""Calculates the Harmonic Ensemble Similarity (HES) between ensembles. The HES is calculated with the symmetrized version of Kullback-Leibler - divergence as described in :cite:p:`b-Tiberti2015`. + divergence as described in :footcite:p:`Tiberti2015`. Parameters ---------- @@ -968,7 +963,7 @@ def ces(ensembles, Calculates the Clustering Ensemble Similarity (CES) between ensembles using the Jensen-Shannon divergence as described in - :cite:p:`b-Tiberti2015`. + :footcite:p:`Tiberti2015`. Parameters ---------- @@ -1236,7 +1231,7 @@ def dres(ensembles, Calculates the Dimensional Reduction Ensemble Similarity (DRES) between ensembles using the Jensen-Shannon divergence as described in - :cite:p:`b-Tiberti2015`. + :footcite:p:`Tiberti2015`. Parameters