Skip to content

Commit

Permalink
MAINT: add warning about nessai.gw
Browse files Browse the repository at this point in the history
  • Loading branch information
mj-will committed Oct 25, 2024
1 parent 99cd120 commit 3b3fc2c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions nessai/gw/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)

0 comments on commit 3b3fc2c

Please sign in to comment.