icplot 0.0.9__tar.gz → 0.0.11__tar.gz

{icplot-0.0.9/src/icplot.egg-info → icplot-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.9
+Version: 0.0.11
 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.0.10
+Requires-Dist: iccore==0.1.1
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -62,6 +62,12 @@ To covert between image formats you can do:
 icplot convert --source my_image.svg --target my_image.png
 ```
 
+To render a Tex tikz image as pdf and png you can do:
+
+``` shell
+icplot convert --source my_tikz.tex
+```
+
 # Copyright #
 
 Copyright 2024 Irish Centre for High End Computing

{icplot-0.0.9 → icplot-0.0.11}/README.md

@@ -31,6 +31,12 @@ To covert between image formats you can do:
 icplot convert --source my_image.svg --target my_image.png
 ```
 
+To render a Tex tikz image as pdf and png you can do:
+
+``` shell
+icplot convert --source my_tikz.tex
+```
+
 # Copyright #
 
 Copyright 2024 Irish Centre for High End Computing

{icplot-0.0.9 → icplot-0.0.11}/pyproject.toml

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

{icplot-0.0.9 → icplot-0.0.11}/src/icplot/cairo_interface.py

@@ -1,8 +1,8 @@
-import os
 from pathlib import Path
+
 import cairo
 
-from .geometry import Scene, Rectangle, Color, TextPath
+from .geometry import Scene, Rectangle
 
 
 class CairoInterface:
@@ -52,29 +52,9 @@ class CairoInterface:
             if item.item_type == "shape":
                 self.draw_shape(cr, item)
             elif item.item_type == "text":
-                self.draw_text(cr, text)
+                self.draw_text(cr, item)
 
-    def draw_svg(self, scene, path):
+    def draw_svg(self, scene: Scene, path: Path):
         with cairo.SVGSurface(path, scene.size[0], scene.size[1]) as surface:
             cr = cairo.Context(surface)
             self.draw_scene(cr, scene)
-
-
-if __name__ == "__main__":
-
-    cairo_interface = CairoInterface()
-
-    scene = Scene()
-
-    rect = Rectangle(20, 20)
-    rect.location = (10, 10)
-    rect.fill = Color(0.5, 0.5, 1, 0.5)
-    rect.stroke = Color(0.5, 0.0, 0.0, 0.5)
-    scene.items.append(rect)
-
-    text = TextPath("Hello World")
-    text.location = (5, 5)
-    scene.items.append(text)
-
-    output_path = Path(os.getcwd()) / "output.svg"
-    cairo_interface.draw_svg(scene, output_path)

{icplot-0.0.9 → icplot-0.0.11}/src/icplot/color.py

@@ -4,26 +4,26 @@ This module handles colors
 
 from typing import Callable
 
-from iccore.serialization import Serializable
+from pydantic import BaseModel
 
 
-class Color(Serializable):
+class Color(BaseModel):
     """
     A color class, internal storage is rgba as float.
     """
 
-    def __init__(self, r: float = 0.0, g: float = 0.0, b: float = 0.0, a: float = 1.0):
-        self.r = r
-        self.g = g
-        self.b = b
-        self.a = a
+    r: float = 0.0
+    g: float = 0.0
+    b: float = 0.0
+    a: float = 1.0
 
     @staticmethod
-    def from_list(data: list):
-        return Color(data[0], data[1], data[2])
+    def from_rgba(r: float = 0.0, b: float = 0.0, g: float = 0.0, a: float = 1.0):
+        return Color(**{"r": r, "g": g, "b": b, "a": a})
 
-    def serialize(self):
-        return {"r": self.r, "g": self.g, "b": self.b, "a": self.a}
+    @staticmethod
+    def from_list(data: list):
+        return Color(**{"r": data[0], "g": data[1], "b": data[2]})
 
     def as_list(self) -> list:
         return [self.r, self.g, self.b]
@@ -31,6 +31,9 @@ class Color(Serializable):
     def is_black(self) -> bool:
         return self.r == 0.0 and self.g == 0.0 and self.b == 0.0 and self.a == 1.0
 
+    def serialize(self) -> str:
+        return f"r: {self.r}, g: {self.g}, b: {self.b}, a: {self.a}"
+
 
 class ColorMap:
     """
@@ -40,15 +43,11 @@ class ColorMap:
     def __init__(self, label: str, data_func: Callable):
         self.label = label
         self.data_func = data_func
-        self.start_offset = 0.25
-        self.scale = 2
 
     def get_color(self, cursor: int, values: list) -> Color:
         """
         Returns a colour based on a cmap and how far across
         the datasets you are
         """
-        position = cursor / len(values)
-        return Color.from_list(
-            self.data_func(self.start_offset + (position / self.scale))
-        )
+        position = cursor / (len(values) - 1)
+        return Color.from_list(self.data_func(position))

icplot-0.0.11/src/icplot/gantt/__init__.py

@@ -0,0 +1 @@
+from .gantt import *  # NOQA

icplot-0.0.11/src/icplot/gantt/gantt.py

@@ -0,0 +1,19 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+from iccore.project import Milestone
+
+from icplot.color import Color
+
+
+class GanttChart(BaseModel):
+
+    milestones: list[Milestone] = []
+    title: str = ""
+    start_date: datetime | None = None
+    end_date: datetime | None = None
+    bar_max_height: float = 0.1
+    height: int = 100
+    width: int = 500
+    bar_color: Color = Color.from_rgba(0.7, 0, 0)

icplot-0.0.11/src/icplot/gantt/gantt_renderer.py

@@ -0,0 +1,59 @@
+from iccore.project import Milestone
+from icplot.geometry import Scene, Rectangle
+
+from .gantt import GanttChart
+
+
+class GanttRenderer:
+
+    def _add_milestone(
+        self, gantt: GanttChart, scene: Scene, milestone: Milestone, chart_range, yloc
+    ):
+        # chart_delta = chart_range[1] - chart_range[0]
+        chart_delta = 0
+        start_delta = milestone.start_date - chart_range[0]
+        # milestone_delta = milestone.due_date - milestone.start_date
+        milestone_delta = 0
+
+        start_frac = float(start_delta / chart_delta)
+        milestone_frac = float(milestone_delta / chart_delta)
+
+        w = milestone_frac * gantt.width
+        h = gantt.bar_max_height * gantt.height
+        x = start_frac * gantt.width
+        y = yloc
+
+        rect = Rectangle(w, h)
+        rect.location = (x, y)
+        rect.fill = gantt.bar_color
+        scene.items.append(rect)
+
+    def _add_milestones(self, gantt: GanttChart, scene: Scene):
+
+        if not gantt.milestones:
+            return
+
+        milestones = gantt.milestones
+        # milestones.sort(key=lambda x: x.start_date, reverse=True)
+
+        start_date = gantt.start_date
+        end_date = gantt.end_date
+        if not start_date:
+            start_date = milestones[0].start_date
+
+        # if not end_date:
+        #    end_date = max(m.due_date for m in milestones)
+
+        chart_range = (start_date, end_date)
+        yloc = 0.0
+        bar_height = gantt.bar_max_height * gantt.height
+        for milestone in milestones:
+            self._add_milestone(gantt, scene, milestone, chart_range, yloc)
+            yloc += bar_height
+
+    def render(self, gantt: GanttChart) -> Scene:
+        scene = Scene()
+
+        self._add_milestones(gantt, scene)
+
+        return scene

icplot-0.0.11/src/icplot/gantt/pgfgantt_interface.py

@@ -0,0 +1,26 @@
+from pathlib import Path
+
+from .gantt import GanttChart
+
+
+class PgfGanttRenderer:
+
+    def __init__(self):
+        self.template: str = ""
+
+    def _load_template(self):
+        if self.template:
+            return
+
+        with open(Path(__file__).parent / "pgfgantt.tex", "r", encoding="utf-8") as f:
+            self.template = f.read()
+
+    def render(self, gantt: GanttChart) -> str:
+
+        output = self.template
+
+        if gantt.title:
+            title_str = f"\\title{{{gantt.title}}}"
+            output.replace("%%TITLE%%", title_str)
+
+        return output

icplot-0.0.11/src/icplot/graph/axis.py

@@ -0,0 +1,33 @@
+"""
+This module has a plot's axis
+"""
+
+from pydantic import BaseModel
+
+
+class Range(BaseModel):
+    """
+    This is a sequence of numbers specified by lower and upper
+    bounds and a step size. Eg (1, 5, 1) gives: [1, 2, 3, 4]
+    """
+
+    lower: int
+    upper: int
+    step: int
+
+    def eval(self) -> list:
+        return list(range(self.lower, self.upper, self.step))
+
+
+class PlotAxis(BaseModel):
+    """
+    This is a plot's axis
+    """
+
+    label: str = ""
+    ticks: Range | None = None
+
+    def get_resolved_ticks(self) -> list:
+        if self.ticks:
+            return self.ticks.eval()
+        return []

{icplot-0.0.9 → icplot-0.0.11}/src/icplot/graph/matplotlib.py

@@ -29,7 +29,7 @@ class MatplotlibPlotter(Plotter):
     A plot backend for matplotlib
     """
 
-    def __init__(self, cmap_label="viridis"):
+    def __init__(self, cmap_label="gist_rainbow"):
         super().__init__(MatplotlibColorMap(cmap_label))
 
     def set_decorations(self, ax, plot: Plot):
@@ -50,12 +50,12 @@ class MatplotlibPlotter(Plotter):
             series.x,
             series.y,
             label=series.label,
-            color=series.get_color().as_list(),
+            color=series.color.as_list(),
             marker=series.marker,
         )
 
     def plot_scatter(self, ax, series: ScatterPlotSeries):
-        ax.scatter(series.data, label=series.label, color=series.get_color().as_list())
+        ax.scatter(series.data, label=series.label, color=series.color.as_list())
 
     def plot_image(self, ax, series: ImageSeries):
         ax.imshow(series.data)
@@ -75,11 +75,11 @@ class MatplotlibPlotter(Plotter):
 
         fig, ax = plt.subplots()
 
-        self.set_decorations(ax, plot)
-
         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):

icplot-0.0.11/src/icplot/graph/plot.py

@@ -0,0 +1,64 @@
+"""
+This module has content for generating plots
+"""
+
+import random
+
+from pydantic import BaseModel
+
+from .axis import PlotAxis
+from .series import PlotSeries
+
+
+class Plot(BaseModel):
+    """
+    A generic plot with optional axis ticks
+    """
+
+    title: str = ""
+    legend_label: str = ""
+    x_axis: PlotAxis = PlotAxis()
+    y_axis: PlotAxis = PlotAxis()
+    plot_type: str = ""
+    series: list[PlotSeries] = []
+
+    def add_series(self, series: PlotSeries):
+        self.series.append(series)
+
+
+class GridPlot(Plot):
+    """
+    Make a grid of plots
+    """
+
+    stride: int = 4
+    size: tuple = (25, 20)
+    data: list = []
+
+    def get_series_indices(self, num_samples: int = 0):
+        rows = num_samples // self.stride
+        cols = num_samples // rows
+        len_data = len(self.data)
+
+        if num_samples == 0:
+            indices = list(range(0, len_data))
+        else:
+            indices = [random.randint(0, len_data - 1) for _ in range(num_samples)]
+        return rows, cols, indices
+
+    def get_subplots(self, num_samples: int = 0):
+        rows, cols, indices = self.get_series_indices(num_samples)
+
+        subplots = []
+        count = 1
+        for index in indices:
+            if num_samples > 0 and count == num_samples + 1:
+                break
+            if isinstance(self.data[index], list):
+                for series in self.data[index]:
+                    subplots.append(series)
+                    count += 1
+            else:
+                subplots.append(self.data[index])
+                count += 1
+        return rows, cols, subplots

{icplot-0.0.9 → icplot-0.0.11}/src/icplot/graph/plotter.py

@@ -11,12 +11,13 @@ class Plotter:
         self.cmap = cmap
 
     def apply_cmap_colors(self, plot: Plot):
-        skipped_color = 0
+        non_highlight = []
         for idx, series in enumerate(plot.series):
-            if not series.color:
-                series.color = self.cmap.get_color(idx - skipped_color, plot.series)
-            else:
-                skipped_color += 1
+            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

icplot-0.0.11/src/icplot/graph/series.py

@@ -0,0 +1,43 @@
+import typing
+
+from pydantic import BaseModel
+
+from icplot.color import Color
+
+
+class PlotSeries(BaseModel):
+    """
+    A data series in a plot, such as a single line in a line-plot
+    """
+
+    label: str
+    color: Color = Color()
+    series_type: str = ""
+    highlight: bool = False
+
+
+class ImageSeries(PlotSeries):
+    """
+    A plot data series where the elements are images
+    """
+
+    data: typing.Any
+    transform: typing.Any
+    series_type: str = "image"
+
+
+class LinePlotSeries(PlotSeries):
+    """
+    A plot series for line plots
+    """
+
+    x: list
+    y: list
+    marker: str = "o"
+    series_type: str = "line"
+
+
+class ScatterPlotSeries(PlotSeries):
+
+    data: typing.Any
+    series_type: str = "scatter"

{icplot-0.0.9 → icplot-0.0.11}/src/icplot/image_utils.py

@@ -1,3 +1,8 @@
+"""
+This module has functions for converting between image
+formats
+"""
+
 import logging
 from pathlib import Path
 
@@ -12,14 +17,16 @@ logger = logging.getLogger(__name__)
 def _get_out_filename(source: Path, target: Path | None, extension: str) -> Path:
     if target:
         return target
-    else:
-        return source.parent / f"{source.stem}.{extension}"
+    return source.parent / f"{source.stem}.{extension}"
 
 
-def pdf_to_png(source: Path, target: Path | None = None):
+def pdf_to_png(source: Path, target: Path | None = None, resolution: int = 300):
+    """
+    Convert a pdf to png with white background
+    """
 
     outfile = _get_out_filename(source, target, "png")
-    with Image(filename=source, resolution=300) as img:
+    with Image(filename=source, resolution=resolution) as img:
         img.format = "png"
         img.background_color = Color("white")
         img.alpha_channel = "remove"
@@ -27,10 +34,18 @@ def pdf_to_png(source: Path, target: Path | None = None):
 
 
 def svg_to_png(source: Path, target: Path | None = None):
+    """
+    Convert an svg to png
+    """
+
     outfile = _get_out_filename(source, target, "png")
     cairosvg.svg2png(url=str(source), write_to=str(outfile))
 
 
 def svg_to_pdf(source: Path, target: Path | None = None):
+    """
+    Convert an svg to pdf
+    """
+
     outfile = _get_out_filename(source, target, "pdf")
     cairosvg.svg2pdf(url=str(source), write_to=str(outfile))

{icplot-0.0.9 → icplot-0.0.11}/src/icplot/main_cli.py

@@ -2,24 +2,23 @@
 import argparse
 import logging
 from pathlib import Path
+import os
 
-from iccore import logging_utils
-from iccore import runtime
+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.tex_interface import TexBuildSettings, TexInterface
 
 logger = logging.getLogger(__name__)
 
 
-def launch_common(args):
-    runtime.ctx.set_is_dry_run(args.dry_run)
-    logging_utils.setup_default_logger()
-
-
 def convert(args):
     launch_common(args)
 
-    logger.info("Attempting coversion between %s %s", args.source, args.target)
+    logger.info("Startubg conversion between %s and %s", args.source, args.target)
 
     if args.target:
         target = Path(args.target).resolve()
@@ -36,9 +35,35 @@ def convert(args):
                 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 = TexInterface()
+        tex.build(settings)
+
     logger.info("Finished conversion")
 
 
+def plot(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())
+
+
 def main_cli():
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -61,8 +86,23 @@ def main_cli():
         default="",
         help="Path to file to be converted to",
     )
+    convert_parser.add_argument(
+        "--build_dir",
+        default=Path(os.getcwd()) / "_build/tikz",
+        help="Path for build output",
+    )
     convert_parser.set_defaults(func=convert)
 
+    plot_parser = subparsers.add_parser("plot")
+    plot_parser.add_argument("--config", type=Path, help="Path to the plot config")
+    plot_parser.add_argument(
+        "--output_dir",
+        type=Path,
+        default=Path(os.getcwd()),
+        help="Path to the plot output directory",
+    )
+    plot_parser.set_defaults(func=plot)
+
     args = parser.parse_args()
     args.func(args)