#!/usr/local/bin/env python

# ==============================================================================
# MODULE DOCSTRING
# ==============================================================================

"""
MultiState
==========

Multistate Sampling simulation algorithms, specific variants, and analyzers

This module provides a general facility for running multiple thermodynamic state multistate simulations, both general
as well as derived classes for special cases such as parallel tempering (in which
the states differ only in temperature).

The classes also provide

Provided classes include:

- :class:`yank.multistate.MultiStateSampler`
    Base class for general, multi-thermodynamic state parallel multistate
- :class:`yank.multistate.ReplicaExchangeSampler`
    Derived class from MultiStateSampler which allows sampled thermodynamic states
    to swap based on Hamiltonian Replica Exchange
- :class:`yank.multistate.ParallelTemperingSampler`
    Convenience subclass of ReplicaExchange for parallel tempering simulations
    (one System object, many temperatures).
- :class:`yank.multistate.SAMSSampler`
    Single-replica sampler which samples through multiple thermodynamic states
    on the fly.
- :class:`yank.multistate.MultiStateReporter`
    Replica Exchange reporter class to store all variables and data

Analyzers
---------
The MultiState module also provides analysis modules to analyze simulations and compute observables from data generated
under any of the MultiStateSampler's

Extending and Subclassing
-------------------------
Subclassing a sampler and analyzer is done by importing and extending any of the following:

    * The base ``MultiStateSampler`` from ``multistatesampler``
    * The base ``MultiStateReporter`` from ``multistatereporter``
    * The base ``MultiStateAnalyzer`` or ``PhaseAnalyzer`` and base `ObservablesRegistry`` from ``multistateanalyzer``

COPYRIGHT
---------

Current version by Andrea Rizzi <andrea.rizzi@choderalab.org>, Levi N. Naden <levi.naden@choderalab.org> and
John D. Chodera <john.chodera@choderalab.org> while at Memorial Sloan Kettering Cancer Center.

Original version by John D. Chodera <jchodera@gmail.com> while at the University of
California Berkeley.

LICENSE
-------

This code is licensed under the latest available version of the MIT License.

"""

import warnings
warnings.warn("The yank.multistate package is deprecated and it will be "
              "available as openmmtools.multistate with openmmtools >= 0.18",
              DeprecationWarning, stacklevel=2)

from .multistatesampler import MultiStateSampler
from .multistatereporter import MultiStateReporter
from .replicaexchange import ReplicaExchangeSampler, ReplicaExchangeAnalyzer
from .paralleltempering import ParallelTemperingSampler, ParallelTemperingAnalyzer
from .sams import SAMSSampler, SAMSAnalyzer
from .multistateanalyzer import *
from .utils import *
