icplot 0.0.9__tar.gz → 0.0.10__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.9
+Version: 0.0.10
 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.0
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

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

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

{icplot-0.0.9 → icplot-0.0.10}/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.10}/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,8 @@ 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:
     """

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

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

icplot-0.0.10/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.10/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.10/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.9 → icplot-0.0.10}/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.10/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.9
+Version: 0.0.10
 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.0
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

{icplot-0.0.9 → icplot-0.0.10}/src/icplot.egg-info/SOURCES.txt

@@ -5,11 +5,10 @@ setup.cfg
 src/icplot/__init__.py
 src/icplot/cairo_interface.py
 src/icplot/color.py
-src/icplot/gantt.py
 src/icplot/geometry.py
 src/icplot/image_utils.py
 src/icplot/main_cli.py
-src/icplot/project_elements.py
+src/icplot/py.typed
 src/icplot/tex_interface.py
 src/icplot.egg-info/PKG-INFO
 src/icplot.egg-info/SOURCES.txt
@@ -17,6 +16,10 @@ src/icplot.egg-info/dependency_links.txt
 src/icplot.egg-info/entry_points.txt
 src/icplot.egg-info/requires.txt
 src/icplot.egg-info/top_level.txt
+src/icplot/gantt/__init__.py
+src/icplot/gantt/gantt.py
+src/icplot/gantt/gantt_renderer.py
+src/icplot/gantt/pgfgantt_interface.py
 src/icplot/graph/__init__.py
 src/icplot/graph/axis.py
 src/icplot/graph/matplotlib.py

{icplot-0.0.9 → icplot-0.0.10}/src/icplot.egg-info/requires.txt

@@ -1,6 +1,6 @@
 wand
 matplotlib
-iccore==0.0.10
+iccore==0.1.0
 
 [cairo]
 pycairo

icplot-0.0.10/test/test_cairo_interface.py

@@ -0,0 +1,29 @@
+from pathlib import Path
+import os
+import shutil
+
+from icplot.cairo_interface import CairoInterface
+from icplot.geometry import Scene, Rectangle, TextPath
+from icplot.color import Color
+
+
+def test_cairo_interface():
+
+    cairo_interface = CairoInterface()
+    scene = Scene()
+
+    rect = Rectangle(20, 20)
+    rect.location = (10, 10)
+    rect.fill = Color.from_rgba(0.5, 0.5, 1, 0.5)
+    rect.stroke = Color.from_rgba(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_dir = Path(os.getcwd()) / "test_cairo_interface"
+    os.makedirs(output_dir, exist_ok=True)
+    cairo_interface.draw_svg(scene, output_dir / "output.svg")
+    shutil.rmtree(output_dir)
+    

{icplot-0.0.9 → icplot-0.0.10}/test/test_gantt_chart.py

@@ -24,8 +24,3 @@ def test_gantt_chart():
     gantt = GanttChart()
     gantt.milestones = [milestone0, milestone1]
 
-    output_path = Path(os.getcwd()) / "gantt.svg"
-
-    gantt.plot(output_path)
-
-    output_path.unlink()

icplot-0.0.9/src/icplot/gantt.py

@@ -1,64 +0,0 @@
-from pathlib import Path
-from .cairo_interface import CairoInterface
-from .geometry import Scene, Color, Rectangle
-
-
-class GanttChart:
-
-    def __init__(self):
-        self.milestones = []
-        self.start_date = None
-        self.end_date = None
-        self.milestone_bar_max_height = 0.1
-        self.height = 100
-        self.width = 500
-        self.milestone_color = Color(0.7, 0, 0)
-
-    def _add_milestone(self, scene, milestone, chart_range, yloc):
-        chart_delta = chart_range[1] - chart_range[0]
-        start_delta = milestone.start_date - chart_range[0]
-        milestone_delta = milestone.due_date - milestone.start_date
-
-        start_frac = float(start_delta / chart_delta)
-        milestone_frac = float(milestone_delta / chart_delta)
-
-        w = milestone_frac * self.width
-        h = self.milestone_bar_max_height * self.height
-        x = start_frac * self.width
-        y = yloc
-
-        rect = Rectangle(w, h)
-        rect.location = (x, y)
-        rect.fill = self.milestone_color
-        scene.items.append(rect)
-
-    def _add_milestones(self, scene):
-
-        if not self.milestones:
-            return
-
-        milestones = self.milestones
-        milestones.sort(key=lambda x: x.start_date, reverse=True)
-
-        start_date = self.start_date
-        end_date = self.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
-        bar_height = self.milestone_bar_max_height * self.height
-        for milestone in milestones:
-            self._add_milestone(scene, milestone, chart_range, yloc)
-            yloc += bar_height
-
-    def plot(self, path: Path):
-        scene = Scene()
-
-        self._add_milestones(scene)
-
-        renderer = CairoInterface()
-        renderer.draw_svg(scene, path)

icplot-0.0.9/src/icplot/project_elements.py

@@ -1,4 +0,0 @@
-class GitlabUser:
-
-    def __init__(self):
-        self.name = ""

icplot-0.0.9/test/test_cairo_interface.py

@@ -1,6 +0,0 @@
-from icplot.cairo_interface import CairoInterface
-
-
-def test_cairo_interface():
-
-    cairo_interface = CairoInterface()

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

@@ -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):