icplot 0.0.13__tar.gz → 0.1.1__tar.gz

{icplot-0.0.13/src/icplot.egg-info → icplot-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.13
+Version: 0.1.1
 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.5
+Requires-Dist: iccore==0.1.6
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

{icplot-0.0.13 → icplot-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "icplot"
-version = "0.0.13"
+version = "0.1.1"
 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.5"]
+	       "iccore==0.1.6"]
 
 [project.urls]
 Repository = "https://git.ichec.ie/performance/toolshed/icplot"

{icplot-0.0.13 → icplot-0.1.1}/src/icplot/color.py

@@ -49,5 +49,5 @@ class ColorMap:
         Returns a colour based on a cmap and how far across
         the datasets you are
         """
-        position = cursor / (len(values) - 1)
+        position = cursor / (max(len(values) - 1, 1))
         return Color.from_list(self.data_func(position))

icplot-0.1.1/src/icplot/convert.py

@@ -0,0 +1,40 @@
+import logging
+import os
+from pathlib import Path
+
+from icplot import tex
+from icplot.tex import TexBuildSettings
+from icplot.image_utils import pdf_to_png, svg_to_pdf, svg_to_png
+
+
+logger = logging.getLogger(__name__)
+
+
+def convert(source: Path, target: Path, build_dir: Path):
+    """
+    Convert the file at source outputing at target and using
+    the source and target file extensions as format hints.
+
+    Some conversions require a build_dir for intermediate or
+    temporary output
+    """
+
+    logger.info("Converting between %s and %s", source, target)
+
+    if source.suffix == ".pdf":
+        pdf_to_png(source, target)
+    elif source.suffix == ".svg":
+        if target:
+            if target.suffix == ".png":
+                svg_to_png(source, target)
+            elif target.suffix == ".pdf":
+                svg_to_pdf(source, target)
+        else:
+            svg_to_png(source)
+    elif source.suffix == ".tex":
+        if not target:
+            target = Path(os.getcwd())
+        settings = TexBuildSettings(source, build_dir, target)
+        tex.build(settings)
+
+    logger.info("Finished conversion")

icplot-0.1.1/src/icplot/graph/__init__.py

@@ -0,0 +1,6 @@
+from .plot import *  # NOQA
+from .series import *  # NOQA
+from .axis import *  # NOQA
+from .generator import plot_file
+
+__all__ = ["plot_file"]

{icplot-0.0.13 → icplot-0.1.1}/src/icplot/graph/generator.py

@@ -5,9 +5,11 @@ from pathlib import Path
 
 from pydantic import BaseModel
 
+from iccore.serialization import read_yaml
+
 from .plot import Plot
 from .series import LinePlotSeries
-from .matplotlib import MatplotlibPlotter
+from .matplotlib import render
 
 
 class PlotConfig(BaseModel):
@@ -73,7 +75,6 @@ def plot(
     config: PlotConfig,
     point_func: Callable,
     output_dir: Path = Path(os.getcwd()),
-    plotter=MatplotlibPlotter(),
 ):
     """
     For a given set of results and plot config generate the
@@ -81,4 +82,14 @@ def plot(
     """
 
     for p in make_plots(results, config, point_func):
-        plotter.plot(p, output_dir / f"{p.name}.svg")
+        render(p, output_dir / f"{p.name}.svg")
+
+
+def plot_file(config_path: Path, output_dir: Path):
+    config = read_yaml(config_path)
+
+    if ["plots"] not in config:
+        return
+
+    for p in [Plot(**p) for p in config["plots"]]:
+        render(p, output_dir)

icplot-0.1.1/src/icplot/graph/matplotlib.py

@@ -0,0 +1,116 @@
+from pathlib import Path
+import logging
+from typing import cast
+
+logging.getLogger("matplotlib").setLevel(logging.WARNING)
+import matplotlib as mpl  # NOQA
+
+default_backend = mpl.get_backend()
+mpl.use("Agg")
+import matplotlib.pyplot as plt  # NOQA
+
+from icplot.color import ColorMap  # NOQA
+from .series import PlotSeries, LinePlotSeries, ScatterPlotSeries, ImageSeries  # NOQA
+from .plot import Plot, GridPlot, apply_colors  # NOQA
+
+
+class MatplotlibColorMap(ColorMap):
+    """
+    A matplotlib based colormap
+    """
+
+    def __init__(self, label: str):
+        super().__init__(label, mpl.colormaps[label])
+
+
+def _set_decorations(axs, plot: Plot):
+    ax = axs[0]
+    if plot.legend != "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 y_axis.label:
+            axs[idx].set_ylabel(y_axis.label)
+        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 plot.title:
+        ax.set_title(plot.title)
+
+
+def _plot_line(axs, series: LinePlotSeries):
+    if not series.position_right:
+        ax = axs[0]
+    else:
+        ax = axs[1]
+    ax.plot(
+        series.x,
+        series.y,
+        label=series.label,
+        color=series.color.as_list(),
+        marker=series.marker,
+        drawstyle=series.drawstyle,
+    )
+
+
+def _plot_scatter(ax, series: ScatterPlotSeries):
+    ax.scatter(series.data, label=series.label, color=series.color.as_list())
+
+
+def _plot_image(ax, series: ImageSeries):
+    ax.imshow(series.data)
+    ax.axis("off")
+
+
+def _plot_series(axs, series: PlotSeries):
+    ax = axs[0]
+    if series.series_type == "line":
+        _plot_line(axs, cast(LinePlotSeries, series))
+    elif series.series_type == "scatter":
+        _plot_scatter(ax, cast(ScatterPlotSeries, series))
+    elif series.series_type == "image":
+        _plot_image(ax, cast(ImageSeries, series))
+
+
+def _render(fig, path: Path | None = None):
+    if path:
+        fig.savefig(path)
+    else:
+        plt.switch_backend(default_backend)
+        fig.show()
+        plt.switch_backend("Agg")
+
+
+def render(
+    plot: Plot, path: Path | None = None, cmap=MatplotlibColorMap("gist_rainbow")
+):
+
+    apply_colors(cmap, plot)
+
+    fig, ax = plt.subplots()
+    axs = [ax]
+    if len(plot.y_axes) > 1:
+        axs.append(ax.twinx())
+
+    for series in plot.series:
+        _plot_series(axs, series)
+
+    _set_decorations(axs, plot)
+
+    _render(fig, path)
+
+
+def render_grid(
+    plot: GridPlot,
+    path: Path | None = None,
+    num_samples: int = 0,
+):
+    rows, cols, series = plot.get_subplots(num_samples)
+    fig, axs = plt.subplots(rows, cols)
+
+    for ax, series_item in zip(axs, series):
+        _plot_series(ax, series_item)
+
+    _render(fig, path)

{icplot-0.0.13 → icplot-0.1.1}/src/icplot/graph/plot.py

@@ -6,6 +6,8 @@ import random
 
 from pydantic import BaseModel
 
+from icplot.color import ColorMap
+
 from .axis import PlotAxis
 from .series import PlotSeries
 
@@ -19,9 +21,10 @@ class Plot(BaseModel):
     legend_label: str = ""
     name: str = ""
     x_axis: PlotAxis = PlotAxis()
-    y_axis: PlotAxis = PlotAxis()
+    y_axes: list[PlotAxis] = [PlotAxis()]
     plot_type: str = ""
     series: list[PlotSeries] = []
+    legend: str = "upper left"
 
 
 class GridPlot(Plot):
@@ -60,3 +63,13 @@ class GridPlot(Plot):
                 subplots.append(self.data[index])
                 count += 1
         return rows, cols, subplots
+
+
+def apply_colors(cmap: ColorMap, plot: Plot):
+    non_highlight = []
+    for idx, series in enumerate(plot.series):
+        if not series.highlight:
+            non_highlight.append(series)
+
+    for idx, series in enumerate(non_highlight):
+        series.color = cmap.get_color(idx, non_highlight)

{icplot-0.0.13 → icplot-0.1.1}/src/icplot/graph/series.py

@@ -8,12 +8,16 @@ from icplot.color import Color
 class PlotSeries(BaseModel):
     """
     A data series in a plot, such as a single line in a line-plot
+
+    :param position_right: allows the series to be plotted on the right y-axis.
+    :type position_right: bool, optional
     """
 
     label: str
     color: Color = Color()
     series_type: str = ""
     highlight: bool = False
+    position_right: bool = False
 
 
 class ImageSeries(PlotSeries):
@@ -29,12 +33,17 @@ class ImageSeries(PlotSeries):
 class LinePlotSeries(PlotSeries):
     """
     A plot series for line plots
+
+    :param drawstyle: Naming comes from matplotlib API, allows for various square plots,
+               default is a normal point to point line plot.
+    :type drawstyle: str, optional
     """
 
     x: list
     y: list
     marker: str = "o"
     series_type: str = "line"
+    drawstyle: str = "default"
 
 
 class ScatterPlotSeries(PlotSeries):

{icplot-0.0.13 → icplot-0.1.1}/src/icplot/image_utils.py

@@ -4,13 +4,14 @@ formats
 """
 
 import logging
+import os
 from pathlib import Path
 
 from wand.image import Image
 from wand.color import Color
-
 import cairosvg
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -26,6 +27,8 @@ def pdf_to_png(source: Path, target: Path | None = None, resolution: int = 300):
     """
 
     outfile = _get_out_filename(source, target, "png")
+    os.makedirs(outfile.parent, exist_ok=True)
+
     with Image(filename=source, resolution=resolution) as img:
         img.format = "png"
         img.background_color = Color("white")
@@ -39,6 +42,7 @@ def svg_to_png(source: Path, target: Path | None = None):
     """
 
     outfile = _get_out_filename(source, target, "png")
+    os.makedirs(outfile.parent, exist_ok=True)
     cairosvg.svg2png(url=str(source), write_to=str(outfile))
 
 
@@ -48,4 +52,5 @@ def svg_to_pdf(source: Path, target: Path | None = None):
     """
 
     outfile = _get_out_filename(source, target, "pdf")
+    os.makedirs(outfile.parent, exist_ok=True)
     cairosvg.svg2pdf(url=str(source), write_to=str(outfile))

{icplot-0.0.13 → icplot-0.1.1}/src/icplot/main_cli.py

@@ -5,62 +5,29 @@ from pathlib import Path
 import os
 
 from iccore.cli_utils import launch_common
-from iccore.serialization import read_yaml
 
-from icplot.graph import Plot
-from icplot.graph.matplotlib import MatplotlibPlotter
-from icplot.image_utils import pdf_to_png, svg_to_png, svg_to_pdf
-from icplot import tex
-from icplot.tex import TexBuildSettings
+import icplot
+import icplot.graph
 
 logger = logging.getLogger(__name__)
 
 
-def convert(args):
+def convert_cli(args):
     launch_common(args)
 
-    logger.info("Startubg conversion between %s and %s", args.source, args.target)
-
     if args.target:
         target = Path(args.target).resolve()
     else:
         target = None
 
-    if args.source.suffix == ".pdf":
-        pdf_to_png(args.source.resolve(), target)
-    elif args.source.suffix == ".svg":
-        if target:
-            if target.suffix == ".png":
-                svg_to_png(args.source.resolve(), target)
-            elif target.suffix == ".pdf":
-                svg_to_pdf(args.source.resolve(), target)
-        else:
-            svg_to_png(args.source)
-    elif args.source.suffix == ".tex":
-        if args.target:
-            target = Path(args.target).resolve()
-        else:
-            target = Path(os.getcwd())
-
-        settings = TexBuildSettings(
-            args.source.resolve(), args.build_dir.resolve(), args.target
-        )
-        tex.build(settings)
+    icplot.convert(args.source.resolve(), target, args.buid_dir.resolve())
 
-    logger.info("Finished conversion")
 
-
-def plot(args):
+def plot_cli(args):
 
     launch_common(args)
 
-    config = read_yaml(args.config.resolve())
-
-    plotter = MatplotlibPlotter()
-    if ["plots"] in config:
-        for eachplot in config["plots"]:
-            plot = Plot(**eachplot)
-            plotter.plot(plot, args.output_dir.resolve())
+    icplot.graph.plot_file(args.config.resolve(), args.output_dir.resolve())
 
 
 def main_cli():
@@ -90,7 +57,7 @@ def main_cli():
         default=Path(os.getcwd()) / "_build/tikz",
         help="Path for build output",
     )
-    convert_parser.set_defaults(func=convert)
+    convert_parser.set_defaults(func=convert_cli)
 
     plot_parser = subparsers.add_parser("plot")
     plot_parser.add_argument("--config", type=Path, help="Path to the plot config")
@@ -100,7 +67,7 @@ def main_cli():
         default=Path(os.getcwd()),
         help="Path to the plot output directory",
     )
-    plot_parser.set_defaults(func=plot)
+    plot_parser.set_defaults(func=plot_cli)
 
     args = parser.parse_args()
     args.func(args)

{icplot-0.0.13 → icplot-0.1.1/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.13
+Version: 0.1.1
 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.5
+Requires-Dist: iccore==0.1.6
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

{icplot-0.0.13 → icplot-0.1.1}/src/icplot.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ setup.cfg
 src/icplot/__init__.py
 src/icplot/cairo_interface.py
 src/icplot/color.py
+src/icplot/convert.py
 src/icplot/geometry.py
 src/icplot/image_utils.py
 src/icplot/main_cli.py
@@ -25,7 +26,6 @@ src/icplot/graph/axis.py
 src/icplot/graph/generator.py
 src/icplot/graph/matplotlib.py
 src/icplot/graph/plot.py
-src/icplot/graph/plotter.py
 src/icplot/graph/series.py
 src/icplot/trace/__init__.py
 src/icplot/trace/trace.py

{icplot-0.0.13 → icplot-0.1.1}/src/icplot.egg-info/requires.txt

@@ -1,6 +1,6 @@
 wand
 matplotlib
-iccore==0.1.5
+iccore==0.1.6
 
 [cairo]
 pycairo

{icplot-0.0.13 → icplot-0.1.1}/test/test_line_plots.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 from icplot.graph import Plot, LinePlotSeries
-from icplot.graph.matplotlib import MatplotlibPlotter
+from icplot.graph import matplotlib
 
 
 def test_line_plot():
@@ -24,9 +24,7 @@ def test_line_plot():
     plot = Plot(**plot_config)
 
     output_path = Path() / "output.svg"
-
-    plotter = MatplotlibPlotter()
-    plotter.plot(plot, output_path)
+    matplotlib.render(plot, output_path)
 
     assert output_path.exists()
     output_path.unlink()

icplot-0.0.13/src/icplot/graph/__init__.py

@@ -1,2 +0,0 @@
-from .plot import *  # NOQA
-from .series import *  # NOQA

icplot-0.0.13/src/icplot/graph/matplotlib.py

@@ -1,101 +0,0 @@
-from pathlib import Path
-import logging
-from typing import cast
-
-logging.getLogger("matplotlib").setLevel(logging.WARNING)
-import matplotlib as mpl  # NOQA
-
-default_backend = mpl.get_backend()
-mpl.use("Agg")
-import matplotlib.pyplot as plt  # NOQA
-
-from icplot.color import ColorMap  # NOQA
-from .series import PlotSeries, LinePlotSeries, ScatterPlotSeries, ImageSeries  # NOQA
-from .plot import Plot, GridPlot  # NOQA
-from .plotter import Plotter  # NOQA
-
-
-class MatplotlibColorMap(ColorMap):
-    """
-    A matplotlib based colormap
-    """
-
-    def __init__(self, label: str):
-        super().__init__(label, mpl.colormaps[label])
-
-
-class MatplotlibPlotter(Plotter):
-    """
-    A plot backend for matplotlib
-    """
-
-    def __init__(self, cmap_label="gist_rainbow"):
-        super().__init__(MatplotlibColorMap(cmap_label))
-
-    def set_decorations(self, ax, plot: Plot):
-        ax.legend(loc="upper left")
-        if plot.x_axis.label:
-            ax.set_xlabel(plot.x_axis.label)
-        if plot.y_axis.label:
-            ax.set_ylabel(plot.y_axis.label)
-        if plot.x_axis.ticks:
-            ax.set_xticks(plot.x_axis.resolved_ticks)
-        if plot.y_axis.ticks:
-            ax.set_yticks(plot.y_axis.resolved_ticks)
-        if plot.title:
-            ax.set_title(plot.title)
-
-    def plot_line(self, ax, series: LinePlotSeries):
-        ax.plot(
-            series.x,
-            series.y,
-            label=series.label,
-            color=series.color.as_list(),
-            marker=series.marker,
-        )
-
-    def plot_scatter(self, ax, series: ScatterPlotSeries):
-        ax.scatter(series.data, label=series.label, color=series.color.as_list())
-
-    def plot_image(self, ax, series: ImageSeries):
-        ax.imshow(series.data)
-        ax.axis("off")
-
-    def plot_series(self, ax, series: PlotSeries):
-        if series.series_type == "line":
-            self.plot_line(ax, cast(LinePlotSeries, series))
-        elif series.series_type == "scatter":
-            self.plot_scatter(ax, cast(ScatterPlotSeries, series))
-        elif series.series_type == "image":
-            self.plot_image(ax, cast(ImageSeries, series))
-
-    def plot(self, plot: Plot, path: Path | None = None):
-
-        self.apply_cmap_colors(plot)
-
-        fig, ax = plt.subplots()
-
-        for series in plot.series:
-            self.plot_series(ax, series)
-
-        self.set_decorations(ax, plot)
-
-        self.render(fig, path)
-
-    def plot_grid(self, plot: GridPlot, path: Path | None = None, num_samples: int = 0):
-
-        rows, cols, series = plot.get_subplots(num_samples)
-        fig, axs = plt.subplots(rows, cols)
-
-        for ax, series_item in zip(axs, series):
-            self.plot_series(ax, series_item)
-
-        self.render(fig, path)
-
-    def render(self, fig, path: Path | None = None):
-        if path:
-            fig.savefig(path)
-        else:
-            plt.switch_backend(default_backend)
-            fig.show()
-            plt.switch_backend("Agg")

icplot-0.0.13/src/icplot/graph/plotter.py

@@ -1,23 +0,0 @@
-from pathlib import Path
-
-from icplot.color import ColorMap
-
-from .plot import Plot
-
-
-class Plotter:
-
-    def __init__(self, cmap: ColorMap):
-        self.cmap = cmap
-
-    def apply_cmap_colors(self, plot: Plot):
-        non_highlight = []
-        for idx, series in enumerate(plot.series):
-            if not series.highlight:
-                non_highlight.append(series)
-
-        for idx, series in enumerate(non_highlight):
-            series.color = self.cmap.get_color(idx, non_highlight)
-
-    def plot(self, plot: Plot, path: Path | None = None):
-        pass