wavesimpro 1.16.0__tar.gz → 1.17.1__tar.gz

{wavesimpro-1.16.0 → wavesimpro-1.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavesimpro
-Version: 1.16.0
+Version: 1.17.1
 Summary: WavesimPro Python API — cloud execution client for the Rayfos simulation platform
 Author: Rayfos
 Project-URL: Repository, https://github.com/rayfos/wavesimpro
@@ -75,4 +75,38 @@ field = wp.read_binary_field(run.download("output.bin"))
 - Preflight memory check and cost estimate before a run.
 - Binary upload/download helpers for permittivity volumes, source fields and monitors.
 
+## Monitors: which voxels you get
+
+A monitor is an axis-aligned box in micrometres, relative to the coordinate-system centre. The
+domain of N voxels spans [-S/2, S/2], so voxel *i* occupies [-S/2 + i·v, -S/2 + (i+1)·v] with
+v = S/N (centre at -S/2 + (i+0.5)·v, for even and odd N alike). The compute node extracts the
+**outer cover** of the box: every voxel it touches — first index floor(lo), last index
+ceil(hi) − 1 with lo/hi the box edges in voxel units. An edge exactly on a voxel face does not
+pull in the neighbour; a zero-thickness box is the one voxel containing the plane. So a box of
+exactly k voxels aligned to the grid gives k planes, and the same box centred on a voxel centre
+straddles k + 1; the result is never smaller than what you asked for unless the domain clamps it.
+
+The node writes `monitors.json` next to the `monitor_<name>.bin` files with, per monitor, the
+inclusive index ranges, the shape, the voxel size and the realised physical box; read it with
+`run.monitor_regions()`. Monitor files are full resolution — nothing is downsampled on download.
+
+## Cost before upload
+
+`client.preflight_check(..., max_iterations=n)` (called for you by `simulate*`, `submit` and
+`execute_via_api`) returns a `cost` block on the cloud server: the upper-bound compute-token
+cost at the run's iteration cap (voxels × iterations × field components × rate), your remaining
+balance and whether the submit would be allowed. The run is charged for the iterations it
+actually takes. The high-level calls stop before uploading anything when the cost is refused.
+`client.get_quota()` returns the balance; `client.estimate_cost(project_id, version_id)` prices a
+saved version.
+
+## Errors and warnings
+
+Every `RayfosAPIError` message carries the server's full detail: the message, each
+`errors[]`/`warnings[]` entry and, for a quota refusal, the estimated cost and remaining balance.
+Pass `sampling_warnings=False` (or `configure(sampling_warnings=False)`) to silence the
+"pixels per wavelength" advisory when your sampling is deliberate; Nyquist warnings stay.
+`run.status()["commandStatus"]["engine"]` names the engine the node actually ran (`"Cpp"` or
+`"Python"`), also for `engine="Any"`.
+
 See `CHANGELOG.md` for what each version added. Issues and feature requests: support@rayfos.com.

{wavesimpro-1.16.0 → wavesimpro-1.17.1}/README.md

@@ -52,4 +52,38 @@ field = wp.read_binary_field(run.download("output.bin"))
 - Preflight memory check and cost estimate before a run.
 - Binary upload/download helpers for permittivity volumes, source fields and monitors.
 
+## Monitors: which voxels you get
+
+A monitor is an axis-aligned box in micrometres, relative to the coordinate-system centre. The
+domain of N voxels spans [-S/2, S/2], so voxel *i* occupies [-S/2 + i·v, -S/2 + (i+1)·v] with
+v = S/N (centre at -S/2 + (i+0.5)·v, for even and odd N alike). The compute node extracts the
+**outer cover** of the box: every voxel it touches — first index floor(lo), last index
+ceil(hi) − 1 with lo/hi the box edges in voxel units. An edge exactly on a voxel face does not
+pull in the neighbour; a zero-thickness box is the one voxel containing the plane. So a box of
+exactly k voxels aligned to the grid gives k planes, and the same box centred on a voxel centre
+straddles k + 1; the result is never smaller than what you asked for unless the domain clamps it.
+
+The node writes `monitors.json` next to the `monitor_<name>.bin` files with, per monitor, the
+inclusive index ranges, the shape, the voxel size and the realised physical box; read it with
+`run.monitor_regions()`. Monitor files are full resolution — nothing is downsampled on download.
+
+## Cost before upload
+
+`client.preflight_check(..., max_iterations=n)` (called for you by `simulate*`, `submit` and
+`execute_via_api`) returns a `cost` block on the cloud server: the upper-bound compute-token
+cost at the run's iteration cap (voxels × iterations × field components × rate), your remaining
+balance and whether the submit would be allowed. The run is charged for the iterations it
+actually takes. The high-level calls stop before uploading anything when the cost is refused.
+`client.get_quota()` returns the balance; `client.estimate_cost(project_id, version_id)` prices a
+saved version.
+
+## Errors and warnings
+
+Every `RayfosAPIError` message carries the server's full detail: the message, each
+`errors[]`/`warnings[]` entry and, for a quota refusal, the estimated cost and remaining balance.
+Pass `sampling_warnings=False` (or `configure(sampling_warnings=False)`) to silence the
+"pixels per wavelength" advisory when your sampling is deliberate; Nyquist warnings stay.
+`run.status()["commandStatus"]["engine"]` names the engine the node actually ran (`"Cpp"` or
+`"Python"`), also for `engine="Any"`.
+
 See `CHANGELOG.md` for what each version added. Issues and feature requests: support@rayfos.com.

{wavesimpro-1.16.0 → wavesimpro-1.17.1}/pyproject.toml

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

{wavesimpro-1.16.0 → wavesimpro-1.17.1}/src/wavesimpro/__init__.py

@@ -55,7 +55,7 @@ from .json_helper import (
     parse_progress_data,
 )
 
-__version__ = "1.16.0"
+__version__ = "1.17.1"
 __all__ = [
     # Client
     "RayfosClient",