Merge pull request #88 from cyrraz/v1.0

v1.0
cyrraz · Dec 6, 2023 · d03686a · d03686a
2 parents 8fabeb3 + 7369042
commit d03686a
Show file tree

Hide file tree

Showing 12 changed files with 146 additions and 133 deletions.
diff --git a/README.rst b/README.rst
@@ -47,7 +47,7 @@ plothist
    :target: https://badge.fury.io/py/plothist
 .. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
-.. |Docs from latest| image:: https://img.shields.io/badge/docs-v0.9-blue.svg
+.. |Docs from latest| image:: https://img.shields.io/badge/docs-v1.0-blue.svg
    :target: https://plothist.readthedocs.io/en/latest/
 .. |Docs from main| image:: https://img.shields.io/badge/docs-main-blue.svg
    :target: https://plothist.readthedocs.io/en/main/
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,9 +36,9 @@
 author = "Cyrille Praz, Tristan Fillinger"
 
 # The short X.Y version
-version = "0.9"
+version = "1.0"
 # The full version, including alpha/beta/rc tags
-release = "0.9"
+release = "1.0"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/examples/model_ex/model_all_comparisons.py b/docs/examples/model_ex/model_all_comparisons.py
@@ -91,7 +91,7 @@
         h1_label="Data",
         h2_label="Pred.",
         ratio_uncertainty_type="split",
-        hist_1_uncertainty_type="asymmetrical",
+        h1_uncertainty_type="asymmetrical",
     )
     add_text(
         f'  $\mathbf{{→}}$ comparison = "{comparison}"', ax=ax_comparison, fontsize=13

diff --git a/docs/examples/model_ex/model_all_comparisons_no_model_unc.py b/docs/examples/model_ex/model_all_comparisons_no_model_unc.py
@@ -99,7 +99,7 @@
         h1_label="Data",
         h2_label="Pred.",
         ratio_uncertainty_type="split",
-        hist_1_uncertainty_type="asymmetrical",
+        h1_uncertainty_type="asymmetrical",
     )
     if comparison == "pull":
         # Since the uncertainties of the model are neglected, the pull label is "(Data - Pred.)/sigma_Data"

diff --git a/docs/examples/model_ex/model_comparisons_ratio_options.py b/docs/examples/model_ex/model_comparisons_ratio_options.py
@@ -110,7 +110,7 @@
         h1_label="Data",
         h2_label="Pred.",
         ratio_uncertainty_type=ratio_uncertainty_type,
-        hist_1_uncertainty_type="asymmetrical",
+        h1_uncertainty_type="asymmetrical",
     )
     add_text(
         f'  $\mathbf{{→}}$ comparison = "ratio", \n  $\mathbf{{→}}$ ratio_uncertainty_type="{ratio_uncertainty_type}", model_uncertainty = {model_uncertainty}',

diff --git a/docs/examples/utility/matplotlib_vs_plothist_style.py b/docs/examples/utility/matplotlib_vs_plothist_style.py
@@ -33,14 +33,14 @@
     hist_0, bins, _ = ax1.hist(
         df["variable_0"], bins=20, histtype="step", linewidth=1.2, label="h1"
     )
-    hist_1 = ax1.hist(
+    h1 = ax1.hist(
         df["variable_1"], bins=bins, histtype="step", linewidth=1.2, label="h2"
     )
     ax1.set_ylabel("Entries")
     ax1.legend()
 
     # Calculate the ratio of histogram values and plot in the second subplot (ax2)
-    ratio = hist_0 / hist_1[0]  # Divide bin values of variable_0 by variable_1
+    ratio = hist_0 / h1[0]  # Divide bin values of variable_0 by variable_1
     bin_centers = 0.5 * (bins[:-1] + bins[1:])  # Calculate bin centers
 
     # Create fake error bars for the ratio

diff --git a/plothist/__init__.py b/plothist/__init__.py
@@ -1,5 +1,5 @@
 """Plot histograms in a scalable way and a beautiful style."""
-__version__ = "0.9"
+__version__ = "1.0"
 
 from .plotters import (
     create_comparison_figure,