refactor(api)!: cleanup, remove redundant, updated label positioning (#589)

* docs: update CITATION.cff

* feat(BREAKING): renames

* feat(BREAKING): removing extras

* feat(BREAKING): use seaborn in examples

feat(BREAKING): use seaborn in examples

fix: adjust cmap

* fix: update label positioning

* fix: update existing tests

* feat: add new add_text tests

Author: andrzejnovak

CONTRIBUTING.md

@@ -41,7 +41,7 @@ Note: This ignores the notebook tests (which are run via
 sure to run the complete suite before submitting a PR
 
 ```bash
-pytest --mpl
+python -m pytest -r sa --mpl --mpl-results-path=pytest_results -n 4
 ```
 
 ### Making a pull request
@@ -56,7 +56,7 @@ If you modified expected outcomes of the tests. New baseline visuals can be
 generated using this command:
 
 ```bash
-pytest --mpl-generate-path=tests/baseline
+ python -m pytest -r sa --mpl -n 4 --mpl-generate-path=tests/baseline
 ```
 
 Only include the actually modified baseline images in your PR! Running `git add

examples/1d_histograms/1d_comparison_difference.py

@@ -38,7 +38,12 @@
     comparison="difference",  # <--
 )
 
-add_text("Comparison of two hist with difference plot", ax=ax_main)
-add_text("Difference ax", x="right", ax=ax_comparison)
+add_text(
+    "Comparison of two hist with difference plot",
+    ax=ax_main,
+    fontsize="small",
+    loc="over left",
+)
+add_text("Difference ax", ax=ax_comparison, loc="over right", fontsize="small")
 
 fig.savefig("1d_comparison_difference.svg", bbox_inches="tight")

examples/model_ex/model_all_comparisons.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 
@@ -52,20 +52,24 @@
 background_hists = [background_scaling_factor * h for h in background_hists]
 
 ###
+import matplotlib.pyplot as plt
+
 from mplhep import (
     add_text,
-    create_comparison_figure,
     plot_comparison,
     plot_data_model_comparison,
     set_fitting_ylabel_fontsize,
 )
 
-fig, axes = create_comparison_figure(
-    figsize=(6, 13),
+fig, axes = plt.subplots(
     nrows=6,
+    figsize=(6, 13),
     gridspec_kw={"height_ratios": [3, 1, 1, 1, 1, 1]},
-    hspace=0.3,
 )
+fig.subplots_adjust(hspace=0.3)
+for ax in axes[:-1]:
+    ax.xaxis.set_ticklabels([])
+    ax.set_xlabel(" ")
 background_sum = sum(background_hists)
 
 plot_data_model_comparison(
@@ -84,8 +88,12 @@
 add_text(
     r"Multiple data-model comparisons, $\mathbf{with}$ model uncertainty",
     ax=axes[0],
+    loc="over left",
+    fontsize="small",
+)
+add_text(
+    r'  $\mathbf{→}$ comparison = "ratio"', ax=axes[1], loc="over left", fontsize=13
 )
-add_text(r'  $\mathbf{→}$ comparison = "ratio"', ax=axes[1], fontsize=13)
 
 for k_comp, comparison in enumerate(
     ["split_ratio", "pull", "relative_difference", "difference"], start=2
@@ -106,6 +114,7 @@
         rf'  $\mathbf{{→}}$ comparison = "{comparison}"',
         ax=ax_comparison,
         fontsize=13,
+        loc="over left",
     )
     set_fitting_ylabel_fontsize(ax_comparison)
 

examples/model_ex/model_all_comparisons_no_model_unc.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 
@@ -52,22 +52,25 @@
 background_hists = [background_scaling_factor * h for h in background_hists]
 
 ###
+import matplotlib.pyplot as plt
 import numpy as np
 
 from mplhep import (
     add_text,
-    create_comparison_figure,
     plot_comparison,
     plot_data_model_comparison,
     set_fitting_ylabel_fontsize,
 )
 
-fig, axes = create_comparison_figure(
-    figsize=(6, 13),
+fig, axes = plt.subplots(
     nrows=6,
+    figsize=(6, 13),
     gridspec_kw={"height_ratios": [3, 1, 1, 1, 1, 1]},
-    hspace=0.3,
 )
+fig.subplots_adjust(hspace=0.3)
+for ax in axes[:-1]:
+    ax.xaxis.set_ticklabels([])
+    ax.set_xlabel(" ")
 background_sum = sum(background_hists)
 
 plot_data_model_comparison(
@@ -87,8 +90,12 @@
 add_text(
     r"Multiple data-model comparisons, $\mathbf{without}$ model uncertainty",
     ax=axes[0],
+    loc="over left",
+    fontsize="small",
+)
+add_text(
+    r'  $\mathbf{→}$ comparison = "ratio"', ax=axes[1], loc="over left", fontsize=13
 )
-add_text(r'  $\mathbf{→}$ comparison = "ratio"', ax=axes[1], fontsize=13)
 
 for k_comp, comparison in enumerate(
     ["split_ratio", "pull", "relative_difference", "difference"], start=2
@@ -117,6 +124,7 @@
     add_text(
         rf'  $\mathbf{{→}}$ comparison = "{comparison}"',
         ax=ax_comparison,
+        loc="over left",
         fontsize=13,
     )
     set_fitting_ylabel_fontsize(ax_comparison)

examples/model_ex/model_examples_pull.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 

examples/model_ex/model_examples_pull_no_model_unc.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 
@@ -52,7 +52,7 @@
 background_hists = [background_scaling_factor * h for h in background_hists]
 
 ###
-from mplhep import add_luminosity, plot_data_model_comparison
+from mplhep import plot_data_model_comparison
 
 fig, ax_main, ax_comparison = plot_data_model_comparison(
     data_hist=data_hist,
@@ -65,6 +65,4 @@
     model_uncertainty=False,  # <--
 )
 
-add_luminosity(collaboration="mplhep", ax=ax_main, is_data=False)
-
 fig.savefig("model_examples_pull_no_model_unc.svg", bbox_inches="tight")

examples/model_ex/model_examples_stacked.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 
@@ -55,7 +55,7 @@
 signal_hist *= signal_scaling_factor
 
 ###
-from mplhep import add_luminosity, histplot, plot_data_model_comparison
+from mplhep import histplot, plot_data_model_comparison
 
 fig, ax_main, ax_comparison = plot_data_model_comparison(
     data_hist=data_hist,
@@ -77,8 +77,4 @@
 
 ax_main.legend()
 
-add_luminosity(
-    collaboration="mplhep", ax=ax_main, lumi=3, lumi_unit="zb", preliminary=True
-)
-
 fig.savefig("model_examples_stacked.svg", bbox_inches="tight")

examples/model_ex/model_examples_stacked_unstacked.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 

examples/model_ex/model_examples_unstacked.py

@@ -9,7 +9,7 @@
 
 df = get_dummy_data()
 
-from mplhep import get_color_palette
+import seaborn as sns
 
 # Define the histograms
 
@@ -23,7 +23,7 @@
 
 background_categories = [0, 1, 2]
 background_categories_labels = [f"c{i}" for i in background_categories]
-background_categories_colors = get_color_palette(
+background_categories_colors = sns.color_palette(
     "cubehelix", len(background_categories)
 )
 

examples/model_ex/model_with_stacked_and_unstacked_function_components.py

@@ -43,7 +43,7 @@ def f_background2(x):
     function_range=range,
 )
 
-add_text("Model made of functions", ax=ax)
+add_text("Model made of functions", ax=ax, loc="over left", fontsize="small")
 
 fig.savefig(
     "model_with_stacked_and_unstacked_function_components.svg", bbox_inches="tight"