cloudglancer 0.1.7__tar.gz → 0.1.9__tar.gz

{cloudglancer-0.1.7/cloudglancer.egg-info → cloudglancer-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudglancer
-Version: 0.1.7
+Version: 0.1.9
 Summary: Simple interactive visualization of 3D point clouds
 Author-email: Your Name <your.email@example.com>
 License: MIT
@@ -24,7 +24,7 @@ Requires-Dist: plotly>=5.0.0
 Requires-Dist: pandas>=2.0.0
 Requires-Dist: numpy>=1.24.0
 Requires-Dist: nbformat>=4.2.0
-Requires-Dist: kaleido<1.0,>=0.2.1
+Requires-Dist: kaleido>=0.2.1
 Requires-Dist: Pillow>=9.0.0
 Requires-Dist: tqdm>=4.0.0
 Provides-Extra: dev
@@ -75,6 +75,9 @@ fig = cg.plot(points, size=2.0)
 cg.animate(fig, "rotation.gif", axis="z", n_frames=60)
 ```
 
+Frames are rendered in parallel; pass `n_workers` to control how many render
+processes are used (defaults to `min(16, cpu_count)`).
+
 Render a batch of point clouds as a grid of subplots (one cloud per cell):
 
 ```python

{cloudglancer-0.1.7 → cloudglancer-0.1.9}/README.md

@@ -40,6 +40,9 @@ fig = cg.plot(points, size=2.0)
 cg.animate(fig, "rotation.gif", axis="z", n_frames=60)
 ```
 
+Frames are rendered in parallel; pass `n_workers` to control how many render
+processes are used (defaults to `min(16, cpu_count)`).
+
 Render a batch of point clouds as a grid of subplots (one cloud per cell):
 
 ```python

{cloudglancer-0.1.7 → cloudglancer-0.1.9}/cloudglancer/animate.py

@@ -2,9 +2,10 @@
 
 import multiprocessing
 import os
+import sys
 from concurrent.futures import ProcessPoolExecutor
 from io import BytesIO
-from typing import Tuple
+from typing import Optional, Tuple
 
 import numpy as np
 from plotly.graph_objects import Figure
@@ -40,25 +41,36 @@ def _scene_keys(fig: Figure) -> list:
     return keys
 
 
-def _eye_to_vec(eye) -> np.ndarray:
-    if eye is None or eye.x is None:
+def _eye_to_vec(eye: dict) -> np.ndarray:
+    if not eye or eye.get("x") is None:
         return np.array([1.25, 1.25, 1.25])
-    return np.array([eye.x, eye.y, eye.z])
+    return np.array([eye["x"], eye["y"], eye["z"]], dtype=float)
 
 
-_WORKER_FIG = None
+_WORKER_FIG_DICT = None
 
 
 def _init_worker(fig_dict: dict) -> None:
-    global _WORKER_FIG
-    from plotly.graph_objects import Figure as _Figure
-    _WORKER_FIG = _Figure(fig_dict)
+    global _WORKER_FIG_DICT
+    import warnings
+    warnings.filterwarnings("ignore", category=DeprecationWarning,
+                            message=r".*[Kk]aleido.*")
+    _WORKER_FIG_DICT = fig_dict
+    import kaleido
+    if hasattr(kaleido, "start_sync_server"):
+        # kaleido >= 1 launches a new Chrome per to_image() call unless a
+        # server is running; keep one Chrome per worker for all its frames.
+        kaleido.start_sync_server(silence_warnings=True)
 
 
 def _render_frame(args: Tuple[dict, int, int]) -> bytes:
-    scene_updates, width, height = args
-    _WORKER_FIG.update_layout(**scene_updates)
-    return _WORKER_FIG.to_image(format="png", width=width, height=height)
+    cameras, width, height = args
+    import plotly.io as pio
+    layout = _WORKER_FIG_DICT.setdefault("layout", {})
+    for key, cam in cameras.items():
+        layout.setdefault(key, {})["camera"] = cam
+    return pio.to_image(_WORKER_FIG_DICT, format="png",
+                        width=width, height=height, validate=False)
 
 
 def animate(
@@ -71,6 +83,7 @@ def animate(
     height: int = 600,
     loop: int = 0,
     progress: bool = True,
+    n_workers: Optional[int] = None,
 ) -> str:
     """
     Render a rotating GIF of a 3D Plotly figure.
@@ -90,12 +103,18 @@ def animate(
         height: Frame height in pixels. Defaults to 600.
         loop: Number of times the GIF should loop (0 = infinite). Defaults to 0.
         progress: Show a tqdm progress bar while rendering frames. Defaults to True.
+        n_workers: Number of parallel render processes. Defaults to
+            ``min(16, cpu_count, n_frames)``. Raise it on machines with many
+            cores for large frame counts. On non-Linux platforms worker
+            processes are spawned, so scripts calling ``animate()`` there must
+            be guarded by ``if __name__ == "__main__":``.
 
     Returns:
         The ``output_path`` it wrote to.
 
     Raises:
-        ValueError: If `axis` is not one of ``'x'``, ``'y'``, ``'z'``.
+        ValueError: If `axis` is not one of ``'x'``, ``'y'``, ``'z'``, or
+            `n_workers` is less than 1.
         ImportError: If ``kaleido`` or ``Pillow`` is not installed.
 
     Examples:
@@ -116,6 +135,14 @@ def animate(
             "animate() requires Pillow. Install it with `pip install Pillow`."
         ) from e
 
+    try:
+        import kaleido  # noqa: F401
+    except ImportError as e:
+        raise ImportError(
+            "animate() requires kaleido for PNG export. "
+            "Install it with `pip install kaleido`."
+        ) from e
+
     axis_vec = _AXIS_VECTORS[axis]
     up_vec = {"x": dict(x=1, y=0, z=0),
               "y": dict(x=0, y=1, z=0),
@@ -125,45 +152,53 @@ def animate(
     if not scene_keys:
         raise ValueError("figure has no 3D scene to animate")
 
-    initial_eyes = {k: _eye_to_vec(fig.layout[k].camera.eye) for k in scene_keys}
+    fig_dict = fig.to_dict()
+    layout_dict = fig_dict.setdefault("layout", {})
+
+    orig_cams = {}
+    initial_eyes = {}
+    for k in scene_keys:
+        cam = dict((layout_dict.get(k) or {}).get("camera") or {})
+        orig_cams[k] = cam
+        initial_eyes[k] = _eye_to_vec(cam.get("eye"))
 
     tasks = []
     for i in range(n_frames):
         theta = 2.0 * np.pi * i / n_frames
         R = _rotation_matrix(axis_vec, theta)
-        scene_updates = {}
+        cameras = {}
         for k in scene_keys:
             eye = R @ initial_eyes[k]
-            scene_updates[k] = dict(
-                camera=dict(
-                    eye=dict(x=float(eye[0]), y=float(eye[1]), z=float(eye[2])),
-                    up=up_vec,
-                )
-            )
-        tasks.append((scene_updates, width, height))
-
-    fig_dict = fig.to_dict()
-    n_workers = min(4, os.cpu_count() or 2, n_frames)
+            cameras[k] = {
+                **orig_cams[k],
+                "eye": dict(x=float(eye[0]), y=float(eye[1]), z=float(eye[2])),
+                "up": up_vec,
+            }
+        tasks.append((cameras, width, height))
+
+    if n_workers is None:
+        n_workers = min(16, os.cpu_count() or 2)
+    elif n_workers < 1:
+        raise ValueError(f"n_workers must be >= 1 (got {n_workers})")
+    n_workers = min(n_workers, n_frames)
+
+    # fork keeps unguarded user scripts working and skips per-worker re-imports;
+    # spawn elsewhere (fork is unsafe on macOS, unavailable on Windows).
+    start_method = "fork" if sys.platform.startswith("linux") else "spawn"
 
     pngs: list = [None] * n_frames
-    try:
-        with ProcessPoolExecutor(
-            max_workers=n_workers,
-            mp_context=multiprocessing.get_context("spawn"),
-            initializer=_init_worker,
-            initargs=(fig_dict,),
-        ) as executor:
-            iterator = executor.map(_render_frame, tasks, chunksize=1)
-            for i, png in enumerate(
-                tqdm(iterator, total=n_frames, desc="Rendering frames",
-                     unit="frame", disable=not progress)
-            ):
-                pngs[i] = png
-    except ValueError as e:
-        raise ImportError(
-            "animate() requires kaleido for PNG export. "
-            "Install it with `pip install 'kaleido<1.0'`."
-        ) from e
+    with ProcessPoolExecutor(
+        max_workers=n_workers,
+        mp_context=multiprocessing.get_context(start_method),
+        initializer=_init_worker,
+        initargs=(fig_dict,),
+    ) as executor:
+        iterator = executor.map(_render_frame, tasks, chunksize=1)
+        for i, png in enumerate(
+            tqdm(iterator, total=n_frames, desc="Rendering frames",
+                 unit="frame", disable=not progress)
+        ):
+            pngs[i] = png
 
     ref_palette = Image.open(BytesIO(pngs[0])).convert("P", palette=Image.ADAPTIVE)
 

{cloudglancer-0.1.7 → cloudglancer-0.1.9/cloudglancer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudglancer
-Version: 0.1.7
+Version: 0.1.9
 Summary: Simple interactive visualization of 3D point clouds
 Author-email: Your Name <your.email@example.com>
 License: MIT
@@ -24,7 +24,7 @@ Requires-Dist: plotly>=5.0.0
 Requires-Dist: pandas>=2.0.0
 Requires-Dist: numpy>=1.24.0
 Requires-Dist: nbformat>=4.2.0
-Requires-Dist: kaleido<1.0,>=0.2.1
+Requires-Dist: kaleido>=0.2.1
 Requires-Dist: Pillow>=9.0.0
 Requires-Dist: tqdm>=4.0.0
 Provides-Extra: dev
@@ -75,6 +75,9 @@ fig = cg.plot(points, size=2.0)
 cg.animate(fig, "rotation.gif", axis="z", n_frames=60)
 ```
 
+Frames are rendered in parallel; pass `n_workers` to control how many render
+processes are used (defaults to `min(16, cpu_count)`).
+
 Render a batch of point clouds as a grid of subplots (one cloud per cell):
 
 ```python

{cloudglancer-0.1.7 → cloudglancer-0.1.9}/cloudglancer.egg-info/requires.txt

@@ -2,7 +2,7 @@ plotly>=5.0.0
 pandas>=2.0.0
 numpy>=1.24.0
 nbformat>=4.2.0
-kaleido<1.0,>=0.2.1
+kaleido>=0.2.1
 Pillow>=9.0.0
 tqdm>=4.0.0
 

{cloudglancer-0.1.7 → cloudglancer-0.1.9}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cloudglancer"
-version = "0.1.7"
+version = "0.1.9"
 description = "Simple interactive visualization of 3D point clouds"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -29,7 +29,7 @@ dependencies = [
     "pandas>=2.0.0",
     "numpy>=1.24.0",
     "nbformat>=4.2.0",
-    "kaleido>=0.2.1,<1.0",
+    "kaleido>=0.2.1",
     "Pillow>=9.0.0",
     "tqdm>=4.0.0",
 ]
@@ -52,6 +52,13 @@ include = ["cloudglancer*"]
 [tool.setuptools.package-data]
 cloudglancer = ["py.typed"]
 
+[tool.pytest.ini_options]
+filterwarnings = [
+    # animate() forks render workers after the pool's manager thread starts; the
+    # workers never touch the inherited locks, so this CPython warning is benign here.
+    "ignore:This process .* is multi-threaded, use of fork:DeprecationWarning",
+]
+
 [tool.black]
 line-length = 100
 target-version = ["py39"]

{cloudglancer-0.1.7 → cloudglancer-0.1.9}/tests/test_animate.py

@@ -54,6 +54,19 @@ def test_animate_combined_figure(tmp_path):
     assert out.exists() and _is_gif(out)
 
 
+def test_animate_n_workers(tmp_path):
+    fig = plot(np.random.randn(20, 3))
+    out = tmp_path / "w.gif"
+    animate(fig, str(out), n_frames=3, width=120, height=120, n_workers=2, progress=False)
+    assert _is_gif(out)
+
+
+def test_animate_invalid_n_workers(tmp_path):
+    fig = plot(np.random.randn(10, 3))
+    with pytest.raises(ValueError, match="n_workers must be >= 1"):
+        animate(fig, str(tmp_path / "x.gif"), n_frames=2, n_workers=0)
+
+
 @pytest.mark.parametrize("axis", ["x", "y", "z"])
 def test_animate_each_axis(tmp_path, axis):
     fig = plot(np.random.randn(20, 3))