1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
|
# -*- Mode: python; tab-width: 4; indent-tabs-mode:nil; coding:utf-8 -*-
# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4
#
# MDAnalysis --- https://www.mdanalysis.org
# Copyright (c) 2006-2017 The MDAnalysis Development Team and contributors
# (see the file AUTHORS for the full list of names)
#
# Released under the Lesser GNU Public Licence, v2.1 or any higher version
#
# Please cite your use of MDAnalysis in published work:
#
# R. J. Gowers, M. Linke, J. Barnoud, T. J. E. Reddy, M. N. Melo, S. L. Seyler,
# D. L. Dotson, J. Domanski, S. Buchoux, I. M. Kenney, and O. Beckstein.
# MDAnalysis: A Python package for the rapid analysis of molecular dynamics
# simulations. In S. Benthall and S. Rostrup editors, Proceedings of the 15th
# Python in Science Conference, pages 102-109, Austin, TX, 2016. SciPy.
# doi: 10.25080/majora-629e541a-00e
#
# N. Michaud-Agrawal, E. J. Denning, T. B. Woolf, and O. Beckstein.
# MDAnalysis: A Toolkit for the Analysis of Molecular Dynamics Simulations.
# J. Comput. Chem. 32 (2011), 2319--2327, doi:10.1002/jcc.21787
#
"""Water dynamics analysis --- :mod:`MDAnalysis.analysis.waterdynamics`
=======================================================================
:Author: Alejandro Bernardin
:Year: 2014-2015
:Copyright: Lesser GNU Public License v2.1+
.. versionadded:: 0.11.0
.. deprecated:: 2.8.0
This module is deprecated in favour of the mdakit
`waterdynamics <https://www.mdanalysis.org/waterdynamics/>`_ and
will be removed in MDAnalysis 3.0.0.
See Also
--------
:mod:`waterdynamics.waterdynamics`
"""
import warnings
try:
from waterdynamics.waterdynamics import (
WaterOrientationalRelaxation,
AngularDistribution,
MeanSquareDisplacement,
SurvivalProbability,
)
except ImportError:
wmsg = (
"Please install the waterdynamics mdakit to use it in MDAnalysis.\n"
"More details can be found here: "
"https://www.mdanalysis.org/waterdynamics/getting_started.html"
)
warnings.warn(wmsg, category=UserWarning)
else:
wmsg = (
"Deprecation in version 2.8.0\n"
"MDAnalysis.analysis.waterdynamics is deprecated in favour of the "
"MDAKit waterdynamics (https://www.mdanalysis.org/waterdynamics/) "
"and will be removed in MDAnalysis version 3.0.0"
)
warnings.warn(wmsg, category=DeprecationWarning)
|