wavesimpro 1.0.0__tar.gz → 1.0.2__tar.gz

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/PKG-INFO

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

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/pyproject.toml

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

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/src/wavesimpro/__init__.py

@@ -45,7 +45,7 @@ from .json_helper import (
     parse_progress_data,
 )
 
-__version__ = "1.0.0"
+__version__ = "1.0.2"
 __all__ = [
     # Client
     "RayfosClient",

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/src/wavesimpro/execute.py

@@ -7,13 +7,15 @@ command submission, polling, result download.
 """
 
 import os
+import re
 import json
 import math
 import time
+import shutil
 import logging
 import tempfile
 from pathlib import Path
-from typing import Tuple, Optional, Callable, Dict, Any, List
+from typing import Tuple, Optional, Callable, Dict, Any, List, Union
 
 import numpy as np
 
@@ -44,6 +46,21 @@ def _extract_file_id(file_info: dict) -> str:
     raise KeyError(f"No file ID found in upload response. Keys: {list(file_info.keys())}")
 
 
+def _monitor_output_filename(monitor_name: str) -> str:
+    """Expected on-server filename for a monitor's result.
+
+    Mirrors RayfosMachineService MonitorDataExtractor.BuildMonitorFileName: strip
+    characters illegal in a filename, drop a leading ``monitor[ _-]+`` token (so a
+    monitor named "Monitor_0" yields ``monitor_0.bin``, not ``monitor_Monitor_0.bin``),
+    then prefix ``monitor_`` and append ``.bin``.
+    """
+    core = "".join(c for c in (monitor_name or "") if c not in '<>:"/\\|?*') or "unnamed"
+    stripped = re.sub(r"^monitor[ _\-]+", "", core, flags=re.IGNORECASE)
+    if stripped:
+        core = stripped
+    return f"monitor_{core}.bin"
+
+
 def execute_via_api(
     refractive_index: np.ndarray,
     source,
@@ -71,7 +88,7 @@ def execute_via_api(
     strict_validation: bool = False,
     gpu_memory_max_gb: Optional[float] = None,
     monitors: Optional[List[Dict[str, Any]]] = None,
-) -> Tuple[np.ndarray, bool]:
+) -> Tuple[Union[np.ndarray, List[np.ndarray]], bool]:
     """
     Execute a Wavesim simulation via the Rayfos REST API.
 
@@ -102,10 +119,17 @@ def execute_via_api(
             Ignored when machine_service_url is set (local mode always uses that machine).
         use_gpu: GPU selection — None (auto, default), True (require GPU), False (force CPU).
             Ignored when machine_service_url is set.
+        monitors: Optional list of monitor dicts (from create_monitor()). Each captures a 3D
+            ROI sub-cube of the field. When monitors are given, the server uploads only the
+            monitor_<name>.bin files (not the full output.bin), and this call downloads and
+            returns those instead of output.bin.
 
     Returns:
-        Tuple of (E_field, converged):
-            - E_field: Complex output field array. Vectorial: [3, nx, ny, nz], Scalar: [nx, ny, nz]
+        Tuple of (result, converged):
+            - result: WITHOUT monitors — the complex output field array (Vectorial:
+              [3, nx, ny, nz], Scalar: [nx, ny, nz]). WITH monitors — a LIST of monitor field
+              arrays in the SAME ORDER as the `monitors` argument (disabled monitors skipped),
+              each shaped per its own sub-cube.
             - converged: True if simulation completed successfully
     """
     # 1. Load credentials
@@ -221,7 +245,7 @@ def execute_via_api(
 
     if pre is not None:
         status = (pre.get("status") or "").lower()
-        description = pre.get("description") or ""
+        pre_description = pre.get("description") or ""
         est = pre.get("estimate") or {}
         logger.info(
             f"Preflight: status={status} "
@@ -229,24 +253,24 @@ def execute_via_api(
             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}")
+        logger.info(f"Preflight: {pre_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"Preflight rejected the simulation: {pre_description} "
                 f"(no upload was attempted). "
                 f"Suggested adjustments: {pre.get('suggestedAdjustments') or '(none)'}"
             )
         if status == "warning":
-            logger.warning(f"Preflight warning: {description}")
+            logger.warning(f"Preflight warning: {pre_description}")
 
     # 6. Create or reuse project/version
     auto_create = not project_id or not version_id
     if auto_create:
         logger.info("Creating project...")
         project_result = client.create_project(
-            name=f"{description} - Wavesim Python API",
+            name=description,
             app="wavesim",
             description=f"Multi-source simulation ({len(sources_info)} source(s))",
         )
@@ -543,34 +567,105 @@ def execute_via_api(
 
     logger.info(f"  Simulation completed in {total_time:.1f} seconds!")
 
-    # 14. Download output field
+    # 14. Download results
     logger.info("Downloading results...")
     server_info = client.get_server_info()
     use_machine_service = server_info["uses_machine_service"]
 
-    output_file_id = None
-
+    # Collect this command's result files as (filename, file_id) pairs from
+    # whichever store holds them (machine service vs cloud blob storage).
+    result_files = []
     if use_machine_service:
-        files = client.list_command_files(command_id)
-        logger.info(f"  Found {len(files)} files from machine service")
-        for f in files:
-            fname = f.get("fileName") or f.get("originalFileName", "")
-            if fname.lower() == "output.bin":
-                output_file_id = f.get("blobName")
-                break
+        for f in client.list_command_files(command_id):
+            name = f.get("fileName") or f.get("originalFileName") or ""
+            fid = f.get("blobName")
+            if name and fid:
+                result_files.append((name, fid))
+        logger.info(f"  Found {len(result_files)} files from machine service")
     else:
         version_info = client.get_project_version(project_id, version_id)
-        output_file_ids = version_info.get("outputFileIds", [])
-        logger.info(f"  Found {len(output_file_ids)} output file IDs from cloud storage")
-        for fid in output_file_ids:
+        for fid in version_info.get("outputFileIds", []):
+            name = ""
             try:
                 preview = client.get_file_preview(project_id, version_id, fid)
-                fname = preview.get("fileName") or preview.get("originalFileName", "")
-                if fname.lower() == "output.bin":
-                    output_file_id = fid  # Use the original ID from outputFileIds
-                    break
+                name = preview.get("fileName") or preview.get("originalFileName") or ""
             except Exception:
-                continue
+                pass
+            result_files.append((name, fid))
+        logger.info(f"  Found {len(result_files)} output file IDs from cloud storage")
+
+    # ----- Monitor runs --------------------------------------------------------
+    # When monitors are defined, the server crops each monitor's sub-cube out of
+    # output.bin and uploads only the monitor_<name>.bin files — the full output.bin
+    # is intentionally NOT uploaded (it can be many GB; see RayfosMachineService
+    # CommandManager). So we must NOT require output.bin here. Just like the output.bin
+    # path, we stream each file to a temp dir, read it into numpy, and clean up; the
+    # return value is a LIST of monitor fields in the SAME ORDER as the `monitors`
+    # argument (disabled monitors skipped).
+    if monitors:
+        by_name = {n.lower(): fid for (n, fid) in result_files if n}
+
+        # (monitor name, expected filename) for each enabled monitor, in definition order.
+        ordered = [
+            (m.get("Name", ""), _monitor_output_filename(m.get("Name", "")))
+            for m in monitors if m.get("IsEnabled", True)
+        ]
+        have_exact = any(fn.lower() in by_name for _, fn in ordered)
+
+        # Download list as (display_name, file_id). Exact matches preserve definition
+        # order; the fallback (name-sanitisation mismatch) returns every monitor_*.bin
+        # the server produced, in the order the store listed them.
+        if have_exact:
+            to_fetch = []
+            for mname, fname in ordered:
+                fid = by_name.get(fname.lower())
+                if fid is None:
+                    logger.warning(f"Monitor '{mname}': expected file {fname} not found on server; skipping.")
+                    continue
+                to_fetch.append((fname, fid))
+        else:
+            to_fetch = [
+                (n, fid) for (n, fid) in result_files
+                if n.lower().startswith("monitor_") and n.lower().endswith(".bin")
+            ]
+            if to_fetch:
+                logger.warning("No exact monitor filename match; returning all monitor_*.bin files in server order.")
+
+        if not to_fetch:
+            available = ", ".join(n for n, _ in result_files) or "(none)"
+            raise RuntimeError(
+                "No monitor output files found for this command. Available files: " + available
+            )
+
+        tmp_dir = tempfile.mkdtemp(prefix="wavesimpro_mon_")
+        try:
+            monitor_fields = []
+            for name, fid in to_fetch:
+                dest = Path(tmp_dir) / name
+                logger.info(f"  Downloading monitor file: {name}")
+                client.download_file(project_id, version_id, fid, str(dest), command_id=command_id)
+                # Monitor files carry a self-describing V2 header, so dims come from the file.
+                fld = read_binary_field(dest, None, "Complex64")
+                # Squeeze trailing size-1 dims, same convention as output.bin.
+                while fld.ndim > 1 and fld.shape[-1] == 1:
+                    fld = fld[..., 0]
+                monitor_fields.append(fld)
+                logger.info(f"    -> {fld.shape}")
+        finally:
+            shutil.rmtree(tmp_dir, ignore_errors=True)
+
+        converged = status_str == "Completed"
+        logger.info("=" * 60)
+        logger.info(f"Simulation completed successfully! Returning {len(monitor_fields)} monitor field(s).")
+        logger.info("=" * 60)
+        return monitor_fields, converged
+
+    # ----- Plain runs (no monitors): require output.bin ------------------------
+    output_file_id = None
+    for name, fid in result_files:
+        if name.lower() == "output.bin":
+            output_file_id = fid
+            break
 
     if not output_file_id:
         raise RuntimeError("output.bin not found in command files")

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/src/wavesimpro/json_helper.py

@@ -3,8 +3,6 @@ Helper functions to build WavesimProperties JSON structure
 
 This module provides Python functions to build the correct JSON structure
 that matches RayfosCommandModels.WavesimProperties C# class.
-
-Ported from examples/wavesim_json_helper.py with fixes for MATLAB API parity.
 """
 
 import json

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/src/wavesimpro/simulate.py

@@ -125,7 +125,8 @@ def simulate(
         4. RAYFOS_API_KEY / RAYFOS_API_URL environment variables
 
     Returns:
-        u: np.ndarray, output field (same shape as wavesim.simulate()).
+        u: output field. WITHOUT monitors — np.ndarray (same shape as wavesim.simulate()).
+           WITH monitors — a list of monitor field arrays in the same order as `monitors`.
         iterations: int or None, last reported iteration count.
         residual_norm: float or None, last reported residual norm.
     """

{wavesimpro-1.0.0 → wavesimpro-1.0.2}/src/wavesimpro.egg-info/PKG-INFO

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