wavesimpro 0.14.0__tar.gz → 0.15.1__tar.gz

{wavesimpro-0.14.0 → wavesimpro-0.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavesimpro
-Version: 0.14.0
+Version: 0.15.1
 Summary: WavesimPro Python API — cloud execution client for the Rayfos simulation platform
 Author: Rayfos
 Project-URL: Repository, https://github.com/rayfos/wavesimpro

{wavesimpro-0.14.0 → wavesimpro-0.15.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wavesimpro"
-version = "0.14.0"
+version = "0.15.1"
 description = "WavesimPro Python API — cloud execution client for the Rayfos simulation platform"
 readme = "README.md"
 requires-python = ">=3.8"

{wavesimpro-0.14.0 → wavesimpro-0.15.1}/src/wavesimpro/__init__.py

@@ -49,7 +49,7 @@ from .json_helper import (
     parse_progress_data,
 )
 
-__version__ = "0.14.0"
+__version__ = "0.15.1"
 __all__ = [
     # Client
     "RayfosClient",

{wavesimpro-0.14.0 → wavesimpro-0.15.1}/src/wavesimpro/client.py

@@ -4,6 +4,7 @@ Main client class for interacting with RayfosJobServer
 
 import os
 import logging
+from contextlib import contextmanager
 from typing import Dict, List, Optional, Any, BinaryIO
 from pathlib import Path
 import requests
@@ -28,17 +29,27 @@ except ImportError:
     _HAVE_TQDM = False
 
 
+@contextmanager
 def _wrap_with_progress(stream, total_bytes: int, desc: str):
-    """Wrap a file-like object's read() with a tqdm progress bar.
+    """Context manager that wraps a file-like object's read() with a tqdm
+    progress bar and yields the wrapped stream.
 
-    Returns a context-manager-friendly object. If tqdm is not installed, the
-    original stream is returned and no progress is shown.
+    If tqdm is not installed (or total is unknown), the original stream is
+    yielded and no progress is shown.
+
+    Usage:
+        with _wrap_with_progress(f, size, "Upload foo") as wrapped:
+            requests.put(url, data=wrapped, ...)
     """
     if _HAVE_TQDM and total_bytes > 0:
-        return _tqdm.wrapattr(stream, "read", total=total_bytes, unit="B",
-                              unit_scale=True, unit_divisor=1024, desc=desc,
-                              miniters=1, mininterval=0.5)
-    return stream
+        # tqdm.wrapattr is itself a context manager whose __enter__ returns
+        # the wrapped stream — re-yield that so callers get a file-like object.
+        with _tqdm.wrapattr(stream, "read", total=total_bytes, unit="B",
+                            unit_scale=True, unit_divisor=1024, desc=desc,
+                            miniters=1, mininterval=0.5) as wrapped:
+            yield wrapped
+    else:
+        yield stream
 
 
 def _make_progress_callback(total_bytes: int, desc: str):
@@ -266,6 +277,80 @@ class RayfosClient:
     # PROJECT MANAGEMENT METHODS
     # ========================================================================
     
+    def preflight_check(
+        self,
+        domain_um: tuple,
+        voxel_um: float,
+        boundary_um: float = 0.0,
+        periodic: tuple = (False, False, False),
+        engine_preference: str = "Any",
+        use_gpu: Optional[bool] = None,
+    ) -> Dict[str, Any]:
+        """
+        Ask the server (cloud or machine-service) whether a simulation of the
+        given shape will fit on the available compute targets, BEFORE uploading
+        any files.
+
+        This calls POST /api/preflightCheck. The same response shape is returned
+        regardless of which server answers (cloud aggregator vs single machine).
+
+        Args:
+            domain_um: (size_x, size_y, size_z) simulation domain extent in μm
+            voxel_um:  voxel size in μm
+            boundary_um: PML / absorbing-boundary thickness in μm
+            periodic: (periodic_x, periodic_y, periodic_z) — periodic axes don't get boundary padding
+            engine_preference: "Any" | "Python" | "Cpp"
+            use_gpu: None (auto), True (require GPU), False (force CPU)
+
+        Returns:
+            PreflightCheckResponse dict with keys:
+              - status: "Ok" | "Warning" | "Error"
+              - description: human-readable summary
+              - estimate: { nx, ny, nz, paddedNx, ..., totalMemoryGB, ... }
+              - machines: [{ machineId, gpuMemoryGB, cpuMemoryGB, fitsOnGpu, fitsOnCpu, ... }]
+              - recommendedMachineId
+              - suggestedAdjustments: [str, ...]
+
+        The minimal WavesimProperties payload is built here (no primitives, no
+        sources) since the estimator only needs domain + voxel + boundary + periodic.
+        """
+        size_x, size_y, size_z = domain_um
+        periodic_x, periodic_y, periodic_z = periodic
+        body = {
+            "wavesimProperties": {
+                "simulationDomain": {
+                    "positioningMode": "CenterAndSize",
+                    "position": {
+                        "x": {"value": 0.0, "unit": "Micrometers"},
+                        "y": {"value": 0.0, "unit": "Micrometers"},
+                        "z": {"value": 0.0, "unit": "Micrometers"},
+                    },
+                    "size": {
+                        "width":  {"value": float(size_x), "unit": "Micrometers"},
+                        "height": {"value": float(size_y), "unit": "Micrometers"},
+                        "depth":  {"value": float(size_z), "unit": "Micrometers"},
+                    },
+                },
+                "voxelSize":    {"value": float(voxel_um),    "unit": "Micrometers"},
+                "boundarySize": {"value": float(boundary_um), "unit": "Micrometers"},
+                "periodicX": bool(periodic_x),
+                "periodicY": bool(periodic_y),
+                "periodicZ": bool(periodic_z),
+            },
+            "enginePreference": engine_preference,
+            "useGpu": use_gpu,
+        }
+        # Machine service URL takes precedence (local single-machine preflight); else cloud aggregator.
+        if self.config.machine_service_url:
+            url = self.config.get_machine_service_url("/api/preflightCheck")
+            verify = self.config.verify_ssl_machine_service
+        else:
+            url = self.config.get_api_url("/api/preflightCheck")
+            verify = self.config.verify_ssl
+        logger.info(f"POST {url} [preflight]")
+        response = self.session.post(url, json=body, timeout=self.config.timeout, verify=verify)
+        return self._handle_response(response)
+
     def get_projects(self) -> List[Dict[str, Any]]:
         """
         Get all projects for the authenticated user
@@ -542,8 +627,8 @@ class RayfosClient:
             "x-ms-blob-type": "BlockBlob",
             "Content-Length": str(file_size),
         }
-        with open(file_path, "rb") as f:
-            wrapped = _wrap_with_progress(f, file_size, f"Upload {file_path.name}")
+        with open(file_path, "rb") as f, \
+                _wrap_with_progress(f, file_size, f"Upload {file_path.name}") as wrapped:
             upload_response = requests.put(
                 sas_url,
                 data=wrapped,
@@ -584,8 +669,8 @@ class RayfosClient:
         endpoint = f"/api/files/projects/{project_id}/versions/{version_id}/upload"
 
         file_size = file_path.stat().st_size
-        with open(file_path, "rb") as f:
-            wrapped = _wrap_with_progress(f, file_size, f"Upload {file_path.name}")
+        with open(file_path, "rb") as f, \
+                _wrap_with_progress(f, file_size, f"Upload {file_path.name}") as wrapped:
             files = {
                 "file": (file_path.name, wrapped, "application/octet-stream")
             }

{wavesimpro-0.14.0 → wavesimpro-0.15.1}/src/wavesimpro/execute.py

@@ -200,6 +200,46 @@ def execute_via_api(
         verify_ssl_machine_service=verify_ssl_machine,
     )
 
+    # 5b. Preflight check — abort BEFORE creating a project / uploading anything
+    #     if the simulation won't fit on the available compute targets.
+    domain_x_um = float(nx) * float(pixel_size)
+    domain_y_um = float(ny) * float(pixel_size)
+    domain_z_um = float(nz) * float(pixel_size)
+    try:
+        pre = client.preflight_check(
+            domain_um=(domain_x_um, domain_y_um, domain_z_um),
+            voxel_um=float(pixel_size),
+            boundary_um=float(boundary_width) * float(pixel_size),
+            periodic=(bool(periodic[0]), bool(periodic[1]), bool(periodic[2])),
+            engine_preference=engine_preference,
+            use_gpu=use_gpu,
+        )
+    except Exception as exc:
+        logger.warning(f"Preflight check failed (server may not support /api/preflightCheck yet): {exc}. Proceeding without it.")
+        pre = None
+
+    if pre is not None:
+        status = (pre.get("status") or "").lower()
+        description = pre.get("description") or ""
+        est = pre.get("estimate") or {}
+        logger.info(
+            f"Preflight: status={status} "
+            f"est_total={est.get('totalMemoryGB', 0):.2f} GB "
+            f"(E-field {est.get('efieldMemoryGB', 0):.2f} GB + workspace {est.get('workspaceMemoryGB', 0):.2f} GB) "
+            f"grid={est.get('nx')}x{est.get('ny')}x{est.get('nz')}"
+        )
+        logger.info(f"Preflight: {description}")
+        for s in pre.get("suggestedAdjustments") or []:
+            logger.info(f"  Suggestion: {s}")
+        if status == "error":
+            raise RuntimeError(
+                f"Preflight rejected the simulation: {description} "
+                f"(no upload was attempted). "
+                f"Suggested adjustments: {pre.get('suggestedAdjustments') or '(none)'}"
+            )
+        if status == "warning":
+            logger.warning(f"Preflight warning: {description}")
+
     # 6. Create or reuse project/version
     auto_create = not project_id or not version_id
     if auto_create:

{wavesimpro-0.14.0 → wavesimpro-0.15.1}/src/wavesimpro.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavesimpro
-Version: 0.14.0
+Version: 0.15.1
 Summary: WavesimPro Python API — cloud execution client for the Rayfos simulation platform
 Author: Rayfos
 Project-URL: Repository, https://github.com/rayfos/wavesimpro