diff --git a/nessai/gw/__init__.py b/nessai/gw/__init__.py index f8c47fe5..33305a54 100644 --- a/nessai/gw/__init__.py +++ b/nessai/gw/__init__.py @@ -3,6 +3,18 @@ Functions and classes for using nessai for gravitational-wave inference. """ +import warnings + from .proposal import GWFlowProposal __all__ = ["GWFlowProposal"] + +warnings.warn( + ( + "The `nessai.gw` module will be deprecated in the next release in " + "favour of the nessai-gw package. This packages provides the same " + "functionality as`nessai.gw` via the plugin interface." + "For more details, see: https://github.com/mj-will/nessai-gw" + ), + FutureWarning, +)