icplot 0.0.10__tar.gz → 0.0.12__tar.gz

{icplot-0.0.10/src/icplot.egg-info → icplot-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.10
+Version: 0.0.12
 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.0
+Requires-Dist: iccore==0.1.5
 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.10 → icplot-0.0.12}/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.10 → icplot-0.0.12}/pyproject.toml

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

icplot-0.0.12/src/icplot/cairo_interface.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+
+import cairo
+
+from .geometry import Scene, Rectangle
+
+
+def draw_rect(cr, rect: Rectangle):
+    x0, y0 = rect.location
+    x1 = rect.w
+    y1 = rect.h
+    cr.move_to(x0, y0)
+    cr.line_to(x1, y0)
+    cr.line_to(x1, y1)
+    cr.line_to(x0, y1)
+    cr.close_path()
+
+
+def draw_shape(cr, shape):
+    cr.save()
+    if shape.shape_type == "rect":
+        draw_rect(cr, shape)
+    else:
+        return
+    cr.set_source_rgba(shape.fill.r, shape.fill.g, shape.fill.b, shape.fill.a)
+    cr.fill_preserve()
+    if shape.stroke is not None:
+        cr.set_source_rgba(
+            shape.stroke.r, shape.stroke.g, shape.stroke.b, shape.stroke.a
+        )
+        cr.set_line_width(shape.stroke_thickness)
+        cr.stroke()
+
+    cr.restore()
+
+
+def draw_text(cr, text):
+    cr.save()
+
+    cr.select_font_face(text.font.family)
+    cr.set_font_size(text.font.size)
+    cr.move_to(text.location[0], text.location[1])
+    cr.show_text(text.content)
+
+    cr.restore()
+
+
+def draw_scene(cr, scene: Scene):
+    for item in scene.items:
+        if item.item_type == "shape":
+            draw_shape(cr, item)
+        elif item.item_type == "text":
+            draw_text(cr, item)
+
+
+def draw_svg(scene: Scene, path: Path):
+    with cairo.SVGSurface(path, scene.size[0], scene.size[1]) as surface:
+        cr = cairo.Context(surface)
+        draw_scene(cr, scene)

{icplot-0.0.10 → icplot-0.0.12}/src/icplot/color.py

@@ -34,6 +34,7 @@ class Color(BaseModel):
     def serialize(self) -> str:
         return f"r: {self.r}, g: {self.g}, b: {self.b}, a: {self.a}"
 
+
 class ColorMap:
     """
     A mapping from a flat index to a color
@@ -42,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.12/src/icplot/gantt/gantt_renderer.py

@@ -0,0 +1,59 @@
+from iccore.project import Milestone
+from icplot.geometry import Scene, SceneItem, Rectangle
+
+from .gantt import GanttChart
+
+
+def _render_milestone(
+    gantt: GanttChart, milestone: Milestone, chart_range, yloc
+) -> SceneItem:
+    # 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=w, h=h, location=(x, y), fill=gantt.bar_color)
+    return rect
+
+
+def _render_milestones(gantt: GanttChart):
+
+    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
+    scene_items = []
+    for milestone in milestones:
+        item = _render_milestone(gantt, milestone, chart_range, yloc)
+        scene_items.append(item)
+        yloc += bar_height
+    return scene_items
+
+
+def render(gantt: GanttChart) -> Scene:
+    scene = Scene()
+    items = _render_milestones(gantt)
+    scene.items.extend(items)
+    return scene

icplot-0.0.12/src/icplot/gantt/pgfgantt.py

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

icplot-0.0.12/src/icplot/geometry.py

@@ -0,0 +1,45 @@
+from pydantic import BaseModel
+
+from .color import Color
+
+
+class Font(BaseModel):
+
+    family: str = "Sans"
+    weight: str = "normal"
+    slant: str = "normal"
+    size: float = 0.5
+
+
+class SceneItem(BaseModel):
+
+    item_type: str
+    location: tuple[float, float] = (0.0, 0.0)
+
+
+class Shape(SceneItem):
+
+    item_type: str = "shape"
+    fill: Color = Color()
+    stroke: Color = Color()
+    stroke_thickness: float = 0.5
+
+
+class TextPath(SceneItem):
+
+    item_type: str = "text"
+    content: str
+    font: Font = Font()
+
+
+class Rectangle(Shape):
+
+    item_type: str = "rect"
+    w: float
+    h: float
+
+
+class Scene(BaseModel):
+
+    items: list[SceneItem] = []
+    size: tuple[int, int] = (100, 100)

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

@@ -0,0 +1,34 @@
+"""
+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
+
+    @property
+    def resolved_ticks(self) -> list:
+        if self.ticks:
+            return self.ticks.eval()
+        return []

{icplot-0.0.10 → icplot-0.0.12}/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):
@@ -39,9 +39,9 @@ class MatplotlibPlotter(Plotter):
         if plot.y_axis.label:
             ax.set_ylabel(plot.y_axis.label)
         if plot.x_axis.ticks:
-            ax.set_xticks(plot.x_axis.get_resolved_ticks())
+            ax.set_xticks(plot.x_axis.resolved_ticks)
         if plot.y_axis.ticks:
-            ax.set_yticks(plot.y_axis.get_resolved_ticks())
+            ax.set_yticks(plot.y_axis.resolved_ticks)
         if plot.title:
             ax.set_title(plot.title)
 
@@ -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)

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

@@ -0,0 +1,61 @@
+"""
+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] = []
+
+
+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.10 → icplot-0.0.12}/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.12/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.10 → icplot-0.0.12}/src/icplot/main_cli.py

@@ -2,24 +2,24 @@
 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 import tex
+from icplot.tex import TexBuildSettings
 
 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 +36,33 @@ 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.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 +85,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)
 

icplot-0.0.12/src/icplot/tex.py

@@ -0,0 +1,77 @@
+"""
+This module has functionality for publishing Tex documents
+"""
+
+import subprocess
+from typing import NamedTuple
+import shutil
+import os
+from pathlib import Path
+import logging
+
+from .image_utils import pdf_to_png
+
+logger = logging.getLogger(__name__)
+
+
+class TexBuildSettings(NamedTuple):
+    """
+    This holds settings for the Tex build
+    """
+
+    source: Path
+    build_dir: Path
+    output_dir: Path | None = None
+    build_engine: str = "pdflatex"
+    output_png: bool = True
+    clear_workdir: bool = True
+
+
+def build_pdf(settings: TexBuildSettings, work_dir: Path):
+
+    cmd = f"{settings.build_engine} {settings.source}"
+    with open(work_dir / "stdout.txt", "w", encoding="utf-8") as f:
+        subprocess.run(cmd, shell=True, check=True, cwd=work_dir, stdout=f, stderr=f)
+
+
+def build_single(settings: TexBuildSettings):
+    logger.info("Building source: %s", settings.source)
+
+    # Make a working dir
+    work_dir = settings.build_dir / settings.source.stem
+    os.makedirs(work_dir, exist_ok=True)
+
+    build_pdf(settings, work_dir)
+
+    tex_path = work_dir / settings.source.name
+    pdf_path = tex_path.parent / f"{tex_path.stem}.pdf"
+    if settings.output_png:
+        pdf_to_png(pdf_path)
+
+    # If output dir is different to build dir copy final content there
+    if settings.output_dir and settings.output_dir != work_dir:
+        os.makedirs(settings.output_dir, exist_ok=True)
+        shutil.copy(pdf_path, settings.output_dir)
+
+        if settings.output_png:
+            png_path = pdf_path.parent / f"{tex_path.stem}.png"
+            shutil.copy(png_path, settings.output_dir)
+
+        if settings.clear_workdir:
+            shutil.rmtree(work_dir)
+
+
+def build(settings: TexBuildSettings):
+    if settings.source.is_dir():
+        for tex_file in settings.source.glob("*.tex"):
+            single_build = TexBuildSettings(
+                tex_file,
+                settings.build_dir,
+                settings.output_dir,
+                settings.build_engine,
+            )
+            build_single(single_build)
+    else:
+        build_single(settings)
+
+    logger.info("Finished building sources")

icplot-0.0.12/src/icplot/trace/__init__.py

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

{icplot-0.0.10 → icplot-0.0.12/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.10
+Version: 0.0.12
 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.0
+Requires-Dist: iccore==0.1.5
 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