plothist 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

plothist/__init__.py

@@ -9,12 +9,7 @@ from .comparison import (
     get_ratio,
     get_ratio_variances,
 )
-from .histogramming import (
-    create_axis,
-    flatten_2d_hist,
-    make_2d_hist,
-    make_hist,
-)
+from .histogramming import create_axis, flatten_2d_hist, make_2d_hist, make_hist
 from .plothist_style import (
     add_luminosity,
     add_text,
@@ -43,6 +38,7 @@ from .variable_registry import (
     get_variable_from_registry,
     remove_variable_registry_parameters,
     update_variable_registry,
+    update_variable_registry_binning,
     update_variable_registry_ranges,
 )
 
@@ -81,6 +77,7 @@ __all__ = [
     "set_fitting_ylabel_fontsize",
     "set_style",
     "update_variable_registry",
+    "update_variable_registry_binning",
     "update_variable_registry_ranges",
 ]
 

plothist/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '1.6.0'
-__version_tuple__ = version_tuple = (1, 6, 0)
+__version__ = version = '1.7.0'
+__version_tuple__ = version_tuple = (1, 7, 0)
+
+__commit_id__ = commit_id = None

plothist/examples/2d_hist/2d_hist_correlations.py

@@ -20,7 +20,7 @@ from plothist import (
     get_variable_from_registry,
     make_2d_hist,
     plot_2d_hist,
-    update_variable_registry_ranges,
+    update_variable_registry_binning,
 )
 
 # No need to redo this step if the registry was already created before
@@ -28,7 +28,7 @@ variable_keys = ["variable_0", "variable_1", "variable_2"]
 unique_id = str(int(time.time() * 1000))[-8:]  # unique ID based on current time
 temporary_registry_path = f"./_temporary_variable_registry_{unique_id}.yaml"
 create_variable_registry(variable_keys, path=temporary_registry_path)
-update_variable_registry_ranges(df, variable_keys, path=temporary_registry_path)
+update_variable_registry_binning(df, variable_keys, path=temporary_registry_path)
 
 # Get all the correlation plot between the variables
 variable_keys_combinations = list(combinations(variable_keys, 2))

plothist/histogramming.py

@@ -109,6 +109,7 @@ def make_hist(
     bins: int | list[float] | np.ndarray = 50,
     range: tuple[float | str, float | str] | None = None,
     weights: float | list[float] | np.ndarray = 1,
+    mute_warning: bool = False,
 ) -> bh.Histogram:
     """
     Create a histogram object and fill it with the provided data.
@@ -129,6 +130,8 @@ def make_hist(
         Weight(s) to apply to the data points (default is 1).
         If a float, a single weight is applied to all data points.
         If an array-like, weights are applied element-wise.
+    mute_warning : bool, optional
+        Whether to mute warnings about data outside the binning range (default is False).
 
     Returns
     -------
@@ -160,7 +163,7 @@ def make_hist(
         range_coverage = h.sum().value / n_data
 
         # Issue a warning if more than 1% of the data is outside of the binning range
-        if range_coverage < 0.99:
+        if range_coverage < 0.99 and not mute_warning:
             warnings.warn(
                 f"Only {100 * range_coverage:.2f}% of data contained in the binning range [{axis.edges[0]}, {axis.edges[-1]}].",
                 category=RangeWarning,
@@ -177,6 +180,7 @@ def make_2d_hist(
         tuple[float | str, float | str] | None, tuple[float | str, float | str] | None
     ] = (None, None),
     weights: float | list[float] | np.ndarray = 1,
+    mute_warning: bool = False,
 ) -> bh.Histogram:
     """
     Create a 2D histogram object and fill it with the provided data.
@@ -198,6 +202,8 @@ def make_2d_hist(
         Weight(s) to apply to the data points (default is 1).
         If a float, a single weight is applied to all data points.
         If an array-like, weights are applied element-wise.
+    mute_warning : bool, optional
+        Whether to mute warnings about data outside the binning range (default is False).
 
     Returns
     -------
@@ -245,7 +251,7 @@ def make_2d_hist(
         range_coverage = h.sum().value / n_data
 
         # Issue a warning if more than 1% of the data is outside of the binning range
-        if range_coverage < 0.99:
+        if range_coverage < 0.99 and not mute_warning:
             warnings.warn(
                 f"Only {100 * range_coverage:.2f}% of data contained in the binning range ([{x_axis.edges[0]}, {x_axis.edges[-1]}], [{y_axis.edges[0]}, {y_axis.edges[-1]}]).",
                 category=RangeWarning,

plothist/variable_registry.py

@@ -8,6 +8,7 @@ import os
 import warnings
 
 import boost_histogram as bh
+import numpy as np
 import yaml
 
 from plothist.histogramming import create_axis
@@ -126,7 +127,7 @@ def create_variable_registry(
                         {
                             variable_key: {
                                 "name": variable_key,
-                                "bins": 50,
+                                "bins": "auto",
                                 "range": ("min", "max"),
                                 "label": variable_key,
                                 "log": False,
@@ -259,25 +260,37 @@ def remove_variable_registry_parameters(
     _save_variable_registry(variable_registry, path=path)
 
 
-def update_variable_registry_ranges(
+def update_variable_registry_ranges(*args, **kwargs):
+    warnings.warn(
+        "`update_variable_registry_ranges` is deprecated since v1.7.0 and will be removed in future versions. "
+        "Use `update_variable_registry_binning` instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return update_variable_registry_binning(*args, **kwargs)
+
+
+def update_variable_registry_binning(
     data,
     variable_keys: list[str] | None = None,
     path: str = "./variable_registry.yaml",
     overwrite: bool = False,
 ) -> None:
     """
-    Update the range parameters for multiple variables in the variable registry file.
+    Update both the bins and range parameters for multiple variables in the variable registry file.
 
     Parameters
     ----------
     data : numpy.ndarray or pandas.DataFrame
         A dataset containing the data for the variables.
     variable_keys : list[str]
-        A list of variable keys for which to update the range parameters in the registry. The variable needs to have a bin and range properties in the registry. Default is None: all variables in the registry are updated.
+        A list of variable keys for which to update the parameters in the registry.
+        The variable needs to have a bin and range properties in the registry.
+        Default is None: all variables in the registry are updated.
     path : str, optional
         The path to the variable registry file (default is "./variable_registry.yaml").
     overwrite : bool, optional
-        If True, the range parameters will be overwritten even if it's not equal to ("min", "max") (default is False).
+        If True, the bin and range parameters will be overwritten even if they differ from "auto" and ("min", "max") (default is False).
 
     Returns
     -------
@@ -302,13 +315,23 @@ def update_variable_registry_ranges(
                 f"Variable {variable_key} does not have a name, bins or range property in the registry {path}."
             )
 
-        range = ("min", "max") if overwrite else variable["range"]
+        bins = "auto" if overwrite else variable["bins"]
+        bin_number = len(np.histogram_bin_edges(data[variable["name"]], bins=bins)) - 1
 
-        if tuple(range) == ("min", "max"):
-            axis = create_axis(variable["bins"], tuple(range), data[variable["name"]])
+        range_val = ("min", "max") if overwrite else variable["range"]
+
+        if bins == "auto" or tuple(range_val) == ("min", "max"):
+            axis = create_axis(
+                bin_number,
+                tuple(range_val),
+                data[variable["name"]],
+            )
             if isinstance(axis, bh.axis.Regular):
                 update_variable_registry(
-                    {"range": (float(axis.edges[0]), float(axis.edges[-1]))},
+                    {
+                        "bins": bin_number,
+                        "range": (float(axis.edges[0]), float(axis.edges[-1])),
+                    },
                     [variable_key],
                     path=path,
                     overwrite=True,

{plothist-1.6.0.dist-info → plothist-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plothist
-Version: 1.6.0
+Version: 1.7.0
 Summary: Plot histograms in a scalable way and a beautiful style.
 Project-URL: Homepage, https://github.com/cyrraz/plothist
 Project-URL: Documentation, https://plothist.readthedocs.io/

{plothist-1.6.0.dist-info → plothist-1.7.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-plothist/__init__.py,sha256=ikcYOZqMs4WKAJ2rM-3BnHu_CQxLlQCuc-iFo_a-Mns,2760
-plothist/_version.py,sha256=5FGJNp9Lkk9uOxeCjXpoCGBF79Ar6LGPOR7-atBqb_4,511
+plothist/__init__.py,sha256=-cUpXXg2cCdfjcbYAQWHLUHq-5kLsxSWgEbgtZYjqBA,2817
+plothist/_version.py,sha256=oGRWiKvEGHesjf5wCNHGVlYfAA3dInDJeL5EiMaru6A,704
 plothist/_version.pyi,sha256=o7uNL6MhuJoiqpEnriU7rBT6TmkJZA-i2qMoNz9YcgQ,82
 plothist/comparison.py,sha256=jkONOiCp8RNBk8V_VvwACdfJJqo89rK9NQW71XxJscc,19623
 plothist/default_style.mplstyle,sha256=7MmB2uiXmD_DSqFHeH1xxC-lTctBD_EASxMdSOsPep0,1574
-plothist/histogramming.py,sha256=o0RLdoEhxHA7Ws0bvK3DewsbQEu-QOtJNw5Md5AckHM,11474
+plothist/histogramming.py,sha256=Q0KRQjdyZGXj7J-qlXgzUbb-s7duqZG4QD2BIuVNQes,11828
 plothist/plothist_style.py,sha256=bbYFc-qsrTfdbacCBAAzmiHJoRIh3toBomFfxtTRNMs,13255
 plothist/plotters.py,sha256=ncPZa34Fo1mbFxv0guFc2zEciX_JXGKJxeIfcUDaP6w,46336
 plothist/test_helpers.py,sha256=JXhxUdqMszkawxkU8cDPqipkSXNHfsKSfe3K-4frDrM,1379
-plothist/variable_registry.py,sha256=usVLoDLbIMzjeRDazIH0OIjQIUsh9RSJ9Ncnhn1V9qw,10783
+plothist/variable_registry.py,sha256=lYQ1DxUXBtY_UlZcuvwf_XQllq5MdPFKBmIrnRTNauo,11536
 plothist/examples/README.rst,sha256=PVzkOQzVnNeWORxEv3NNv5XoSN2Y71D7SYzRkCqirfA,151
 plothist/examples/1d_hist/1d_comparison_asymmetry.py,sha256=Rp9gv6E5z9KgIhnraS9AjGSMgHLhSHd_u5L-vG0w-gU,757
 plothist/examples/1d_hist/1d_comparison_difference.py,sha256=FMKoTjMIQp6VsFXspVBy2AdxHPDnxhMfj9PCvE4qVjk,877
@@ -26,7 +26,7 @@ plothist/examples/1d_hist/1d_profile.py,sha256=otmerm64DNAYnRWaablQkQDgUVOvjLNDc
 plothist/examples/1d_hist/1d_side_by_side.py,sha256=sAHhBVnopINQscFaUpVI4KNs18e_1laHyrYBOlmU_fQ,1557
 plothist/examples/1d_hist/1d_str_category.py,sha256=2DtxfNMAlcZ6pYx44lP0-sgY4M73-R0aBH61uEJmKA0,880
 plothist/examples/1d_hist/README.rst,sha256=GT4-w9W-TDtjOqibOPcd6vYzAGO8bDsgxBRp3fD1uTw,100
-plothist/examples/2d_hist/2d_hist_correlations.py,sha256=OroqVDKjNlAiMVXZ1AvFarV3qESiFkL0dnnb_NFkI70,1834
+plothist/examples/2d_hist/2d_hist_correlations.py,sha256=c9PMymxNn9Kz0STvDQ3Pro4ndv-1PVG5RZsJCS9gobA,1836
 plothist/examples/2d_hist/2d_hist_simple.py,sha256=1n5yqOJxHzD31njOk85dTjuXhkogCDIS4-EG63XcnQ0,521
 plothist/examples/2d_hist/2d_hist_simple_discrete_colormap.py,sha256=E1zeMIDP25R_ppkB-wDz7TxaLsxf7dCs87FrPTPWTAc,1000
 plothist/examples/2d_hist/2d_hist_uneven.py,sha256=kR53XrSx38efG1wHEI69BIcPKVQzJygkr7ax_CFzBIA,646
@@ -57,8 +57,8 @@ plothist/examples/utility/color_palette_hists.py,sha256=uIc6TrmjTj8EUif1Yj1wq4nX
 plothist/examples/utility/color_palette_squares.py,sha256=pNasgvZZApu-sCqhi5FTJAH3l6Px2cgB5RwJcQ1eF1U,2689
 plothist/examples/utility/matplotlib_vs_plothist_style.py,sha256=iEIfbFKmAN-PcDCzw_sBuhrfpes4I2wUVfC0r1vUHEw,2006
 plothist/examples/utility/uncertainty_types.py,sha256=r1yxzEvxn5Clv0ZIok9JjVh3RB-YQ_usWhFnpvl1els,3259
-plothist-1.6.0.dist-info/METADATA,sha256=WsoMGQrcmUasAx0UxEP9aGEw7LAk1eHQCrjUz6228fY,4737
-plothist-1.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plothist-1.6.0.dist-info/licenses/AUTHORS.md,sha256=02x3_8PNyTsXcRs0IlJeCTOmpGNRqymcJ71-2QtR37E,111
-plothist-1.6.0.dist-info/licenses/LICENSE,sha256=bfaEdGehofQDaw-zDdVMHNUKo1FrOm6oGUEF-ltrp6w,1523
-plothist-1.6.0.dist-info/RECORD,,
+plothist-1.7.0.dist-info/METADATA,sha256=X_mWIcy0jZbKaLcNPGaoL2jR4y1RnBYcnpQw-FgqlqM,4737
+plothist-1.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plothist-1.7.0.dist-info/licenses/AUTHORS.md,sha256=-2hRQyzJdkGgYPu8J-xDAWCwiqomcR56uYuzlJ4yMJM,115
+plothist-1.7.0.dist-info/licenses/LICENSE,sha256=bfaEdGehofQDaw-zDdVMHNUKo1FrOm6oGUEF-ltrp6w,1523
+plothist-1.7.0.dist-info/RECORD,,

plothist-1.7.0.dist-info/licenses/AUTHORS.md

@@ -0,0 +1,2 @@
+* Cyrille Praz ([@cyrraz](https://github.com/cyrraz))
+* Tristan Fillinger ([@0ctagon](https://github.com/0ctagon))

plothist-1.6.0.dist-info/licenses/AUTHORS.md

@@ -1,2 +0,0 @@
-Cyrille Praz ([@cyrraz](https://github.com/cyrraz))
-Tristan Fillinger ([@0ctagon](https://github.com/0ctagon))