plothist 1.3.2__py3-none-any.whl → 1.4.0__py3-none-any.whl

plothist/__init__.py

@@ -1,115 +1,107 @@
+from __future__ import annotations
+
+from ._version import version as __version__
+from .comparison import (
+    get_asymmetrical_uncertainties,
+    get_comparison,
+    get_difference,
+    get_pull,
+    get_ratio,
+    get_ratio_variances,
+)
+from .histogramming import (
+    create_axis,
+    flatten_2d_hist,
+    make_2d_hist,
+    make_hist,
+)
+from .plothist_style import (
+    add_luminosity,
+    add_text,
+    cubehelix_palette,
+    get_color_palette,
+    plot_reordered_legend,
+    set_fitting_ylabel_fontsize,
+    set_style,
+)
 from .plotters import (
     create_comparison_figure,
-    plot_hist,
     plot_2d_hist,
     plot_2d_hist_with_projections,
+    plot_comparison,
+    plot_data_model_comparison,
     plot_error_hist,
+    plot_function,
+    plot_hist,
     plot_hist_uncertainties,
+    plot_model,
     plot_two_hist_comparison,
-    plot_comparison,
     savefig,
-    plot_data_model_comparison,
-    plot_model,
-    plot_function,
 )
-
-from .histogramming import (
-    create_axis,
-    make_hist,
-    make_2d_hist,
-    flatten_2d_hist,
-)
-
 from .variable_registry import (
     create_variable_registry,
     get_variable_from_registry,
-    update_variable_registry,
     remove_variable_registry_parameters,
+    update_variable_registry,
     update_variable_registry_ranges,
 )
 
-from .comparison import (
-    get_asymmetrical_uncertainties,
-    get_comparison,
-    get_pull,
-    get_difference,
-    get_ratio,
-    get_ratio_variances,
-)
-
-from .plothist_style import (
-    set_style,
-    cubehelix_palette,
-    get_color_palette,
-    set_fitting_ylabel_fontsize,
-    add_text,
-    add_luminosity,
-    plot_reordered_legend,
-)
-
-from .get_dummy_data import get_dummy_data
-
 __all__ = [
     "__version__",
+    "add_luminosity",
+    "add_text",
+    "create_axis",
+    "create_comparison_figure",
     "create_variable_registry",
+    "cubehelix_palette",
+    "flatten_2d_hist",
+    "get_asymmetrical_uncertainties",
+    "get_color_palette",
+    "get_comparison",
+    "get_difference",
+    "get_pull",
+    "get_ratio",
+    "get_ratio_variances",
     "get_variable_from_registry",
-    "update_variable_registry",
-    "remove_variable_registry_parameters",
-    "update_variable_registry_ranges",
-    "create_comparison_figure",
-    "create_axis",
-    "make_hist",
     "make_2d_hist",
-    "plot_hist",
+    "make_hist",
     "plot_2d_hist",
     "plot_2d_hist_with_projections",
+    "plot_comparison",
+    "plot_data_model_comparison",
     "plot_error_hist",
+    "plot_function",
+    "plot_hist",
     "plot_hist_uncertainties",
+    "plot_model",
+    "plot_reordered_legend",
     "plot_two_hist_comparison",
-    "plot_comparison",
+    "remove_variable_registry_parameters",
     "savefig",
-    "plot_data_model_comparison",
-    "plot_model",
-    "plot_function",
-    "add_luminosity",
-    "get_asymmetrical_uncertainties",
-    "set_style",
-    "cubehelix_palette",
-    "get_color_palette",
     "set_fitting_ylabel_fontsize",
-    "add_text",
-    "get_asymmetrical_uncertainties",
-    "get_comparison",
-    "get_pull",
-    "get_difference",
-    "get_ratio",
-    "get_ratio_variances",
-    "flatten_2d_hist",
-    "plot_reordered_legend",
-    "get_dummy_data",
+    "set_style",
+    "update_variable_registry",
+    "update_variable_registry_ranges",
 ]
 
 
 # Get style file and use it
-import matplotlib.pyplot as plt
 from importlib.resources import files
 
+import matplotlib.pyplot as plt
+
 style_file = files("plothist").joinpath("default_style.mplstyle")
 plt.style.use(style_file)
 
-# Check the fonts
-from matplotlib.font_manager import findfont
-import warnings
+# Install fonts
+from importlib import resources
+
+import matplotlib.font_manager as fm
 
-for font_type in ["Math", "Sans", "Roman"]:
-    try:
-        findfont(f"Latin Modern {font_type}", fallback_to_default=False)
-    except:
-        warnings.warn(
-            "The recommended fonts to use plothist were not found. You can install them by typing 'install_latin_modern_fonts' in your terminal. If it still does not work, please check the documentation at https://plothist.readthedocs.io/en/latest/usage/font_installation.html",
-            stacklevel=3,
-        )
-        break
+with resources.as_file(resources.files("plothist_utils") / "fonts") as font_path:
+    font_files = fm.findSystemFonts(fontpaths=[str(font_path)])
+    for font in font_files:
+        fm.fontManager.addfont(font)
 
 # Check version of boost_histogram
 import boost_histogram as bh

plothist/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '1.4.0'
+__version_tuple__ = version_tuple = (1, 4, 0)

plothist/_version.pyi

@@ -0,0 +1,2 @@
+version: str
+version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]

plothist/comparison.py

@@ -1,5 +1,8 @@
+from __future__ import annotations
+
 import numpy as np
-import scipy.stats as stats
+from scipy import stats
+
 from plothist.histogramming import _check_counting_histogram
 
 

plothist/histogramming.py

@@ -1,6 +1,9 @@
+from __future__ import annotations
+
+import warnings
+
 import boost_histogram as bh
 import numpy as np
-import warnings
 
 
 # Define a custom warning for range issues
@@ -12,7 +15,7 @@ class RangeWarning(Warning):
 warnings.filterwarnings("always", category=RangeWarning)
 
 
-def create_axis(bins, range=None, data=np.array([]), overflow=False, underflow=False):
+def create_axis(bins, range=None, data=None, overflow=False, underflow=False):
     """
     Create an axis object for histogram binning based on the input data and parameters.
 
@@ -23,7 +26,7 @@ def create_axis(bins, range=None, data=np.array([]), overflow=False, underflow=F
     range : None or tuple, optional
         The range of the axis. If None, it will be determined based on the data.
     data : array-like, optional
-        The input data for determining the axis range. Default is an empty array.
+        The input data for determining the axis range. Default is None.
     overflow : bool, optional
         Whether to include an overflow bin. If False, the upper edge of the last bin is inclusive. Default is False.
     underflow : bool, optional
@@ -46,6 +49,8 @@ def create_axis(bins, range=None, data=np.array([]), overflow=False, underflow=F
     ValueError
         If the range parameter contains "min" or "max" but the data is empty.
     """
+    if data is None:
+        data = np.array([])
 
     try:
         N = len(bins)
@@ -94,15 +99,15 @@ def create_axis(bins, range=None, data=np.array([]), overflow=False, underflow=F
     return bh.axis.Regular(bins, x_min, x_max, underflow=underflow, overflow=overflow)
 
 
-def make_hist(data=np.array([]), bins=50, range=None, weights=1):
+def make_hist(data=None, bins=50, range=None, weights=1):
     """
     Create a histogram object and fill it with the provided data.
 
     Parameters
     ----------
     data : array-like, optional
-        1D array-like data used to fill the histogram (default is an empty array).
-        If an empty array, an empty histogram is returned.
+        1D array-like data used to fill the histogram (default is None).
+        If None is provided, an empty histogram is returned.
     bins : int or tuple, optional
         Binning specification for the histogram (default is 50).
         If an integer, it represents the number of bins.
@@ -125,6 +130,8 @@ def make_hist(data=np.array([]), bins=50, range=None, weights=1):
     RangeWarning
         If more than 1% of the data is outside of the binning range.
     """
+    if data is None:
+        data = np.array([])
 
     axis = create_axis(bins, range, data)
 
@@ -145,7 +152,7 @@ def make_hist(data=np.array([]), bins=50, range=None, weights=1):
         # Issue a warning if more than 1% of the data is outside of the binning range
         if range_coverage < 0.99:
             warnings.warn(
-                f"Only {100*range_coverage:.2f}% of data contained in the binning range [{axis.edges[0]}, {axis.edges[-1]}].",
+                f"Only {100 * range_coverage:.2f}% of data contained in the binning range [{axis.edges[0]}, {axis.edges[-1]}].",
                 category=RangeWarning,
                 stacklevel=2,
             )
@@ -153,15 +160,15 @@ def make_hist(data=np.array([]), bins=50, range=None, weights=1):
     return h
 
 
-def make_2d_hist(data=np.array([[], []]), bins=(10, 10), range=(None, None), weights=1):
+def make_2d_hist(data=None, bins=(10, 10), range=(None, None), weights=1):
     """
     Create a 2D histogram object and fill it with the provided data.
 
     Parameters
     ----------
     data : array-like, optional
-        2D array-like data used to fill the histogram (default is an empty array).
-        If an empty array, an empty histogram is returned.
+        2D array-like data used to fill the histogram (default is None).
+        If None is provided, an empty histogram is returned.
     bins : tuple, optional
         Binning specification for each dimension of the histogram (default is (10, 10)).
         Each element of the tuple represents the number of bins for the corresponding dimension.
@@ -190,6 +197,8 @@ def make_2d_hist(data=np.array([[], []]), bins=(10, 10), range=(None, None), wei
     RangeWarning
         If more than 1% of the data is outside of the binning range.
     """
+    if data is None:
+        data = np.array([[], []])
     if len(data) != 2:
         raise ValueError("data should have two components, x and y")
     if len(data[0]) != len(data[1]):
@@ -219,7 +228,7 @@ def make_2d_hist(data=np.array([[], []]), bins=(10, 10), range=(None, None), wei
         # Issue a warning if more than 1% of the data is outside of the binning range
         if range_coverage < 0.99:
             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]}]).",
+                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,
                 stacklevel=2,
             )
@@ -246,7 +255,6 @@ def _check_counting_histogram(hist):
         raise ValueError(
             f"The histogram must be a counting histogram, but the input histogram has kind {hist.kind}."
         )
-    return
 
 
 def _make_hist_from_function(func, ref_hist):

plothist/plothist_style.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
+from importlib.resources import files
+
+import matplotlib as mpl
 import matplotlib.pyplot as plt
 import numpy as np
-import matplotlib as mpl
-from importlib.resources import files
 
 
 def set_style(style="default"):
@@ -87,7 +90,7 @@ def cubehelix_palette(
         # Adapted from matplotlib
         def color(lambda_):
             # emphasise either low intensity values (gamma < 1),
-            # or high intensity values (γ > 1)
+            # or high intensity values (gamma > 1)
             lambda_gamma = lambda_**gamma
 
             # Angle and amplitude for the deviation
@@ -159,7 +162,7 @@ def get_color_palette(cmap, N):
             "#FFB5B8",
         ][0:N]
 
-    elif cmap == "cubehelix":
+    if cmap == "cubehelix":
         return cubehelix_palette(N)
 
     if N < 2:
@@ -296,7 +299,7 @@ def add_text(
 
     # Add background
     if white_background:
-        t.set_bbox(dict(facecolor="white", edgecolor="white"))
+        t.set_bbox({"facecolor": "white", "edgecolor": "white"})
 
 
 def add_luminosity(
@@ -424,8 +427,7 @@ def plot_reordered_legend(ax, order, **kwargs):
     # Check if order is valid
     if not all(i in range(len(labels)) for i in order) or len(set(order)) < len(order):
         raise ValueError(
-            "The order list should contain all integers from 0 to "
-            f"{len(labels) - 1}."
+            f"The order list should contain all integers from 0 to {len(labels) - 1}."
         )
 
     # Reorder handlers and labels