icplot 0.5.0__tar.gz → 0.6.0__tar.gz

{icplot-0.5.0/src/icplot.egg-info → icplot-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.5.0
+Version: 0.6.0
 Summary: Utilities for generating plots and graphics for technical reports.
 Author: Irish Centre for High End Computing
 License: MIT
@@ -20,25 +20,16 @@ Requires-Dist: graphviz
 Requires-Dist: Jinja2
 Provides-Extra: cairo
 Requires-Dist: CairoSVG; extra == "cairo"
-Provides-Extra: scene
-Requires-Dist: pycairo; extra == "scene"
 Provides-Extra: imagemagick
 Requires-Dist: wand; extra == "imagemagick"
 Provides-Extra: plot
 Requires-Dist: matplotlib; extra == "plot"
-Provides-Extra: vtk
-Requires-Dist: vtk; extra == "vtk"
-Provides-Extra: geometry
-Requires-Dist: scipy; extra == "geometry"
 Provides-Extra: video
 Requires-Dist: moviepy; extra == "video"
 Provides-Extra: all
 Requires-Dist: CairoSVG; extra == "all"
-Requires-Dist: pycairo; extra == "all"
 Requires-Dist: wand; extra == "all"
 Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: vtk; extra == "all"
-Requires-Dist: scipy; extra == "all"
 Requires-Dist: moviepy; extra == "all"
 Dynamic: license-file
 
@@ -50,9 +41,12 @@ This is a library used at [The Irish Centre for High End Computing (ICHEC)](http
 
 The library is **frozen to what its consumers use** — the `ichec-handbook`
 build tool and `ichec-flow`. That means `converter`, `renderer`, `theme` and
-`graph`: fixes and maintenance yes, new capability no (planning#136). The
-`geometry`/`mesh` 3D and OpenFOAM code is still here but is scheduled to move
-to a module of its own, and its optional-dependency weight goes with it.
+`graph`: fixes and maintenance yes, new capability no.
+
+The `geometry`/`mesh` 3D and OpenFOAM code has moved to
+[icmesh](https://git.ichec.ie/platform-engineering/modules/ichec-mesh), taking
+VTK and scipy with it — including VTK plot output, which is now
+`icmesh.plot`. Install `icmesh` if you want it.
 
 # Features #
 
@@ -103,7 +97,6 @@ Supported render inputs and targets are:
   * Graph
     * Backends:
       * Matplotlib
-      * VTK
     * Output formats:
       * SVG
       * PNG
@@ -124,10 +117,8 @@ Supported render inputs and targets are:
   * Scene
     * Backends:
       * Cairo
-      * VTK
     * Output formats:
       * SVG
-      * VTK
       
 ## Themes ##
 
@@ -147,14 +138,11 @@ Backends are opt-in via extras:
 
 | Extra | Pulls | Enables |
 |---|---|---|
-| `cairo` | CairoSVG | svg → png / pdf conversion |
-| `scene` | pycairo | vector scene drawing (`renderer.scene.cairo`) |
+| `cairo` | CairoSVG | svg → png / pdf conversion, and vector scene drawing |
 | `imagemagick` | wand | pdf → png conversion (falls back to the `magick` CLI) |
 | `plot` | matplotlib | 2D plotting (`renderer.graph`, `charts`) |
-| `vtk` | vtk | 3D / mesh rendering (`geometry.mesh`) |
-| `geometry` | scipy | geometry transforms (`geometry.operations`) |
 | `video` | moviepy | video assembly (`renderer.video`) |
-| `all` | all of the above | everything (previous default behaviour) |
+| `all` | all of the above | everything |
 
 For example, `pip install icplot[cairo]` for svg conversion, or
 `pip install icplot[all]` for the full toolkit. The native `cairo` and

{icplot-0.5.0 → icplot-0.6.0}/README.md

@@ -6,9 +6,12 @@ This is a library used at [The Irish Centre for High End Computing (ICHEC)](http
 
 The library is **frozen to what its consumers use** — the `ichec-handbook`
 build tool and `ichec-flow`. That means `converter`, `renderer`, `theme` and
-`graph`: fixes and maintenance yes, new capability no (planning#136). The
-`geometry`/`mesh` 3D and OpenFOAM code is still here but is scheduled to move
-to a module of its own, and its optional-dependency weight goes with it.
+`graph`: fixes and maintenance yes, new capability no.
+
+The `geometry`/`mesh` 3D and OpenFOAM code has moved to
+[icmesh](https://git.ichec.ie/platform-engineering/modules/ichec-mesh), taking
+VTK and scipy with it — including VTK plot output, which is now
+`icmesh.plot`. Install `icmesh` if you want it.
 
 # Features #
 
@@ -59,7 +62,6 @@ Supported render inputs and targets are:
   * Graph
     * Backends:
       * Matplotlib
-      * VTK
     * Output formats:
       * SVG
       * PNG
@@ -80,10 +82,8 @@ Supported render inputs and targets are:
   * Scene
     * Backends:
       * Cairo
-      * VTK
     * Output formats:
       * SVG
-      * VTK
       
 ## Themes ##
 
@@ -103,14 +103,11 @@ Backends are opt-in via extras:
 
 | Extra | Pulls | Enables |
 |---|---|---|
-| `cairo` | CairoSVG | svg → png / pdf conversion |
-| `scene` | pycairo | vector scene drawing (`renderer.scene.cairo`) |
+| `cairo` | CairoSVG | svg → png / pdf conversion, and vector scene drawing |
 | `imagemagick` | wand | pdf → png conversion (falls back to the `magick` CLI) |
 | `plot` | matplotlib | 2D plotting (`renderer.graph`, `charts`) |
-| `vtk` | vtk | 3D / mesh rendering (`geometry.mesh`) |
-| `geometry` | scipy | geometry transforms (`geometry.operations`) |
 | `video` | moviepy | video assembly (`renderer.video`) |
-| `all` | all of the above | everything (previous default behaviour) |
+| `all` | all of the above | everything |
 
 For example, `pip install icplot[cairo]` for svg conversion, or
 `pip install icplot[all]` for the full toolkit. The native `cairo` and

{icplot-0.5.0 → icplot-0.6.0}/pyproject.toml

@@ -18,7 +18,7 @@ classifiers = [
 keywords = ["Publishing", "Technical Reports", "Graphics"]
 
 # Core is deliberately light: only what every import path needs. The heavy
-# rendering backends (matplotlib/vtk/scipy/moviepy/wand) are optional extras
+# rendering backends (matplotlib/moviepy/wand) are optional extras
 # so consumers that only use the converter or diagram renderer (e.g. the
 # handbook build) can install a small footprint. Use icplot[all] for the
 # previous behaviour of pulling every backend.
@@ -31,15 +31,10 @@ Repository = "https://git.ichec.ie/platform-engineering/modules/documentation/ic
 Homepage = "https://git.ichec.ie/platform-engineering/modules/documentation/ichec-plot"
 
 [project.optional-dependencies]
-# svg/pdf conversion (converter.svg_to_png / svg_to_pdf). CairoSVG pulls
-# cairocffi, which dlopens libcairo at runtime (no C build step needed).
-cairo = [
-   "CairoSVG"
-]
-
-# vector scene drawing (renderer.scene.cairo). pycairo (module `cairo`)
-# builds against libcairo — needs the cairo headers + a C toolchain at install.
-scene = ["pycairo"]
+# svg/pdf conversion (converter.svg_to_png / svg_to_pdf) and vector scene
+# drawing (renderer.scene.cairo). CairoSVG pulls cairocffi, which dlopens
+# libcairo at runtime — no C build step, and one cairo binding rather than two.
+cairo = ["CairoSVG"]
 
 # raster conversion via ImageMagick bindings (converter.pdf_to_png);
 # falls back to the `magick` CLI if wand is absent
@@ -48,24 +43,15 @@ imagemagick = ["wand"]
 # 2D plotting backend (icplot.renderer.graph / icplot.charts)
 plot = ["matplotlib"]
 
-# 3D / mesh backend (icplot.geometry.mesh, vtk graph backend)
-vtk = ["vtk"]
-
-# geometry transforms (icplot.geometry.operations)
-geometry = ["scipy"]
-
-# video assembly (icplot.renderer.video)
+# video assembly (renderer.video, driven from renderer.graph.mpl)
 video = ["moviepy"]
 
-# convenience aggregate — every backend (pre-split behaviour)
+# convenience aggregate — every backend
 all = [
    "CairoSVG",
-   "pycairo",
    "wand",
    "matplotlib",
-   "vtk",
-   "scipy",
-   "moviepy"
+   "moviepy",
 ]
 
 [build-system]
@@ -115,7 +101,7 @@ src = ["src", "test"]
 select = ["E", "W", "F", "I", "N", "UP", "B"]
 
 [tool.ruff.lint.isort]
-known-first-party = ["icplot"]
+known-first-party = ["icplot", "utils"]
 
 [tool.pytest.ini_options]
 testpaths = ["test",]

{icplot-0.5.0 → icplot-0.6.0}/src/icplot/renderer/graph/renderer.py

@@ -1,3 +1,4 @@
+import logging
 import os
 from collections.abc import Callable
 from pathlib import Path
@@ -13,7 +14,9 @@ from icplot.graph.plot_group import PlotGroupPublic, PlotSeriesPublic
 from icplot.graph.series import LinePlotSeries
 from icplot.renderer.graph.matplotlib import render
 
-from . import mpl, vtk
+from . import mpl
+
+logger = logging.getLogger(__name__)
 
 
 class PlotConfig(BaseModel, frozen=True):
@@ -127,5 +130,6 @@ def plot_series(
     if "mpl" in group.formats:
         mpl.plot(output_path, group, series, converted_data_series)
 
-    if "vtk" in group.formats and data_series.y:
-        vtk.save(output_path, group, series, converted_data_series)
+    if "vtk" in group.formats:
+        # Moved to icmesh.plot — warn rather than silently drop the request.
+        logger.warning("vtk plot output moved to icmesh; skipping %s", output_path)

{icplot-0.5.0 → icplot-0.6.0}/src/icplot/renderer/scene/cairo.py

@@ -1,6 +1,8 @@
 from pathlib import Path
 
-import cairo
+# cairocffi, not pycairo: same drawing API, but it dlopens libcairo instead of
+# building against its headers, and CairoSVG already pulls it in.
+import cairocffi as cairo
 
 from icplot.scene import Rectangle, Scene
 
@@ -54,6 +56,9 @@ def draw_scene(cr, scene: Scene):
 
 
 def render(scene: Scene, path: Path):
-    with cairo.SVGSurface(path, scene.size[0], scene.size[1]) as surface:
-        cr = cairo.Context(surface)
-        draw_scene(cr, scene)
+    # cairocffi surfaces take a str and are not context managers.
+    surface = cairo.SVGSurface(str(path), scene.size[0], scene.size[1])
+    try:
+        draw_scene(cairo.Context(surface), scene)
+    finally:
+        surface.finish()

{icplot-0.5.0 → icplot-0.6.0/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.5.0
+Version: 0.6.0
 Summary: Utilities for generating plots and graphics for technical reports.
 Author: Irish Centre for High End Computing
 License: MIT
@@ -20,25 +20,16 @@ Requires-Dist: graphviz
 Requires-Dist: Jinja2
 Provides-Extra: cairo
 Requires-Dist: CairoSVG; extra == "cairo"
-Provides-Extra: scene
-Requires-Dist: pycairo; extra == "scene"
 Provides-Extra: imagemagick
 Requires-Dist: wand; extra == "imagemagick"
 Provides-Extra: plot
 Requires-Dist: matplotlib; extra == "plot"
-Provides-Extra: vtk
-Requires-Dist: vtk; extra == "vtk"
-Provides-Extra: geometry
-Requires-Dist: scipy; extra == "geometry"
 Provides-Extra: video
 Requires-Dist: moviepy; extra == "video"
 Provides-Extra: all
 Requires-Dist: CairoSVG; extra == "all"
-Requires-Dist: pycairo; extra == "all"
 Requires-Dist: wand; extra == "all"
 Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: vtk; extra == "all"
-Requires-Dist: scipy; extra == "all"
 Requires-Dist: moviepy; extra == "all"
 Dynamic: license-file
 
@@ -50,9 +41,12 @@ This is a library used at [The Irish Centre for High End Computing (ICHEC)](http
 
 The library is **frozen to what its consumers use** — the `ichec-handbook`
 build tool and `ichec-flow`. That means `converter`, `renderer`, `theme` and
-`graph`: fixes and maintenance yes, new capability no (planning#136). The
-`geometry`/`mesh` 3D and OpenFOAM code is still here but is scheduled to move
-to a module of its own, and its optional-dependency weight goes with it.
+`graph`: fixes and maintenance yes, new capability no.
+
+The `geometry`/`mesh` 3D and OpenFOAM code has moved to
+[icmesh](https://git.ichec.ie/platform-engineering/modules/ichec-mesh), taking
+VTK and scipy with it — including VTK plot output, which is now
+`icmesh.plot`. Install `icmesh` if you want it.
 
 # Features #
 
@@ -103,7 +97,6 @@ Supported render inputs and targets are:
   * Graph
     * Backends:
       * Matplotlib
-      * VTK
     * Output formats:
       * SVG
       * PNG
@@ -124,10 +117,8 @@ Supported render inputs and targets are:
   * Scene
     * Backends:
       * Cairo
-      * VTK
     * Output formats:
       * SVG
-      * VTK
       
 ## Themes ##
 
@@ -147,14 +138,11 @@ Backends are opt-in via extras:
 
 | Extra | Pulls | Enables |
 |---|---|---|
-| `cairo` | CairoSVG | svg → png / pdf conversion |
-| `scene` | pycairo | vector scene drawing (`renderer.scene.cairo`) |
+| `cairo` | CairoSVG | svg → png / pdf conversion, and vector scene drawing |
 | `imagemagick` | wand | pdf → png conversion (falls back to the `magick` CLI) |
 | `plot` | matplotlib | 2D plotting (`renderer.graph`, `charts`) |
-| `vtk` | vtk | 3D / mesh rendering (`geometry.mesh`) |
-| `geometry` | scipy | geometry transforms (`geometry.operations`) |
 | `video` | moviepy | video assembly (`renderer.video`) |
-| `all` | all of the above | everything (previous default behaviour) |
+| `all` | all of the above | everything |
 
 For example, `pip install icplot[cairo]` for svg conversion, or
 `pip install icplot[all]` for the full toolkit. The native `cairo` and

{icplot-0.5.0 → icplot-0.6.0}/src/icplot.egg-info/SOURCES.txt

@@ -18,23 +18,6 @@ src/icplot/converter/__init__.py
 src/icplot/converter/cli.py
 src/icplot/converter/convert.py
 src/icplot/converter/image.py
-src/icplot/geometry/__init__.py
-src/icplot/geometry/base.py
-src/icplot/geometry/operations.py
-src/icplot/geometry/shapes.py
-src/icplot/geometry/transform.py
-src/icplot/geometry/mesh/__init__.py
-src/icplot/geometry/mesh/cell.py
-src/icplot/geometry/mesh/edge.py
-src/icplot/geometry/mesh/mesh.py
-src/icplot/geometry/mesh/operations.py
-src/icplot/geometry/mesh/shapes.py
-src/icplot/geometry/mesh/vertex.py
-src/icplot/geometry/mesh/vtk.py
-src/icplot/geometry/mesh/openfoam/__init__.py
-src/icplot/geometry/mesh/openfoam/blockmesh.py
-src/icplot/geometry/mesh/openfoam/foamfile.py
-src/icplot/geometry/mesh/openfoam/polymesh.py
 src/icplot/graph/__init__.py
 src/icplot/graph/axis.py
 src/icplot/graph/plot.py
@@ -57,7 +40,6 @@ src/icplot/renderer/graph/color.py
 src/icplot/renderer/graph/matplotlib.py
 src/icplot/renderer/graph/mpl.py
 src/icplot/renderer/graph/renderer.py
-src/icplot/renderer/graph/vtk.py
 src/icplot/renderer/scene/cairo.py
 src/icplot/theme/__init__.py
 src/icplot/theme/cli.py
@@ -70,14 +52,11 @@ src/icplot/theme/templates/tikz.j2
 test/test_cairo.py
 test/test_frontmatter.py
 test/test_gantt_chart.py
-test/test_geometry.py
 test/test_image.py
 test/test_line_plots.py
 test/test_mermaid.py
-test/test_meshing.py
-test/test_openfoam.py
 test/test_plot_group.py
-test/test_polymesh.py
 test/test_puml.py
 test/test_tex.py
+test/test_theme_generator.py
 test/test_tree.py

{icplot-0.5.0 → icplot-0.6.0}/src/icplot.egg-info/requires.txt

@@ -4,30 +4,18 @@ Jinja2
 
 [all]
 CairoSVG
-pycairo
 wand
 matplotlib
-vtk
-scipy
 moviepy
 
 [cairo]
 CairoSVG
 
-[geometry]
-scipy
-
 [imagemagick]
 wand
 
 [plot]
 matplotlib
 
-[scene]
-pycairo
-
 [video]
 moviepy
-
-[vtk]
-vtk

{icplot-0.5.0 → icplot-0.6.0}/test/test_cairo.py

@@ -1,11 +1,10 @@
 import os
 import shutil
 
-from iccore.test_utils import get_test_output_dir
-
 from icplot.renderer.scene import cairo as cairo_interface
 from icplot.scene import Rectangle, Scene, TextPath
 from icplot.theme.color import Color
+from utils import get_test_output_dir
 
 
 def test_cairo():

{icplot-0.5.0 → icplot-0.6.0}/test/test_frontmatter.py

@@ -1,9 +1,8 @@
 from pathlib import Path
 
-from iccore.test_utils import get_test_data_dir
-
 from icplot.renderer.config import PlantUmlConfig, RenderConfig, apply_frontmatter
 from icplot.renderer.frontmatter import parse
+from utils import get_test_data_dir
 
 
 def test_parse_returns_dict():

{icplot-0.5.0 → icplot-0.6.0}/test/test_image.py

@@ -1,9 +1,8 @@
 import os
 from pathlib import Path
 
-from iccore.test_utils import get_test_output_dir
-
 from icplot.converter.image import _pdf_to_png, svg_to_pdf, svg_to_png
+from utils import get_test_output_dir
 
 
 def get_test_data_dir():

{icplot-0.5.0 → icplot-0.6.0}/test/test_mermaid.py

@@ -1,10 +1,9 @@
 import shutil
 from pathlib import Path
 
-from iccore.test_utils import get_test_data_dir, get_test_output_dir
-
 from icplot.renderer.config import MermaidConfig, RenderConfig, RenderContext
 from icplot.renderer.formats import mermaid
+from utils import get_test_data_dir, get_test_output_dir
 
 
 def test_mermaid():

{icplot-0.5.0 → icplot-0.6.0}/test/test_puml.py

@@ -1,9 +1,8 @@
 import shutil
 
-from iccore.test_utils import get_test_data_dir, get_test_output_dir
-
 from icplot.renderer.config import RenderConfig, RenderContext
 from icplot.renderer.formats import plantuml
+from utils import get_test_data_dir, get_test_output_dir
 
 
 def test_puml():

{icplot-0.5.0 → icplot-0.6.0}/test/test_tex.py

@@ -1,9 +1,8 @@
 import shutil
 
-from iccore.test_utils import get_test_data_dir, get_test_output_dir
-
 from icplot.renderer.config import RenderConfig, RenderContext
 from icplot.renderer.formats import tex
+from utils import get_test_data_dir, get_test_output_dir
 
 
 def test_tex():

icplot-0.6.0/test/test_theme_generator.py

@@ -0,0 +1,33 @@
+from pathlib import Path
+
+import icplot.theme
+from icplot.theme.theme_generator import generate_theme
+
+_THEME_DIR = Path(icplot.theme.__file__).parent
+
+
+def test_generate_theme(tmp_path):
+    generate_theme(tmp_path, _THEME_DIR / "theme.json", _THEME_DIR / "templates")
+
+    puml = tmp_path / "puml-theme-platform.puml"
+    tikz = tmp_path / "tikzlibraryplatform.code.tex"
+    assert puml.exists()
+    assert tikz.exists()
+
+    # Tokens must be substituted, not left as Jinja placeholders. The templates
+    # target PlantUML and TeX, so autoescape is off — a mangled colour here
+    # would mean it was turned back on.
+    for path in (puml, tikz):
+        content = path.read_text()
+        assert content.strip()
+        assert "{{" not in content
+        assert "&#" not in content
+
+
+def test_generate_theme_missing_file(tmp_path):
+    try:
+        generate_theme(tmp_path, tmp_path / "absent.json", _THEME_DIR / "templates")
+    except RuntimeError as e:
+        assert "not found" in str(e).lower()
+    else:
+        raise AssertionError("expected RuntimeError for a missing theme file")

{icplot-0.5.0 → icplot-0.6.0}/test/test_tree.py

@@ -2,9 +2,8 @@ import os
 import shutil
 from pathlib import Path
 
-from iccore.test_utils import get_test_output_dir
-
 from icplot.charts.tree import display_tree
+from utils import get_test_output_dir
 
 
 class BinaryTreeNode:

icplot-0.5.0/src/icplot/geometry/__init__.py

@@ -1,4 +0,0 @@
-from .base import *  # NOQA
-from .operations import *  # NOQA
-from .shapes import *  # NOQA
-from .transform import *  # NOQA

icplot-0.5.0/src/icplot/geometry/base.py

@@ -1,68 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-
-import numpy as np
-
-from .operations import get_point_distance
-
-
-@dataclass(frozen=True)
-class Vector:
-    """
-    A 3d spatial vector
-    """
-
-    x: float
-    y: float = 0.0
-    z: float = 0.0
-
-    def scale(self, factor: float) -> Vector:
-        return Vector(self.x * factor, self.y * factor, self.z * factor)
-
-    def as_array(self) -> np.ndarray:
-        return np.array([self.x, self.y, self.z])
-
-    def subtract(self, v: Vector) -> Vector:
-        return Vector(self.x - v.x, self.y - v.y, self.z - v.z)
-
-
-@dataclass(frozen=True)
-class Point:
-    """
-    A location in 3d space
-    """
-
-    x: float
-    y: float = 0.0
-    z: float = 0.0
-
-    def as_array(self) -> np.ndarray:
-        return np.array([self.x, self.y, self.z])
-
-    def translate(self, v: Vector) -> Point:
-        return Point(self.x + v.x, self.y + v.y, self.z + v.z)
-
-    @staticmethod
-    def from_array(arr: np.ndarray) -> Point:
-        return Point(arr[0], arr[1], arr[2])
-
-    def subtract(self, v: Vector) -> Vector:
-        return Vector(self.x - v.x, self.y - v.y, self.z - v.z)
-
-    def get_distance(self, p: Point) -> float:
-        return get_point_distance(p.as_array(), self.as_array())
-
-
-@dataclass(frozen=True)
-class Bounds:
-    """
-    A bounding box
-    """
-
-    xmin: float
-    xmax: float
-    ymin: float
-    ymax: float
-    zmin: float = 0.0
-    zmax: float = 0.0

icplot-0.5.0/src/icplot/geometry/mesh/__init__.py

@@ -1,6 +0,0 @@
-from .cell import *  # NOQA
-from .edge import *  # NOQA
-from .mesh import *  # NOQA
-from .operations import *  # NOQA
-from .shapes import *  # NOQA
-from .vertex import *  # NOQA