rootfig 0.1.0__py3-none-any.whl

rootfig/__init__.py

@@ -0,0 +1,97 @@
+"""rootfig: publication-quality histograms straight from ROOT trees, without ROOT.
+
+The quick path::
+
+    import rootfig as rf
+
+    rf.plot("events.root", "Muon_pt", tree="events", selection="Muon_pt > 20", bins=50)
+
+The composable path uses :class:`Sample`, :class:`Variable`, :class:`Cut` and
+:class:`Style` objects with the same :func:`plot` function. Lower layers are
+exposed as sub-packages: :mod:`rootfig.io`, :mod:`rootfig.expressions`,
+:mod:`rootfig.selection`, :mod:`rootfig.histograms`, :mod:`rootfig.plotting`.
+"""
+
+from rootfig.api import (
+    SummaryTable,
+    correlation,
+    cutflow,
+    efficiency,
+    histogram,
+    histograms,
+    load,
+    plot,
+    plot2d,
+    plot_histograms,
+    profile,
+    summarize,
+)
+from rootfig.errors import (
+    BinningError,
+    ExpressionError,
+    IncompatibleWeightError,
+    LuminosityError,
+    MissingBranchError,
+    RootfigError,
+    RootfigWarning,
+    SelectionError,
+    SourceError,
+)
+from rootfig.expressions import evaluate
+from rootfig.histograms import (
+    Cutflow,
+    CutflowTable,
+    Efficiency,
+    Histogram,
+    Profile,
+    Ratio,
+    Summary,
+    ratio,
+    significance,
+)
+from rootfig.model import Cut, Sample, Style, Variable, log_bins
+from rootfig.plotting import Plot, use_style
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "BinningError",
+    "Cut",
+    "Cutflow",
+    "CutflowTable",
+    "Efficiency",
+    "ExpressionError",
+    "Histogram",
+    "IncompatibleWeightError",
+    "LuminosityError",
+    "MissingBranchError",
+    "Plot",
+    "Profile",
+    "Ratio",
+    "RootfigError",
+    "RootfigWarning",
+    "Sample",
+    "SelectionError",
+    "SourceError",
+    "Style",
+    "Summary",
+    "SummaryTable",
+    "Variable",
+    "__version__",
+    "correlation",
+    "cutflow",
+    "efficiency",
+    "evaluate",
+    "histogram",
+    "histograms",
+    "load",
+    "log_bins",
+    "plot",
+    "plot2d",
+    "plot_histograms",
+    "profile",
+    "ratio",
+    "significance",
+    "summarize",
+    "use_style",
+]

rootfig/_typing.py

@@ -0,0 +1,21 @@
+"""Shared type aliases."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, TypeAlias
+
+import hist
+import numpy as np
+import numpy.typing as npt
+
+if TYPE_CHECKING:
+    Hist: TypeAlias = hist.Hist[Any]
+    """A ``hist.Hist`` with any storage (``Weight`` in everything rootfig produces)."""
+else:
+    Hist = hist.Hist
+
+FloatArray: TypeAlias = npt.NDArray[np.float64]
+"""A one-dimensional float array."""
+
+AnyArray: TypeAlias = npt.NDArray[Any]
+"""A NumPy array of any dtype."""