icplot 0.1.2__tar.gz → 0.1.4__tar.gz

{icplot-0.1.2/src/icplot.egg-info → icplot-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: icplot
-Version: 0.1.2
+Version: 0.1.4
 Summary: Utilities for generating plots and graphics for technical reports.
 Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
 Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot
@@ -16,7 +16,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
 Requires-Dist: matplotlib
-Requires-Dist: iccore==0.1.8
+Requires-Dist: iccore==0.1.9
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

{icplot-0.1.2 → icplot-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "icplot"
-version = "0.1.2"
+version = "0.1.4"
 authors = [
   { name="James Grogan, Irish Centre for High End Computing", email="james.grogan@ichec.ie" },
 ]
@@ -18,7 +18,7 @@ keywords = ["Publishing", "Technical Reports", "Graphics"]
 
 dependencies = ["wand",
 	       "matplotlib",
-	       "iccore==0.1.8"]
+	       "iccore==0.1.9"]
 
 [project.urls]
 Repository = "https://git.ichec.ie/performance/toolshed/icplot"

{icplot-0.1.2 → icplot-0.1.4}/src/icplot/graph/axis.py

@@ -29,6 +29,11 @@ class PlotAxis(BaseModel, frozen=True):
 
     label: str = ""
     ticks: Range | None = None
+    scale: str = "linear"
+    text_fontsize: int = 10
+    tick_fontsize: int = 10
+    max_ticks: int = 0
+    limits: dict = {}
 
     @property
     def resolved_ticks(self) -> list:

{icplot-0.1.2 → icplot-0.1.4}/src/icplot/graph/generator.py

@@ -45,23 +45,24 @@ def make_plots(
 
             # Use a user-provided 'point_func' to get the series 'x, y' points
             # from the results, given a 'x_attr, y_attr' pair
-            points = [point_func(r, config.x_attr, y_attr) for r in label_results].sort(
-                key=lambda x: x[0]
+            all_points = [point_func(r, config.x_attr, y_attr) for r in label_results]
+            points = sorted(
+                [x for x in all_points if x is not None], key=lambda x: x[0]
             )
-            x, y = zip(*points)
+            x, y = [list(xy) for xy in zip(*points)]
 
             if label in config.colormap:
                 series.append(
                     LinePlotSeries(
                         x=x,
                         y=y,
-                        label=label,
+                        label=str(label),
                         highlight=True,
                         color=config.colormap[label],
                     )
                 )
             else:
-                series.append(LinePlotSeries(x=x, y=y, label=label))
+                series.append(LinePlotSeries(x=x, y=y, label=str(label)))
         plots.append(plot_template.copy(update={"name": y_attr, "series": series}))
     return plots
 

{icplot-0.1.2 → icplot-0.1.4}/src/icplot/graph/matplotlib.py

@@ -8,10 +8,12 @@ import matplotlib as mpl  # NOQA
 default_backend = mpl.get_backend()
 mpl.use("Agg")
 import matplotlib.pyplot as plt  # NOQA
+from matplotlib.ticker import FuncFormatter  # NOQA
 
 from icplot.color import ColorMap, Color  # NOQA
 from .series import PlotSeries, LinePlotSeries, ScatterPlotSeries, ImageSeries  # NOQA
 from .plot import Plot, GridPlot, get_series_colors  # NOQA
+from .axis import PlotAxis  # NOQA
 
 
 class MatplotlibColorMap(ColorMap):
@@ -23,21 +25,74 @@ class MatplotlibColorMap(ColorMap):
         super().__init__(label, mpl.colormaps[label])
 
 
-def _set_decorations(axs, plot: Plot):
-    ax = axs[0]
+def str_exact_values_formatter(x, pos):
+    """
+    When using log scale, axis ticks come out as scientific notation by default,
+    then when using plain formatter values less than 1 come out as 0. A way around
+    this is this custom formatter.
+    """
+    if x.is_integer():
+        return str(int(x))
+    else:
+        return str(x)
+
+
+def _set_legend_decorations(axs, plot):
     if plot.legend.lower() != "none":
-        ax.legend(loc=plot.legend)
-    if plot.x_axis.label:
-        ax.set_xlabel(plot.x_axis.label)
-    for idx, y_axis in enumerate(plot.y_axes):
+        if len(axs) == 1:
+            axs[0].legend(loc=plot.legend, frameon=False, fontsize=plot.legend_fontsize)
+        else:
+            axs[0].legend(
+                loc="upper left", frameon=False, fontsize=plot.legend_fontsize
+            )
+            axs[1].legend(
+                loc="upper right", frameon=False, fontsize=plot.legend_fontsize
+            )
+
+
+def _set_x_axis_decorations(x_axis: PlotAxis, ax):
+    ax.set_yscale(x_axis.scale)
+    ax.tick_params(axis="x", labelsize=x_axis.tick_fontsize)
+    if x_axis.label:
+        ax.set_xlabel(x_axis.label, fontsize=x_axis.text_fontsize)
+    if x_axis.ticks:
+        ax.set_xticks(x_axis.resolved_ticks)
+    if x_axis.max_ticks:
+        ax.xaxis.set_major_locator(plt.MaxNLocator(x_axis.max_ticks))
+    for key, item in x_axis.limits.items():
+        if key == "left" or key == "xmin":
+            ax.set_xlim(xmin=item)
+        elif key == "right" or key == "xmax":
+            ax.set_xlim(xmax=item)
+
+
+def _set_y_axes_decorations(y_axes: list[PlotAxis], axs):
+    for idx, y_axis in enumerate(y_axes):
+        axs[idx].set_yscale(y_axis.scale)
+        axs[idx].tick_params(axis="y", labelsize=y_axis.tick_fontsize)
+        if y_axis.scale == "log":
+            formatter = FuncFormatter(str_exact_values_formatter)
+            axs[idx].yaxis.set_major_formatter(formatter)
         if y_axis.label:
-            axs[idx].set_ylabel(y_axis.label)
+            axs[idx].set_ylabel(y_axis.label, fontsize=y_axis.text_fontsize)
         if y_axis.ticks:
             axs[idx].set_yticks(y_axis.resolved_ticks)
-    if plot.x_axis.ticks:
-        ax.set_xticks(plot.x_axis.resolved_ticks)
+        if y_axis.max_ticks:
+            axs[idx].yaxis.set_major_locator(plt.MaxNLocator(y_axis.max_ticks))
+        for key, item in y_axis.limits.items():
+            if key == "bottom" or key == "ymin":
+                axs[idx].set_ylim(ymin=item)
+            elif key == "top" or key == "ymax":
+                axs[idx].set_ylim(ymax=item)
+
+
+def _set_decorations(axs, plot: Plot):
+    _set_legend_decorations(axs, plot)
+    _set_x_axis_decorations(plot.x_axis, axs[0])
+    _set_y_axes_decorations(plot.y_axes, axs)
     if plot.title:
-        ax.set_title(plot.title)
+        axs[0].set_title(plot.title, fontsize=plot.title_fontsize)
+    axs[0].set_aspect(plot.aspect)
 
 
 def _plot_line(axs, series: LinePlotSeries, color: Color | None):
@@ -47,13 +102,15 @@ def _plot_line(axs, series: LinePlotSeries, color: Color | None):
         ax = axs[1]
 
     if color:
-        render_color: list | None = series.color.as_list()
+        render_color: list | None = color.as_list()
     else:
         render_color = None
-
-    ax.plot(
+    ax.errorbar(
         series.x,
         series.y,
+        xerr=series.x_err,
+        yerr=series.y_err,
+        capsize=series.err_capsize,
         label=series.label,
         color=render_color,
         marker=series.marker,

{icplot-0.1.2 → icplot-0.1.4}/src/icplot/graph/plot.py

@@ -18,13 +18,15 @@ class Plot(BaseModel, frozen=True):
     """
 
     title: str = ""
-    legend_label: str = ""
     name: str = ""
     x_axis: PlotAxis = PlotAxis()
     y_axes: list[PlotAxis] = [PlotAxis()]
     plot_type: str = ""
     series: list[PlotSeries] = []
     legend: str = "none"
+    aspect: str = "auto"
+    legend_fontsize: int = 10
+    title_fontsize: int = 10
 
 
 class GridPlot(Plot, frozen=True):
@@ -65,7 +67,7 @@ class GridPlot(Plot, frozen=True):
         return rows, cols, subplots
 
 
-def get_series_colors(cmap: ColorMap, plot: Plot) -> list[Color | None]:
+def get_series_colors(cmap: ColorMap, plot: Plot) -> list[Color]:
 
     count = 0
     num_colorable = len([s for s in plot.series if not s.highlight])
@@ -75,6 +77,6 @@ def get_series_colors(cmap: ColorMap, plot: Plot) -> list[Color | None]:
             color = cmap.get_color(count, num_colorable)
             count = count + 1
         else:
-            color = None
+            color = s.color
         colors.append(color)
     return colors

{icplot-0.1.2 → icplot-0.1.4}/src/icplot/graph/series.py

@@ -41,6 +41,9 @@ class LinePlotSeries(PlotSeries, frozen=True):
 
     x: list
     y: list
+    x_err: float | list[float] | list[list[float]] | None = None
+    y_err: float | list[float] | list[list[float]] | None = None
+    err_capsize: float = 2.0
     marker: str = "o"
     series_type: str = "line"
     drawstyle: str = "default"

{icplot-0.1.2 → icplot-0.1.4/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: icplot
-Version: 0.1.2
+Version: 0.1.4
 Summary: Utilities for generating plots and graphics for technical reports.
 Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
 Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot
@@ -16,7 +16,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
 Requires-Dist: matplotlib
-Requires-Dist: iccore==0.1.8
+Requires-Dist: iccore==0.1.9
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

{icplot-0.1.2 → icplot-0.1.4}/src/icplot.egg-info/requires.txt

@@ -1,6 +1,6 @@
 wand
 matplotlib
-iccore==0.1.8
+iccore==0.1.9
 
 [cairo]
 pycairo

icplot-0.1.4/test/test_line_plots.py

@@ -0,0 +1,63 @@
+from pathlib import Path
+
+from icplot.graph import Plot, LinePlotSeries, PlotAxis, Range
+from icplot.graph import matplotlib
+
+
+def test_line_plot():
+
+    data = [([0, 5, 10], [1, 2, 3]), ([0, 5, 10], [3, 6, 9]), ([0, 5, 10], [4, 8, 12])]
+
+    series = []
+    for idx, [x, y] in enumerate(data):
+        series_config = {"label": f"Series {idx}", "x": x, "y": y}
+        series.append(LinePlotSeries(**series_config))
+
+    x_axis_config = {
+        "label": "x_axis",
+        "ticks": Range(lower=0, upper=11, step=2),
+        "scale": "linear",
+        "text_fontsize": 10,
+        "tick_fontsize": 10,
+        "max_ticks": 0,
+        "limits": {"bottom": 0},
+    }
+    x_axis = PlotAxis(**x_axis_config)
+    y_axis_config = {
+        "label": "y_axis",
+        "ticks": Range(lower=0, upper=16, step=5),
+        "scale": "linear",
+        "text_fontsize": 10,
+        "tick_fontsize": 10,
+        "max_ticks": 0,
+        "limits": {"upper": 15},
+    }
+    y_axis = PlotAxis(**y_axis_config)
+    plot_config = {
+        "title": "Title",
+        "name": "test",
+        "x_axis": x_axis,
+        "y_axes": [y_axis],
+        "plot_type": "",
+        "series": series,
+        "legend": "upper left",
+        "aspect": "auto",
+        "legend_fontsize": 10,
+        "title_fontsize": 10,
+    }
+
+    plot = Plot(**plot_config)
+
+    output_path = Path() / "output.svg"
+    matplotlib.render(plot, output_path)
+
+    assert output_path.exists()
+    output_path.unlink()
+
+
+def test_error_line_plot():
+    pass
+
+
+def test_twin_line_plot():
+    pass

icplot-0.1.2/test/test_line_plots.py

@@ -1,29 +0,0 @@
-from pathlib import Path
-
-from icplot.graph import Plot, LinePlotSeries
-from icplot.graph import matplotlib
-
-
-def test_line_plot():
-
-    data = [([0, 5, 10], [1, 2, 3]), ([0, 5, 10], [3, 6, 9]), ([0, 5, 10], [4, 8, 12])]
-
-    series = []
-    for idx, [x, y] in enumerate(data):
-        series_config = {"label": f"Series {idx}", "x": x, "y": y}
-        series.append(LinePlotSeries(**series_config))
-
-    plot_config = {
-        "title": "test",
-        "legend_label": "test_legend",
-        "series": series,
-        "x_axis": {"label": "test_x", "ticks": {"lower": 0, "upper": 10, "step": 5}},
-    }
-
-    plot = Plot(**plot_config)
-
-    output_path = Path() / "output.svg"
-    matplotlib.render(plot, output_path)
-
-    assert output_path.exists()
-    output_path.unlink()