Merge pull request #210 from scikit-hep/eduardo-add-license-statement

eduardo-rodrigues · web-flow · commit 7d5ad54e6918 · 2026-07-01T15:13:53.000+02:00
Add license statements to files
diff --git a/src/hepstats/__init__.py b/src/hepstats/__init__.py
@@ -1 +1,3 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 from ._version import version as __version__
diff --git a/src/hepstats/hypotests/__init__.py b/src/hepstats/hypotests/__init__.py
@@ -1,4 +1,4 @@
-# Licensed under a 3-clause BSD style license, see LICENSE.
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
 Module for hypothesis tests, upper limits and confidence intervals calculations.
 """
diff --git a/src/hepstats/hypotests/parameters.py b/src/hepstats/hypotests/parameters.py
@@ -1,4 +1,4 @@
-# Licensed under a 3-clause BSD style license, see LICENSE
+# Licensed under a 3-clause BSD style license, see LICENSES folder
 """
 Module defining the parameter of interest classes, currently includes:
 
diff --git a/src/hepstats/modeling/__init__.py b/src/hepstats/modeling/__init__.py
@@ -1,4 +1,4 @@
-# Licensed under a 3-clause BSD style license, see LICENSE.
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
 Module for algorithms and methods used to model distributions.
 
diff --git a/src/hepstats/modeling/bayesian_blocks.py b/src/hepstats/modeling/bayesian_blocks.py
@@ -1,4 +1,4 @@
-# Licensed under a 3-clause BSD style license, see LICENSE and LICENSE_ASTROML
+# Licensed under a 3-clause BSD style license, see LICENSES folder and LICENSE_ASTROML
 """
 Bayesian Block implementation
 =============================
diff --git a/src/hepstats/splot/__init__.py b/src/hepstats/splot/__init__.py
@@ -1,4 +1,4 @@
-# Licensed under a 3-clause BSD style license, see LICENSE.
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
 Module implementing the **sPlot** algorithm, see :cite:`Pivk:2004ty`.
 
diff --git a/src/hepstats/splot/exceptions.py b/src/hepstats/splot/exceptions.py
@@ -1,5 +1,6 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
-Specific exceptions for the `splot` submodule
+Specific exceptions for the `splot` submodule.
 """
 
 from __future__ import annotations
diff --git a/src/hepstats/splot/sweights.py b/src/hepstats/splot/sweights.py
@@ -1,3 +1,4 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 from __future__ import annotations
 
 import warnings
diff --git a/src/hepstats/splot/warnings.py b/src/hepstats/splot/warnings.py
@@ -1,5 +1,6 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
-Specific warnings for the `splot` submodule
+Specific warnings for the `splot` submodule.
 """
 
 from __future__ import annotations
diff --git a/src/hepstats/utils/__init__.py b/src/hepstats/utils/__init__.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 from .fit import (
     eval_pdf,
     array2dataset,
diff --git a/src/hepstats/utils/fit/__init__.py b/src/hepstats/utils/fit/__init__.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 from .diverse import (
     get_value,
     eval_pdf,
diff --git a/src/hepstats/utils/fit/api_check.py b/src/hepstats/utils/fit/api_check.py
@@ -1,3 +1,4 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
 Module for testing a fitting library validity with hepstats.
 
diff --git a/src/hepstats/utils/fit/diverse.py b/src/hepstats/utils/fit/diverse.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 from __future__ import annotations
 
 from collections.abc import Mapping
diff --git a/src/hepstats/utils/fit/sampling.py b/src/hepstats/utils/fit/sampling.py
@@ -1,3 +1,4 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 """
 Module providing basic sampling methods.
 """
diff --git a/test_simultaneous_fit.py b/test_simultaneous_fit.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 """
 Test simultaneous fits with different parameter sharing scenarios.
 """
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 from __future__ import annotations
 
 import numpy as np
diff --git a/tests/hypotests/test_basetest.py b/tests/hypotests/test_basetest.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import pytest
 import numpy as np
 zfit = pytest.importorskip("zfit")
diff --git a/tests/hypotests/test_calculators.py b/tests/hypotests/test_calculators.py
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
 
 import numpy as np
 import pytest
diff --git a/tests/hypotests/test_confidence_intervals.py b/tests/hypotests/test_confidence_intervals.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import pytest
 import numpy as np
 zfit = pytest.importorskip("zfit")
diff --git a/tests/hypotests/test_discovery.py b/tests/hypotests/test_discovery.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import os
 
 import numpy as np
diff --git a/tests/hypotests/test_parameters.py b/tests/hypotests/test_parameters.py
@@ -1,4 +1,5 @@
-#!/usr/bin/python
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import pytest
 import numpy as np
 zfit = pytest.importorskip("zfit")
diff --git a/tests/hypotests/test_simultaneous_fit.py b/tests/hypotests/test_simultaneous_fit.py
@@ -0,0 +1,187 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
+"""
+Test simultaneous fits with different parameter sharing scenarios.
+"""
+
+from __future__ import annotations
+
+import os
+
+os.environ["TQDM_DISABLE"] = "1"
+
+import numpy as np
+import pytest
+
+zfit = pytest.importorskip("zfit")
+from zfit.loss import UnbinnedNLL  # noqa: E402
+from zfit.minimize import Minuit  # noqa: E402
+
+from hepstats.hypotests.calculators import FrequentistCalculator  # noqa: E402
+from hepstats.hypotests.parameters import POI, POIarray  # noqa: E402
+
+
+def create_no_shared_params_loss():
+    """Create simultaneous loss where PDFs share NO parameters (2 losses)."""
+    obs1 = zfit.Space("x", limits=(0.0, 3.0))
+    mu1 = zfit.Parameter("mu1", 1.0, 0.0, 3.0)
+    sigma1 = zfit.Parameter("sigma1", 0.3)
+    sigma1.floating = False
+    model1 = zfit.pdf.Gauss(obs=obs1, mu=mu1, sigma=sigma1)
+
+    obs2 = zfit.Space("y", limits=(0.0, 3.0))
+    mu2 = zfit.Parameter("mu2", 2.0, 0.0, 3.0)
+    sigma2 = zfit.Parameter("sigma2", 0.3)
+    sigma2.floating = False
+    model2 = zfit.pdf.Gauss(obs=obs2, mu=mu2, sigma=sigma2)
+
+    data1 = zfit.data.Data.from_numpy(obs=obs1, array=np.random.normal(1.0, 0.3, 500))
+    data2 = zfit.data.Data.from_numpy(obs=obs2, array=np.random.normal(2.0, 0.3, 500))
+
+    loss = UnbinnedNLL(model=model1, data=data1) + UnbinnedNLL(model=model2, data=data2)
+    return loss, mu1, 1.5, 0.0
+
+
+def create_all_shared_params_loss():
+    """Create simultaneous loss where PDFs share ALL parameters (2 losses)."""
+    mu = zfit.Parameter("mu_shared", 1.5, 0.0, 3.0)
+    sigma = zfit.Parameter("sigma_shared", 0.3)
+    sigma.floating = False
+
+    obs1 = zfit.Space("x", limits=(0.0, 3.0))
+    obs2 = zfit.Space("y", limits=(0.0, 3.0))
+
+    model1 = zfit.pdf.Gauss(obs=obs1, mu=mu, sigma=sigma)
+    model2 = zfit.pdf.Gauss(obs=obs2, mu=mu, sigma=sigma)
+
+    data1 = zfit.data.Data.from_numpy(obs=obs1, array=np.random.normal(1.5, 0.3, 500))
+    data2 = zfit.data.Data.from_numpy(obs=obs2, array=np.random.normal(1.5, 0.3, 500))
+
+    loss = UnbinnedNLL(model=model1, data=data1) + UnbinnedNLL(model=model2, data=data2)
+    return loss, mu, 2.0, 0.0
+
+
+def create_some_shared_params_loss():
+    """Create simultaneous loss where PDFs share SOME parameters (2 losses)."""
+    mu = zfit.Parameter("mu_common", 1.2, 0.0, 3.0)
+    sigma1 = zfit.Parameter("sigma1", 0.3)
+    sigma2 = zfit.Parameter("sigma2", 0.4)
+    sigma1.floating = False
+    sigma2.floating = False
+
+    obs1 = zfit.Space("x", limits=(0.0, 3.0))
+    obs2 = zfit.Space("y", limits=(0.0, 3.0))
+
+    model1 = zfit.pdf.Gauss(obs=obs1, mu=mu, sigma=sigma1)
+    model2 = zfit.pdf.Gauss(obs=obs2, mu=mu, sigma=sigma2)
+
+    data1 = zfit.data.Data.from_numpy(obs=obs1, array=np.random.normal(1.2, 0.3, 500))
+    data2 = zfit.data.Data.from_numpy(obs=obs2, array=np.random.normal(1.2, 0.4, 500))
+
+    loss = UnbinnedNLL(model=model1, data=data1) + UnbinnedNLL(model=model2, data=data2)
+    return loss, mu, 1.8, 0.5
+
+
+def create_mixed_loss():
+    """Create simultaneous loss mixing all sharing patterns (5 losses).
+
+    - Loss 1-2: Share mu_shared (POI) and sigma_shared
+    - Loss 3: Independent mu3, sigma3
+    - Loss 4-5: Share mu_shared (POI) but have independent sigmas
+    """
+    mu_shared = zfit.Parameter("mu_shared", 1.5, 0.0, 3.0)
+    sigma_shared = zfit.Parameter("sigma_shared", 0.3)
+    sigma_shared.floating = False
+
+    # Losses 1-2: All shared params
+    obs1 = zfit.Space("x1", limits=(0.0, 3.0))
+    obs2 = zfit.Space("x2", limits=(0.0, 3.0))
+    model1 = zfit.pdf.Gauss(obs=obs1, mu=mu_shared, sigma=sigma_shared)
+    model2 = zfit.pdf.Gauss(obs=obs2, mu=mu_shared, sigma=sigma_shared)
+    data1 = zfit.data.Data.from_numpy(obs=obs1, array=np.random.normal(1.5, 0.3, 500))
+    data2 = zfit.data.Data.from_numpy(obs=obs2, array=np.random.normal(1.5, 0.3, 500))
+
+    # Loss 3: No shared params (independent)
+    obs3 = zfit.Space("x3", limits=(0.0, 3.0))
+    mu3 = zfit.Parameter("mu3", 2.0, 0.0, 3.0)
+    sigma3 = zfit.Parameter("sigma3", 0.35)
+    sigma3.floating = False
+    model3 = zfit.pdf.Gauss(obs=obs3, mu=mu3, sigma=sigma3)
+    data3 = zfit.data.Data.from_numpy(obs=obs3, array=np.random.normal(2.0, 0.35, 500))
+
+    # Losses 4-5: Share mu_shared but independent sigmas
+    obs4 = zfit.Space("x4", limits=(0.0, 3.0))
+    obs5 = zfit.Space("x5", limits=(0.0, 3.0))
+    sigma4 = zfit.Parameter("sigma4", 0.25)
+    sigma5 = zfit.Parameter("sigma5", 0.4)
+    sigma4.floating = False
+    sigma5.floating = False
+    model4 = zfit.pdf.Gauss(obs=obs4, mu=mu_shared, sigma=sigma4)
+    model5 = zfit.pdf.Gauss(obs=obs5, mu=mu_shared, sigma=sigma5)
+    data4 = zfit.data.Data.from_numpy(obs=obs4, array=np.random.normal(1.5, 0.25, 500))
+    data5 = zfit.data.Data.from_numpy(obs=obs5, array=np.random.normal(1.5, 0.4, 500))
+
+    loss = (
+        UnbinnedNLL(model=model1, data=data1)
+        + UnbinnedNLL(model=model2, data=data2)
+        + UnbinnedNLL(model=model3, data=data3)
+        + UnbinnedNLL(model=model4, data=data4)
+        + UnbinnedNLL(model=model5, data=data5)
+    )
+    return loss, mu_shared, 2.0, 0.5
+
+
+@pytest.mark.parametrize(
+    "loss_factory",
+    [
+        create_no_shared_params_loss,
+        create_all_shared_params_loss,
+        create_some_shared_params_loss,
+        create_mixed_loss,
+    ],
+    ids=["no_shared", "all_shared", "some_shared", "mixed_5losses"],
+)
+def test_simultaneous_fit_null_toys(loss_factory):
+    """Test that null toys cluster around the null hypothesis value."""
+    np.random.seed(42)
+
+    loss, poi_param, null_value, alt_value = loss_factory()
+
+    calc = FrequentistCalculator(loss, Minuit(), ntoysnull=20, ntoysalt=20)
+
+    poi_null = POIarray(poi_param, [null_value])
+    poi_alt = POI(poi_param, alt_value)
+
+    toysresults = calc.get_toys_null(poi_null, poi_alt, qtilde=False)
+    toys = toysresults[POI(poi_param, null_value)]
+
+    assert np.abs(np.mean(toys.bestfit) - null_value) < 0.15, (
+        f"Expected null toys around {null_value}, got {np.mean(toys.bestfit):.3f}"
+    )
+
+
+@pytest.mark.parametrize(
+    "loss_factory",
+    [
+        create_some_shared_params_loss,
+        create_mixed_loss,
+    ],
+    ids=["some_shared", "mixed_5losses"],
+)
+def test_simultaneous_fit_alt_toys(loss_factory):
+    """Test that alt toys cluster around the alt hypothesis value."""
+    np.random.seed(42)
+
+    loss, poi_param, null_value, alt_value = loss_factory()
+
+    calc = FrequentistCalculator(loss, Minuit(), ntoysnull=20, ntoysalt=20)
+
+    poi_null = POIarray(poi_param, [null_value])
+    poi_alt = POI(poi_param, alt_value)
+
+    toysresults_alt = calc.get_toys_alt(poi_alt, poi_null, qtilde=False)
+    toys_alt = toysresults_alt[poi_alt]
+
+    assert np.abs(np.mean(toys_alt.bestfit) - alt_value) < 0.15, (
+        f"Expected alt toys around {alt_value}, got {np.mean(toys_alt.bestfit):.3f}"
+    )
diff --git a/tests/hypotests/test_toysutils.py b/tests/hypotests/test_toysutils.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import pytest
 import numpy as np
 zfit = pytest.importorskip("zfit")
diff --git a/tests/hypotests/test_upperlimit.py b/tests/hypotests/test_upperlimit.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import pytest
 import numpy as np
 import os
diff --git a/tests/modeling/__init__.py b/tests/modeling/__init__.py
@@ -1 +1 @@
-# Licensed under a 3-clause BSD style license, see LICENSE.
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
diff --git a/tests/modeling/test_bayesianblocks.py b/tests/modeling/test_bayesianblocks.py
@@ -1,8 +1,9 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 from pathlib import Path
 
 import numpy as np
 
-import hepstats
 from hepstats.modeling import bayesian_blocks
 
 answer_dir = Path(__file__).parent / "data"
diff --git a/tests/splots/test_splots.py b/tests/splots/test_splots.py
@@ -1,3 +1,5 @@
+# Licensed under a 3-clause BSD style license, see LICENSES folder.
+
 import numpy as np
 import pytest
 from scipy.stats import ks_2samp

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# Licensed under a 3-clause BSD style license, see LICENSES folder.`
	`2`	`+`
`1`	`3`	`from ._version import version as __version__`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Licensed under a 3-clause BSD style license, see LICENSE.`
	`1`	`+# Licensed under a 3-clause BSD style license, see LICENSES folder.`
`2`	`2`	`"""`
`3`	`3`	`Module for hypothesis tests, upper limits and confidence intervals calculations.`
`4`	`4`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# Licensed under a 3-clause BSD style license, see LICENSES folder.`
`1`	`2`	`from __future__ import annotations`
`2`	`3`
`3`	`4`	`import warnings`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Licensed under a 3-clause BSD style license, see LICENSES folder.`
	`2`	`+`
`1`	`3`	`from .fit import (`
`2`	`4`	`eval_pdf,`
`3`	`5`	`array2dataset,`