scikit-diveMove 1.0.0__tar.gz → 1.0.1__tar.gz

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: scikit-diveMove
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python interface to R package diveMove
 License: AGPL-3.0-or-later
 License-File: LICENSE
 Keywords: animal behaviour,biology,behavioural ecology,diving,diving behaviour
 Author: Sebastian Luque
-Requires-Python: >=3.11
+Requires-Python: >=3.13
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
 Classifier: Intended Audience :: Developers
@@ -15,14 +15,14 @@ Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or l
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Instrument Drivers
 Requires-Dist: bottleneck (>=1.6.0,<2.0.0)
-Requires-Dist: docutils (>=0.22.4,<0.23.0)
+Requires-Dist: docutils (>=0.23,<0.24)
 Requires-Dist: matplotlib (>=3.10.8,<4.0.0)
 Requires-Dist: netcdf4 (>=1.7.4,<2.0.0)
 Requires-Dist: numpy (>=2.4.3,<3.0.0)
 Requires-Dist: pandas (>=3.0.1,<4.0.0)
 Requires-Dist: rpy2 (>=3.6.5,<4.0.0)
 Requires-Dist: scipy (>=1.17.1,<2.0.0)
-Requires-Dist: statsmodels (>=0.14.6,<0.15.0)
+Requires-Dist: statsmodels (>=0.15.0,<0.16.0)
 Requires-Dist: xarray (>=2026.2.0,<2027.0.0)
 Project-URL: Documentation, https://spluque.github.io/scikit-diveMove
 Project-URL: Repository, https://github.com/spluque/scikit-diveMove

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/pyproject.toml

@@ -6,17 +6,17 @@ authors = [
     {name = "Sebastian Luque"}
 ]
 license = {text = "AGPL-3.0-or-later"}
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 dependencies = [
     "bottleneck (>=1.6.0,<2.0.0)",
-    "docutils (>=0.22.4,<0.23.0)",
+    "docutils (>=0.23,<0.24)",
     "matplotlib (>=3.10.8,<4.0.0)",
     "netcdf4 (>=1.7.4,<2.0.0)",
     "numpy (>=2.4.3,<3.0.0)",
     "pandas (>=3.0.1,<4.0.0)",
     "rpy2 (>=3.6.5,<4.0.0)",
     "scipy (>=1.17.1,<2.0.0)",
-    "statsmodels (>=0.14.6,<0.15.0)",
+    "statsmodels (>=0.15.0,<0.16.0)",
     "xarray (>=2026.2.0,<2027.0.0)"
 ]
 classifiers = [
@@ -34,7 +34,7 @@ keywords = ["animal behaviour",
             "diving",
 	    "diving behaviour"
 ]
-version = "1.0.0"
+version = "1.0.1"
 
 [project.urls]
 repository = "https://github.com/spluque/scikit-diveMove"
@@ -44,7 +44,7 @@ documentation = "https://spluque.github.io/scikit-diveMove"
 docs = [
     "ipykernel (>=7.2.0,<8.0.0)",
     "myst-nb (>=1.4.0,<2.0.0)",
-    "pydata-sphinx-theme (>=0.16.1,<0.17.0)"
+    "pydata-sphinx-theme (>=0.24.0,<0.25.0)"
 ]
 test = [
     "pytest (>=9.0.2,<10.0.0)",
@@ -77,6 +77,29 @@ enable = false
 source = "skdiveMove/__init__.py"
 pattern = "^__version__\\s*=\\s*['\"](?P<version>.+?)['\"]"
 
+[tool.pytest]
+minversion = "9.0"
+testpaths = ["skdiveMove"]
+addopts = [
+    "--doctest-modules",
+    "--ignore-glob=skdiveMove/config_examples/*.json",
+    "-v",
+    "--tb=short",
+    "--strict-markers"
+]
+doctest_optionflags = ["NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL"]
+markers = [
+    "integration: integration tests (deselect with '-m \"not integration\"')",
+    "slow: slow tests (deselect with '-m \"not slow\"')",
+    "plotting: tests that generate plots"
+]
+filterwarnings = [
+    "ignore:.*ABCs.+:DeprecationWarning",
+    "ignore:.*tostring.+:DeprecationWarning"
+]
+log_format = "%(asctime)s[%(levelname)s] %(name)s:%(lineno)d: %(message)s"
+log_date_format = "%Y-%m-%dT%H:%M:%S%z"
+
 [build-system]
 requires = [
     "poetry-core>=2.0.0,<3.0.0",

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/__init__.py

@@ -88,5 +88,5 @@ from skdiveMove.calibconfig import dump_config_template
 
 __author__ = "Sebastian Luque <spluque@gmail.com>"
 __license__ = "AGPLv3"
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 __all__ = ["TDR", "calibrate", "dump_config_template"]

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/bouts/__init__.py

@@ -107,7 +107,7 @@ Methods summary
 from .bouts import Bouts, label_bouts
 from .boutsnls import BoutsNLS
 from .boutsmle import BoutsMLE
-from skdiveMove.tests import random_mixexp
+from skdiveMove.tests.get_sample_data import random_mixexp
 
 __all__ = ["Bouts", "BoutsNLS", "BoutsMLE", "label_bouts",
            "random_mixexp"]

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/bouts/boutsnls.py

@@ -26,7 +26,7 @@ class BoutsNLS(bouts.Bouts):
     :math:`p < 0.7` and the second process occurs with the remaining
     probability.
 
-    >>> from skdiveMove.tests import random_mixexp
+    >>> from skdiveMove.tests.get_sample_data import random_mixexp
     >>> rng = np.random.default_rng(123)
     >>> x2 = random_mixexp(1000, p=0.7, lda=np.array([0.05, 0.005]),
     ...                    rng=rng)
@@ -48,13 +48,16 @@ class BoutsNLS(bouts.Bouts):
 
     Plot observed and predicted data:
 
-    >>> xbouts2.plot_fit(coefs)  # doctest: +ELLIPSIS
-    <Axes: ...>
+    >>> from matplotlib.pyplot import Axes
+    >>> ax = xbouts2.plot_fit(coefs)
+    >>> isinstance(ax, Axes)
+    True
 
     Plot ECDF:
 
-    >>> xbouts2.plot_ecdf(coefs)  # doctest: +ELLIPSIS
-    <Axes: ...>
+    >>> ax = xbouts2.plot_ecdf(coefs)
+    >>> isinstance(ax, Axes)
+    True
 
     """
     def fit(self, start, **kwargs):
@@ -156,7 +159,7 @@ class BoutsNLS(bouts.Bouts):
 
 
 if __name__ == '__main__':
-    from skdiveMove.tests import diveMove2skd
+    from skdiveMove.tests.get_sample_data import diveMove2skd
     import pandas as pd
 
     tdrX = diveMove2skd()

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/calibspeed.py

@@ -107,6 +107,6 @@ def calibrate_speed(x, tau, contour_level, plot=True, ax=None):
 
 
 if __name__ == '__main__':
-    from skdiveMove.tests import diveMove2skd
+    from skdiveMove.tests.get_sample_data import diveMove2skd
     tdrX = diveMove2skd()
     print(tdrX)

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/tdr.py

@@ -48,13 +48,18 @@ class TDR(TDRPhases):
     --------
     Construct an instance from diveMove example dataset
 
-    >>> from skdiveMove.tests import diveMove2skd
+    >>> import matplotlib.pyplot as plt
+    >>> from skdiveMove.tests.get_sample_data import diveMove2skd
+
     >>> tdrX = diveMove2skd()
 
     Plot the `TDR` object
 
-    >>> tdrX.plot()  # doctest: +ELLIPSIS
-    (<Figure ... 1 Axes>, <Axes: ...>)
+    >>> fig, ax = tdrX.plot()
+    >>> isinstance(fig, plt.Figure)
+    True
+    >>> ax is not None
+    True
 
     """
 
@@ -131,7 +136,7 @@ class TDR(TDRPhases):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd(has_speed=True)
         >>> tdrX.zoc("offset", offset=3)
         >>> tdrX.calibrate_speed(z=2)
@@ -210,7 +215,7 @@ class TDR(TDRPhases):
         --------
         ZOC using the "filter" method
 
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd(has_speed=True)
 
         >>> # Window lengths and probabilities
@@ -285,7 +290,7 @@ class TDR(TDRPhases):
             ones_list.append(res)
 
         ones_df = pd.concat(ones_list, ignore_index=True)
-        ones_df.set_index(dive_ids[ok].unique(), inplace=True)
+        ones_df = ones_df.set_index(dive_ids[ok].unique())
         ones_df.index.rename("dive_id", inplace=True)
         ones_df["postdive_dur"] = postdive_dur[idx_name]
 
@@ -355,11 +360,16 @@ class TDR(TDRPhases):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> import matplotlib.pyplot as plt
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd()
-        >>> tdrX.plot(xlim=["2002-01-05 21:00:00", "2002-01-06 04:10:00"],
-        ...           depth_lim=[95, -1])  # doctest: +ELLIPSIS
-        (<Figure ... with 1 Axes>, <Axes: ...'>)
+        >>> fig, ax = tdrX.plot(
+        ...     xlim=["2002-01-05 21:00:00", "2002-01-06 04:10:00"],
+        ...     depth_lim=[95, -1])
+        >>> isinstance(fig, plt.Figure)
+        True
+        >>> ax is not None
+        True
 
         """
         try:
@@ -419,7 +429,9 @@ class TDR(TDRPhases):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> import matplotlib.pyplot as plt
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
+
         >>> tdrX = diveMove2skd()
         >>> # Window lengths and probabilities
         >>> DB = [-2, 5]
@@ -430,9 +442,11 @@ class TDR(TDRPhases):
         >>> tdrX.detect_dives(3)
         >>> tdrX.detect_dive_phases("unimodal", descent_crit_q=0.01,
         ...                         ascent_crit_q=0, knot_factor=20)
-        >>> tdrX.plot_zoc()  # doctest: +ELLIPSIS
-        (<Figure ... with 3 Axes>, array([<Axes: ...'>,
-            <Axes: ...'>, <Axes: ...>], dtype=object))
+        >>> fig, axs = tdrX.plot_zoc()
+        >>> isinstance(fig, plt.Figure)
+        True
+        >>> len(axs) == 3
+        True
 
         """
         zoc_method = self.zoc_method
@@ -497,16 +511,21 @@ class TDR(TDRPhases):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> import matplotlib.pyplot as plt
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
+
         >>> tdrX = diveMove2skd()
         >>> tdrX.zoc("offset", offset=3)
         >>> tdrX.detect_wet()
         >>> tdrX.detect_dives(3)
         >>> tdrX.detect_dive_phases("unimodal", descent_crit_q=0.01,
         ...                         ascent_crit_q=0, knot_factor=20)
-        >>> tdrX.plot_phases(list(range(250, 300)),
-        ...                  surface=True)  # doctest: +ELLIPSIS
-        (<Figure ... with 1 Axes>, <Axes: ...>)
+        >>> fig, ax = tdrX.plot_phases(list(range(250, 300)),
+        ...                            surface=True)
+        >>> isinstance(fig, plt.Figure)
+        True
+        >>> ax is not None
+        True
 
         """
         row_ids = self.get_dives_details("row_ids")
@@ -595,16 +614,21 @@ class TDR(TDRPhases):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> import matplotlib.pyplot as plt
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
+
         >>> tdrX = diveMove2skd()
         >>> tdrX.zoc("offset", offset=3)
         >>> tdrX.detect_wet()
         >>> tdrX.detect_dives(3)
         >>> tdrX.detect_dive_phases("unimodal", descent_crit_q=0.01,
         ...                         ascent_crit_q=0, knot_factor=20)
-        >>> tdrX.plot_dive_model(diveNo=20,
-        ...                      figsize=(10, 10))  # doctest: +ELLIPSIS
-        (<Figure ... with 2 Axes>, (<Axes: ...>, <Axes: ...>))
+        >>> fig, axs = tdrX.plot_dive_model(diveNo=20,
+        ...                                 figsize=(10, 10))
+        >>> isinstance(fig, plt.Figure)
+        True
+        >>> len(axs) == 2
+        True
 
         """
         dive_ids = self.get_dives_details("row_ids", "dive_id")
@@ -776,16 +800,18 @@ class TDR(TDRPhases):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
+        >>> from xarray import Dataset
+
         >>> tdrX = diveMove2skd()
         >>> tdrX.zoc("offset", offset=3)
         >>> tdrX.detect_wet()
         >>> tdrX.detect_dives(3)
         >>> tdrX.detect_dive_phases("unimodal", descent_crit_q=0.01,
         ...                         ascent_crit_q=0, knot_factor=20)
-        >>> tdrX.extract_dives(diveNo=20)  # doctest: +ELLIPSIS
-        <xarray.Dataset> ...
-        Dimensions: ...
+        >>> dives_ds = tdrX.extract_dives(diveNo=20)
+        >>> isinstance(dives_ds, Dataset)
+        True
 
         """
         dive_ids = self.get_dives_details("row_ids", "dive_id")
@@ -832,7 +858,7 @@ def calibrate(tdr_file, config_file=None):
 
     """
     if config_file is None:
-        config = calibconfig._DEFAULT_CONFIG
+        config = calibconfig._DEFAULT_CONFIG.copy()
     else:
         config = calibconfig.read_config(config_file)
 

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/tdrphases.py

@@ -148,7 +148,7 @@ class TDRPhases(ZOC):
         --------
         ZOC using the "offset" method for convenience
 
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd("TDRPhases")
         >>> tdrX.zoc("offset", offset=3)
 
@@ -180,7 +180,7 @@ class TDRPhases(ZOC):
                                dry_thr=dry_thr,
                                wet_thr=wet_thr,
                                wet_cond=(robjs.vectors
-                                         .BoolVector(~depth_py.isna())),
+                                         .BoolVector(wet_cond)),
                                interval=dtime))
         with (robjs.default_converter + pandas2ri.converter).context():
             phases = pd.DataFrame({'phase_id': phases_l.rx2("phase.id"),
@@ -234,7 +234,7 @@ class TDRPhases(ZOC):
         --------
         ZOC using the ``offset`` method for convenience
 
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd("TDRPhases")
         >>> tdrX.zoc("offset", offset=3)
 
@@ -256,7 +256,7 @@ class TDRPhases(ZOC):
         # Replace dots with underscore
         phases_df.columns = (phases_df.columns.str
                              .replace(".", "_", regex=False))
-        phases_df.set_index(depth_py.index, inplace=True)
+        phases_df = phases_df.set_index(depth_py.index)
         dive_activity = phases_df.pop("dive_activity")
         # Dive and post-dive ID should be integer
         phases_df = phases_df.astype(int)
@@ -383,7 +383,7 @@ class TDRPhases(ZOC):
         --------
         ZOC using the "offset" method for convenience
 
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd("TDRPhases")
         >>> tdrX.zoc("offset", offset=3)
 
@@ -664,7 +664,7 @@ class TDRPhases(ZOC):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd("TDRPhases")
         >>> tdrX.zoc("offset", offset=3)
         >>> tdrX.detect_wet()
@@ -712,7 +712,7 @@ class TDRPhases(ZOC):
 
         Examples
         --------
-        >>> from skdiveMove.tests import diveMove2skd
+        >>> from skdiveMove.tests.get_sample_data import diveMove2skd
         >>> tdrX = diveMove2skd("TDRPhases")
         >>> tdrX.zoc("offset", offset=3)
         >>> tdrX.detect_wet()

{scikit_divemove-1.0.0 → scikit_divemove-1.0.1}/skdiveMove/tdrsource.py

@@ -31,7 +31,7 @@ class TDRSource:
 
     Examples
     --------
-    >>> from skdiveMove.tests import diveMove2skd
+    >>> from skdiveMove.tests.get_sample_data import diveMove2skd
     >>> tdrX = diveMove2skd()
     >>> print(tdrX)  # doctest: +ELLIPSIS
     Time-Depth Recorder -- Class TDR object ...
@@ -66,7 +66,7 @@ class TDRSource:
             for vname, da in self.tdr.data_vars.items():
                 da.attrs["sampling_rate"] = (1.0 /
                                              pd.to_timedelta(subsample)
-                                             .seconds)
+                                             .total_seconds())
                 da.attrs["sampling_rate_units"] = "Hz"
                 _append_xr_attr(da, "history",
                                 "Resampled to {}\n".format(subsample))

scikit_divemove-1.0.1/skdiveMove/tests/conftest.py

@@ -0,0 +1,18 @@
+"""Shared pytest fixtures for scikit-diveMove tests.
+
+Provides reusable fixtures for test data, directory management, matplotlib
+backend configuration, and sample data loading.
+
+"""
+
+import pytest
+import matplotlib as mpl
+mpl.use("Agg")
+import matplotlib.pyplot as plt  # noqa: E402
+
+
+@pytest.fixture(autouse=True)
+def close_matplotlib_figures():
+    """Close all matplotlib figures after each test."""
+    yield
+    plt.close("all")

scikit_divemove-1.0.0/skdiveMove/tests/__init__.py → scikit_divemove-1.0.1/skdiveMove/tests/get_sample_data.py

@@ -1,7 +1,49 @@
-"""scikit-diveMove tests"""
+"""Helper function to load sample data onto a TDR object
 
+"""
+
+import importlib.resources as rsrc
 import numpy as np
-from .get_sample_data import diveMove2skd  # noqa: F401
+from skdiveMove.tdr import TDR
+from skdiveMove.tdrsource import TDRSource
+from skdiveMove.tdrphases import TDRPhases
+from skdiveMove.zoc import ZOC
+
+
+def diveMove2skd(oclass="TDR", **kwargs):
+    """Create a `TDRSource` instance from `diveMove` example data set
+
+    The sample data set has been converted to NetCDF4 format, to include
+    all necessary metadata.
+
+    Parameters
+    ----------
+    oclass : {"TDRSource", "ZOC", "TDRPhases", "TDR"}
+        The class to return.
+    **kwargs
+        Optional keyword arguments passed to class instantiator.
+
+    Returns
+    -------
+    `TDR`
+
+    """
+    class_names = ["TDRSource", "ZOC", "TDRPhases", "TDR"]
+
+    if oclass in class_names:
+        ifile = (rsrc.files("skdiveMove") / "tests" /
+                 "data" / "ag_mk7_2002_022.nc")
+
+        classes = [TDRSource, ZOC, TDRPhases, TDR]
+        class_map = dict(zip(class_names, classes))
+        tdrX = class_map[oclass].read_netcdf(ifile, depth_name="depth",
+                                             time_name="date_time",
+                                             **kwargs)
+    else:
+        raise LookupError(("Requested class ({}) does not exist"
+                           .format(oclass)))
+
+    return tdrX
 
 
 def random_mixexp(n, p, lda, rng=None):

scikit_divemove-1.0.1/skdiveMove/tests/scenarios.py

@@ -0,0 +1,135 @@
+"""Meta classes for flexible testing of TDR and bout analysis classes
+
+"""
+import numpy as np
+import pandas as pd
+
+from abc import ABC, abstractmethod
+from skdiveMove.tests.get_sample_data import (
+    diveMove2skd, random_mixexp)  # noqa: E402
+
+
+class TDRScenario:
+    """Test `TDR` class.
+
+    Parameters
+    ----------
+    oclass : {"TDRSource", "ZOC", "TDRPhases", "TDR"}
+        The class to retrieve from sample data.
+    **kwargs
+        Optional keyword arguments passed to class instantiator.
+
+    Attributes
+    ----------
+    tdrX : TDR
+        TDR instance.
+    default_pars : dict
+        Calibrate parameters.
+    tdr_calib : TDRPhases
+        Calibrated TDR instance.
+    diveNo_seq : ndarray of shape (N,)
+        Sequence of dive numbers in the time series.
+
+    """
+    def __init__(self, oclass, **kwargs) -> None:
+        # An instance to work with
+        self.tdrX = diveMove2skd(oclass, **kwargs)
+        zoc_offset = 3
+        dry_thr = 70
+        wet_thr = 3610
+        dive_thr = 3
+        dive_model = "unimodal"
+        smooth_par = 0.1
+        knot_factor = 3
+        descent_crit_q = 0
+        ascent_crit_q = 0
+        self.default_pars = {"zoc_offset": zoc_offset,
+                             "dry_thr": dry_thr,
+                             "wet_thr": wet_thr,
+                             "dive_thr": dive_thr,
+                             "dive_model": dive_model,
+                             "smooth_par": smooth_par,
+                             "knot_factor": knot_factor,
+                             "descent_crit_q": descent_crit_q,
+                             "ascent_crit_q": ascent_crit_q}
+        self.diveNo_seq = None
+
+    def zoc(self):
+        tdrX = self.tdrX
+        default_pars = self.default_pars
+        tdrX.zoc(method="offset", offset=default_pars["zoc_offset"])
+
+    def detect_wet(self):
+        default_pars = self.default_pars
+        self.zoc()
+        self.tdrX.detect_wet(dry_thr=default_pars["dry_thr"],
+                             wet_thr=default_pars["wet_thr"])
+
+    def detect_dives(self):
+        default_pars = self.default_pars
+        self.detect_wet()
+        self.tdrX.detect_dives(dive_thr=default_pars["dive_thr"])
+        diveNo_max = (self.tdrX.get_dives_details("row_ids", "dive_id")
+                      .max())
+        self.diveNo_seq = np.arange(diveNo_max) + 1
+
+    def detect_dive_phases(self):
+        default_pars = self.default_pars
+        self.detect_dives()
+        self.tdrX.detect_dive_phases(
+            dive_model=default_pars["dive_model"],
+            smooth_par=default_pars["smooth_par"],
+            knot_factor=default_pars["knot_factor"],
+            descent_crit_q=default_pars["descent_crit_q"],
+            ascent_crit_q=default_pars["ascent_crit_q"])
+
+
+class BoutsBaseScenario(ABC):
+    """Common base scenario for testing
+
+    Subclasses must implement their own __init__ method.
+
+    Attributes
+    ----------
+    nsamp : int
+        Number of samples to draw from the mixed distributions.
+    x : array_like
+        1D array with samples from mixed distribution.
+    pars_true : dict
+        Dictionary with true parameters used to generate `x`, with keys:
+        `p`, `lambda0`, and `lambda1`, if it is a 2-process scenario, or
+        `p0`, `p1`, `lambda0`, `lambda1`, and `lambda2`, if it is a
+        3-process scenario.
+    nls_opts, mle_opts1, mle_opts2 : dict
+        Dictionary with keys and values passed to optimization routine for
+        first and second fits.
+
+    """
+
+    @abstractmethod
+    def __init__(self, nsamp: int) -> None:
+        self.nsamp = nsamp
+        self.rng = np.random.default_rng()
+        self.pars_true = None
+        self.nls_opts = None
+        self.mle_opts1 = None
+        self.mle_opts2 = None
+        self.x = None
+
+    def generate_proc2(self, pars_true):
+        # Generate samples for 2-process case
+        x2 = random_mixexp(self.nsamp,
+                           pars_true.loc["p"],
+                           (pars_true.loc[["lambda0", "lambda1"]]
+                            .to_numpy()), rng=self.rng)
+
+        return pd.Series(x2)
+
+    def generate_proc3(self, pars_true):
+        # Generate samples for 3-process case
+        x3 = random_mixexp(self.nsamp,
+                           pars_true.loc[["p0", "p1"]].to_numpy(),
+                           (pars_true.loc[
+                               ["lambda0", "lambda1", "lambda2"]]
+                            .to_numpy()), rng=self.rng)
+        return pd.Series(x3)