icplot 0.1.0__tar.gz → 0.1.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.1.0
+Version: 0.1.2
 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.6
+Requires-Dist: iccore==0.1.8
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -31,41 +31,46 @@ Requires-Dist: CairoSVG; extra == "cairo"
 
 # icplot
 
-This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
+This is a library used at [The Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) for generating plots and graphics for technical documents.
 
-# Installation #
+# Features #
 
-The package is available on PyPI. For a minimal installation you can do:
+The project has support for:
+
+* Coverting image formats between pdf, svg and png
+* Building pdf output from tex files, including tikz.
+* Generating plots based on a serializable data model to support reproducible research
+
+To covert between image formats you can do:
 
 ``` shell
-pip install icplot
+icplot convert --source my_image.svg --target my_image.png
 ```
 
-For full functionality, particularly for conversion of image formats `imagemagick` and `cairo` are required. On Mac you can install them with:
+To render a Tex tikz image as pdf and png you can do:
 
 ``` shell
-brew install imagemagick cairo
+icplot convert --source my_tikz.tex
 ```
 
-# Features #
+To generate a plot or collection of plots from a yaml description you can do:
 
-The project has support for:
-
-* Coverting image formats between pdf, svg and png
-* Building pdf output from tex files, including tikz.
+``` shell
+icplot plot --config my_plot.yml
+```
 
-There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.
+# Installation #
 
-To covert between image formats you can do:
+The package is available on PyPI. For a minimal installation you can do:
 
 ``` shell
-icplot convert --source my_image.svg --target my_image.png
+pip install icplot
 ```
 
-To render a Tex tikz image as pdf and png you can do:
+For full functionality, particularly conversion of image formats, `imagemagick` and `cairo` are required. On Mac you can install them with:
 
 ``` shell
-icplot convert --source my_tikz.tex
+brew install imagemagick cairo
 ```
 
 # Copyright #

{icplot-0.1.0 → icplot-0.1.2}/README.md

@@ -1,40 +1,45 @@
 # icplot
 
-This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
+This is a library used at [The Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) for generating plots and graphics for technical documents.
 
-# Installation #
+# Features #
 
-The package is available on PyPI. For a minimal installation you can do:
+The project has support for:
+
+* Coverting image formats between pdf, svg and png
+* Building pdf output from tex files, including tikz.
+* Generating plots based on a serializable data model to support reproducible research
+
+To covert between image formats you can do:
 
 ``` shell
-pip install icplot
+icplot convert --source my_image.svg --target my_image.png
 ```
 
-For full functionality, particularly for conversion of image formats `imagemagick` and `cairo` are required. On Mac you can install them with:
+To render a Tex tikz image as pdf and png you can do:
 
 ``` shell
-brew install imagemagick cairo
+icplot convert --source my_tikz.tex
 ```
 
-# Features #
+To generate a plot or collection of plots from a yaml description you can do:
 
-The project has support for:
-
-* Coverting image formats between pdf, svg and png
-* Building pdf output from tex files, including tikz.
+``` shell
+icplot plot --config my_plot.yml
+```
 
-There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.
+# Installation #
 
-To covert between image formats you can do:
+The package is available on PyPI. For a minimal installation you can do:
 
 ``` shell
-icplot convert --source my_image.svg --target my_image.png
+pip install icplot
 ```
 
-To render a Tex tikz image as pdf and png you can do:
+For full functionality, particularly conversion of image formats, `imagemagick` and `cairo` are required. On Mac you can install them with:
 
 ``` shell
-icplot convert --source my_tikz.tex
+brew install imagemagick cairo
 ```
 
 # Copyright #

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

@@ -1,6 +1,6 @@
 [project]
 name = "icplot"
-version = "0.1.0"
+version = "0.1.2"
 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.6"]
+	       "iccore==0.1.8"]
 
 [project.urls]
 Repository = "https://git.ichec.ie/performance/toolshed/icplot"
@@ -41,7 +41,7 @@ cairo = [
 ]
 
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project.scripts]
@@ -73,7 +73,7 @@ skip_missing_interpreters = true
 [testenv]
 description = run unit tests
 deps =
-    pytest>=7
+    pytest
     pytest-sugar
     pytest-cov
     .[cairo]
@@ -85,7 +85,7 @@ description = run linters
 skip_install = true
 deps =
     black
-commands = black {posargs:src}
+commands = black {posargs:src test}
 
 [testenv:style]
 description = run style check
@@ -97,7 +97,7 @@ commands = flake8 {posargs:src}
 [testenv:type]
 description = run type checks
 deps =
-    mypy>=0.991
+    mypy
 commands =
     mypy {posargs:src test}
 

{icplot-0.1.0 → icplot-0.1.2}/src/icplot/color.py

@@ -7,7 +7,7 @@ from typing import Callable
 from pydantic import BaseModel
 
 
-class Color(BaseModel):
+class Color(BaseModel, frozen=True):
     """
     A color class, internal storage is rgba as float.
     """
@@ -31,9 +31,6 @@ class Color(BaseModel):
     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:
     """
@@ -44,10 +41,10 @@ class ColorMap:
         self.label = label
         self.data_func = data_func
 
-    def get_color(self, cursor: int, values: list) -> Color:
+    def get_color(self, cursor: int, count: int) -> Color:
         """
         Returns a colour based on a cmap and how far across
         the datasets you are
         """
-        position = cursor / (max(len(values) - 1, 1))
+        position = cursor / (max(count - 1, 1))
         return Color.from_list(self.data_func(position))

{icplot-0.1.0 → icplot-0.1.2}/src/icplot/gantt/gantt.py

@@ -7,7 +7,7 @@ from iccore.project import Milestone
 from icplot.color import Color
 
 
-class GanttChart(BaseModel):
+class GanttChart(BaseModel, frozen=True):
 
     milestones: list[Milestone] = []
     title: str = ""

{icplot-0.1.0 → icplot-0.1.2}/src/icplot/graph/__init__.py

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

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

@@ -5,7 +5,7 @@ This module has a plot's axis
 from pydantic import BaseModel
 
 
-class Range(BaseModel):
+class Range(BaseModel, frozen=True):
     """
     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]
@@ -19,9 +19,12 @@ class Range(BaseModel):
         return list(range(self.lower, self.upper, self.step))
 
 
-class PlotAxis(BaseModel):
+class PlotAxis(BaseModel, frozen=True):
     """
     This is a plot's axis
+
+    :param str label: The axis label
+    :param Range | None: A specification for tick marks
     """
 
     label: str = ""

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

@@ -1,5 +1,4 @@
 from typing import Any, Callable
-import copy
 import os
 from pathlib import Path
 
@@ -12,7 +11,7 @@ from .series import LinePlotSeries
 from .matplotlib import render
 
 
-class PlotConfig(BaseModel):
+class PlotConfig(BaseModel, frozen=True):
 
     series_attr: str
     x_attr: str
@@ -36,10 +35,8 @@ def make_plots(
     # Each 'y attribute' in the config corresponds to a 'plot' of this
     # attribute's values.
     for y_attr, plot_template in config.plots.items():
-        new_plot = copy.deepcopy(plot_template)
-        new_plot.name = y_attr
-        series = []
 
+        series = []
         for label in series_labels:
             # Get results for this series
             label_results = [
@@ -65,8 +62,7 @@ def make_plots(
                 )
             else:
                 series.append(LinePlotSeries(x=x, y=y, label=label))
-        new_plot.series.extend(series)
-        plots.append(new_plot)
+        plots.append(plot_template.copy(update={"name": y_attr, "series": series}))
     return plots
 
 

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

@@ -9,9 +9,9 @@ default_backend = mpl.get_backend()
 mpl.use("Agg")
 import matplotlib.pyplot as plt  # NOQA
 
-from icplot.color import ColorMap  # NOQA
+from icplot.color import ColorMap, Color  # NOQA
 from .series import PlotSeries, LinePlotSeries, ScatterPlotSeries, ImageSeries  # NOQA
-from .plot import Plot, GridPlot, apply_colors  # NOQA
+from .plot import Plot, GridPlot, get_series_colors  # NOQA
 
 
 class MatplotlibColorMap(ColorMap):
@@ -23,32 +23,53 @@ class MatplotlibColorMap(ColorMap):
         super().__init__(label, mpl.colormaps[label])
 
 
-def _set_decorations(ax, plot: Plot):
-    ax.legend(loc="upper left")
+def _set_decorations(axs, plot: Plot):
+    ax = axs[0]
+    if plot.legend.lower() != "none":
+        ax.legend(loc=plot.legend)
     if plot.x_axis.label:
         ax.set_xlabel(plot.x_axis.label)
-    if plot.y_axis.label:
-        ax.set_ylabel(plot.y_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.y_axis.ticks:
-        ax.set_yticks(plot.y_axis.resolved_ticks)
     if plot.title:
         ax.set_title(plot.title)
 
 
-def _plot_line(ax, series: LinePlotSeries):
+def _plot_line(axs, series: LinePlotSeries, color: Color | None):
+    if not series.position_right:
+        ax = axs[0]
+    else:
+        ax = axs[1]
+
+    if color:
+        render_color: list | None = series.color.as_list()
+    else:
+        render_color = None
+
     ax.plot(
         series.x,
         series.y,
         label=series.label,
-        color=series.color.as_list(),
+        color=render_color,
         marker=series.marker,
+        drawstyle=series.drawstyle,
+        linestyle=series.linestyle,
     )
 
 
-def _plot_scatter(ax, series: ScatterPlotSeries):
-    ax.scatter(series.data, label=series.label, color=series.color.as_list())
+def _plot_scatter(ax, series: ScatterPlotSeries, color: Color | None):
+
+    if color:
+        render_color: list | None = series.color.as_list()
+    else:
+        render_color = None
+
+    ax.scatter(series.data, label=series.label, color=render_color)
 
 
 def _plot_image(ax, series: ImageSeries):
@@ -56,11 +77,12 @@ def _plot_image(ax, series: ImageSeries):
     ax.axis("off")
 
 
-def _plot_series(ax, series: PlotSeries):
+def _plot_series(axs, series: PlotSeries, color: Color | None = None):
+    ax = axs[0]
     if series.series_type == "line":
-        _plot_line(ax, cast(LinePlotSeries, series))
+        _plot_line(axs, cast(LinePlotSeries, series), color)
     elif series.series_type == "scatter":
-        _plot_scatter(ax, cast(ScatterPlotSeries, series))
+        _plot_scatter(ax, cast(ScatterPlotSeries, series), color)
     elif series.series_type == "image":
         _plot_image(ax, cast(ImageSeries, series))
 
@@ -78,14 +100,17 @@ def render(
     plot: Plot, path: Path | None = None, cmap=MatplotlibColorMap("gist_rainbow")
 ):
 
-    apply_colors(cmap, plot)
+    colors = get_series_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(ax, series)
+    for series, color in zip(plot.series, colors):
+        _plot_series(axs, series, color)
 
-    _set_decorations(ax, plot)
+    _set_decorations(axs, plot)
 
     _render(fig, path)
 

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

@@ -6,13 +6,13 @@ import random
 
 from pydantic import BaseModel
 
-from icplot.color import ColorMap
+from icplot.color import ColorMap, Color
 
 from .axis import PlotAxis
 from .series import PlotSeries
 
 
-class Plot(BaseModel):
+class Plot(BaseModel, frozen=True):
     """
     A generic plot with optional axis ticks
     """
@@ -21,12 +21,13 @@ 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 = "none"
 
 
-class GridPlot(Plot):
+class GridPlot(Plot, frozen=True):
     """
     Make a grid of plots
     """
@@ -64,11 +65,16 @@ class GridPlot(Plot):
         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)
+def get_series_colors(cmap: ColorMap, plot: Plot) -> list[Color | None]:
 
-    for idx, series in enumerate(non_highlight):
-        series.color = cmap.get_color(idx, non_highlight)
+    count = 0
+    num_colorable = len([s for s in plot.series if not s.highlight])
+    colors = []
+    for s in plot.series:
+        if not s.highlight:
+            color = cmap.get_color(count, num_colorable)
+            count = count + 1
+        else:
+            color = None
+        colors.append(color)
+    return colors

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

@@ -5,18 +5,22 @@ from pydantic import BaseModel
 from icplot.color import Color
 
 
-class PlotSeries(BaseModel):
+class PlotSeries(BaseModel, frozen=True):
     """
     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):
+class ImageSeries(PlotSeries, frozen=True):
     """
     A plot data series where the elements are images
     """
@@ -26,18 +30,24 @@ class ImageSeries(PlotSeries):
     series_type: str = "image"
 
 
-class LinePlotSeries(PlotSeries):
+class LinePlotSeries(PlotSeries, frozen=True):
     """
     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"
+    linestyle: str = "-"
 
 
-class ScatterPlotSeries(PlotSeries):
+class ScatterPlotSeries(PlotSeries, frozen=True):
 
     data: typing.Any
     series_type: str = "scatter"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.1.0
+Version: 0.1.2
 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.6
+Requires-Dist: iccore==0.1.8
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -31,41 +31,46 @@ Requires-Dist: CairoSVG; extra == "cairo"
 
 # icplot
 
-This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
+This is a library used at [The Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) for generating plots and graphics for technical documents.
 
-# Installation #
+# Features #
 
-The package is available on PyPI. For a minimal installation you can do:
+The project has support for:
+
+* Coverting image formats between pdf, svg and png
+* Building pdf output from tex files, including tikz.
+* Generating plots based on a serializable data model to support reproducible research
+
+To covert between image formats you can do:
 
 ``` shell
-pip install icplot
+icplot convert --source my_image.svg --target my_image.png
 ```
 
-For full functionality, particularly for conversion of image formats `imagemagick` and `cairo` are required. On Mac you can install them with:
+To render a Tex tikz image as pdf and png you can do:
 
 ``` shell
-brew install imagemagick cairo
+icplot convert --source my_tikz.tex
 ```
 
-# Features #
+To generate a plot or collection of plots from a yaml description you can do:
 
-The project has support for:
-
-* Coverting image formats between pdf, svg and png
-* Building pdf output from tex files, including tikz.
+``` shell
+icplot plot --config my_plot.yml
+```
 
-There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.
+# Installation #
 
-To covert between image formats you can do:
+The package is available on PyPI. For a minimal installation you can do:
 
 ``` shell
-icplot convert --source my_image.svg --target my_image.png
+pip install icplot
 ```
 
-To render a Tex tikz image as pdf and png you can do:
+For full functionality, particularly conversion of image formats, `imagemagick` and `cairo` are required. On Mac you can install them with:
 
 ``` shell
-icplot convert --source my_tikz.tex
+brew install imagemagick cairo
 ```
 
 # Copyright #

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

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

{icplot-0.1.0 → icplot-0.1.2}/test/test_cairo_interface.py

@@ -12,14 +12,15 @@ def test_cairo_interface():
 
     scene_items = []
     rect = Rectangle(
-        w=20, h=20, location= (10, 10),
-        fill = Color.from_rgba(0.5, 0.5, 1, 0.5),
-        stroke = Color.from_rgba(0.5, 0.0, 0.0, 0.5)
+        w=20,
+        h=20,
+        location=(10, 10),
+        fill=Color.from_rgba(0.5, 0.5, 1, 0.5),
+        stroke=Color.from_rgba(0.5, 0.0, 0.0, 0.5),
     )
     scene_items.append(rect)
 
-    text = TextPath(content="Hello World",
-                    location=(5,5))
+    text = TextPath(content="Hello World", location=(5, 5))
     scene_items.append(text)
 
     output_dir = get_test_output_dir()
@@ -28,4 +29,3 @@ def test_cairo_interface():
     scene = Scene(items=scene_items)
     cairo_interface.draw_svg(scene, output_dir / "output.svg")
     shutil.rmtree(output_dir)
-    

icplot-0.1.2/test/test_gantt_chart.py

@@ -0,0 +1,26 @@
+import os
+import datetime
+from pathlib import Path
+
+from iccore.project import Milestone
+
+from icplot.gantt import GanttChart
+
+
+def test_gantt_chart():
+
+    milestone0 = Milestone(
+        title="My Milestone 0",
+        description="Description of Milestone 0.",
+        start_date=datetime.date(2024, 6, 30),
+        due_date=datetime.date(2024, 7, 12),
+    )
+
+    milestone1 = Milestone(
+        title="My Milestone 1",
+        description="Description of Milestone 1.",
+        start_date=datetime.date(2024, 7, 1),
+        due_date=datetime.date(2024, 7, 15),
+    )
+
+    _ = GanttChart(milestones=[milestone0, milestone1])

{icplot-0.1.0 → icplot-0.1.2}/test/test_line_plots.py

@@ -10,16 +10,15 @@ def test_line_plot():
 
     series = []
     for idx, [x, y] in enumerate(data):
-        series_config = {"label" : f"Series {idx}", "x" : x, "y" : y}
+        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_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)
 

{icplot-0.1.0 → icplot-0.1.2}/test/test_tex_interface.py

@@ -12,12 +12,12 @@ def test_tex_interface():
     data_dir = get_test_data_dir()
     build_dir = get_test_output_dir()
     source = data_dir / "test.tex"
-    
+
     settings = TexBuildSettings(source, build_dir, build_dir)
-    
+
     tex.build(settings)
 
     assert Path(build_dir / "test.pdf").exists()
     assert Path(build_dir / "test.png").exists()
-    
+
     shutil.rmtree(build_dir)

icplot-0.1.0/src/icplot/__init__.py

@@ -1,3 +0,0 @@
-from .convert import convert
-
-__all__ = ["convert"]

icplot-0.1.0/test/test_gantt_chart.py

@@ -1,26 +0,0 @@
-import os
-import datetime
-from pathlib import Path
-
-from iccore.project import Milestone
-
-from icplot.gantt import GanttChart
-
-
-def test_gantt_chart():
-
-    milestone0 = Milestone()
-    milestone0.title = "My Milestone 0"
-    milestone0.description = "Description of Milestone 0."
-    milestone0.start_date = datetime.date(2024, 6, 30)
-    milestone0.due_date = datetime.date(2024, 7, 12)
-
-    milestone1 = Milestone()
-    milestone1.title = "My Milestone 1"
-    milestone1.description = "Description of Milestone 1."
-    milestone1.start_date = datetime.date(2024, 7, 1)
-    milestone1.due_date = datetime.date(2024, 7, 15)
-
-    gantt = GanttChart()
-    gantt.milestones = [milestone0, milestone1]
-