wavesimpro 0.14.1__tar.gz → 0.15.2__tar.gz

{wavesimpro-0.14.1 → wavesimpro-0.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavesimpro
-Version: 0.14.1
+Version: 0.15.2
 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.1 → wavesimpro-0.15.2}/pyproject.toml

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

{wavesimpro-0.14.1 → wavesimpro-0.15.2}/src/wavesimpro/__init__.py

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

{wavesimpro-0.14.1 → wavesimpro-0.15.2}/src/wavesimpro/client.py

@@ -277,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