wavesimpro 1.10.2__tar.gz → 1.16.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavesimpro
-Version: 1.10.2
+Version: 1.16.0
 Summary: WavesimPro Python API — cloud execution client for the Rayfos simulation platform
 Author: Rayfos
 Project-URL: Repository, https://github.com/rayfos/wavesimpro
@@ -50,7 +50,8 @@ props = wp.create_wavesim_properties(
     domain=wp.create_simulation_domain(20, 20, 20),
     mediums=[wp.create_medium("Silicon", 3.48, 0.0)],
     primitives=[wp.create_box_primitive("core", 0, 0, 0, 10, 0.5, 20, medium="Silicon")],
-    sources=[wp.create_mode_source("in", 0, 0, -8.0, polarization="X")],
+    # TE0 solved by the engine on the z = -6 um voxel layer (index 40 of 200), launched along +z
+    sources=[wp.create_mode_source("in", 0, 0, -6.0, axis="z", plane_index=40, polarization="TE")],
     monitors=[wp.create_monitor("out", 0, 0, 8.0, 10, 10, 0)],
 )
 run = wp.simulate(props, name="strip waveguide")

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

@@ -1,54 +1,55 @@
-# wavesimpro
-
-Python client for the Rayfos Wavesim cloud: build a simulation setup, run it on a Rayfos
-compute node, and read the results back as NumPy arrays.
-
-Wavesim is a single-wavelength frequency-domain solver (vectorial Maxwell when a polarized
-source is present, scalar Helmholtz otherwise). This package talks to the Rayfos JobServer
-REST API; it does not contain the solver.
-
-## Install
-
-```bash
-pip install wavesimpro
-python -m wavesimpro setup      # one-time: API key + server URL wizard
-```
-
-The wizard stores the credentials; `wavesimpro.configure(api_key=..., api_url=...)` sets
-them for one process instead.
-
-## Quick start
-
-```python
-import wavesimpro as wp
-
-props = wp.create_wavesim_properties(
-    wavelength=1.0, pixel_size=0.1, boundary_width=5.0,
-    domain=wp.create_simulation_domain(20, 20, 20),
-    mediums=[wp.create_medium("Silicon", 3.48, 0.0)],
-    primitives=[wp.create_box_primitive("core", 0, 0, 0, 10, 0.5, 20, medium="Silicon")],
-    sources=[wp.create_mode_source("in", 0, 0, -8.0, polarization="X")],
-    monitors=[wp.create_monitor("out", 0, 0, 8.0, 10, 10, 0)],
-)
-run = wp.simulate(props, name="strip waveguide")
-field = wp.read_binary_field(run.download("output.bin"))
-```
-
-## What the API covers
-
-- Setup helpers for domains, media, primitives (box, sphere, ellipsoid, cylinder, cone,
-  N-sided prism, STL, GDSII layouts, voxel arrays), sources (point, plane wave, Gaussian beam,
-  custom field, custom-from-file, engine-solved waveguide mode) and monitors:
-  `create_box_primitive`, `create_sphere_primitive`, `create_ellipsoid_primitive`,
-  `create_cylinder_primitive`, `create_cone_primitive`, `create_prism_primitive`,
-  `create_stl_primitive`, `create_gds_primitive` (with `create_gds_layer_config` /
-  `create_gds_structure_override`), `create_voxels_model_primitive`.
-- Per-primitive sub-pixel flag (`subpixel=True/False` on every shape, STL and GDSII helper)
-  to choose which shapes get smoothed interfaces. Off by default: a setup with no averaged
-  shape is voxelised exactly as before 1.10 and runs on every compute node.
-- Per-axis pixel sizes (`pixel_size=[dx, dy, dz]`) and sub-pixel permittivity averaging
-  (`subpixel_factor=`), when the compute node supports them.
-- Preflight memory check and cost estimate before a run.
-- Binary upload/download helpers for permittivity volumes, source fields and monitors.
-
-See `CHANGELOG.md` for what each version added. Issues and feature requests: support@rayfos.com.
+# wavesimpro
+
+Python client for the Rayfos Wavesim cloud: build a simulation setup, run it on a Rayfos
+compute node, and read the results back as NumPy arrays.
+
+Wavesim is a single-wavelength frequency-domain solver (vectorial Maxwell when a polarized
+source is present, scalar Helmholtz otherwise). This package talks to the Rayfos JobServer
+REST API; it does not contain the solver.
+
+## Install
+
+```bash
+pip install wavesimpro
+python -m wavesimpro setup      # one-time: API key + server URL wizard
+```
+
+The wizard stores the credentials; `wavesimpro.configure(api_key=..., api_url=...)` sets
+them for one process instead.
+
+## Quick start
+
+```python
+import wavesimpro as wp
+
+props = wp.create_wavesim_properties(
+    wavelength=1.0, pixel_size=0.1, boundary_width=5.0,
+    domain=wp.create_simulation_domain(20, 20, 20),
+    mediums=[wp.create_medium("Silicon", 3.48, 0.0)],
+    primitives=[wp.create_box_primitive("core", 0, 0, 0, 10, 0.5, 20, medium="Silicon")],
+    # TE0 solved by the engine on the z = -6 um voxel layer (index 40 of 200), launched along +z
+    sources=[wp.create_mode_source("in", 0, 0, -6.0, axis="z", plane_index=40, polarization="TE")],
+    monitors=[wp.create_monitor("out", 0, 0, 8.0, 10, 10, 0)],
+)
+run = wp.simulate(props, name="strip waveguide")
+field = wp.read_binary_field(run.download("output.bin"))
+```
+
+## What the API covers
+
+- Setup helpers for domains, media, primitives (box, sphere, ellipsoid, cylinder, cone,
+  N-sided prism, STL, GDSII layouts, voxel arrays), sources (point, plane wave, Gaussian beam,
+  custom field, custom-from-file, engine-solved waveguide mode) and monitors:
+  `create_box_primitive`, `create_sphere_primitive`, `create_ellipsoid_primitive`,
+  `create_cylinder_primitive`, `create_cone_primitive`, `create_prism_primitive`,
+  `create_stl_primitive`, `create_gds_primitive` (with `create_gds_layer_config` /
+  `create_gds_structure_override`), `create_voxels_model_primitive`.
+- Per-primitive sub-pixel flag (`subpixel=True/False` on every shape, STL and GDSII helper)
+  to choose which shapes get smoothed interfaces. Off by default: a setup with no averaged
+  shape is voxelised exactly as before 1.10 and runs on every compute node.
+- Per-axis pixel sizes (`pixel_size=[dx, dy, dz]`) and sub-pixel permittivity averaging
+  (`subpixel_factor=`), when the compute node supports them.
+- Preflight memory check and cost estimate before a run.
+- Binary upload/download helpers for permittivity volumes, source fields and monitors.
+
+See `CHANGELOG.md` for what each version added. Issues and feature requests: support@rayfos.com.

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

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

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

@@ -29,6 +29,7 @@ from .binary_utils import (
 from .validate import validate_parameters, ParameterValidationError
 from .execute import execute_via_api
 from .simulate import simulate, simulate_pro, configure
+from .studio_mode import solve_studio_mode, add_studio_mode_source, mode_slice
 from .json_helper import (
     create_simulation_domain,
     create_stl_primitive,
@@ -54,7 +55,7 @@ from .json_helper import (
     parse_progress_data,
 )
 
-__version__ = "1.10.2"
+__version__ = "1.16.0"
 __all__ = [
     # Client
     "RayfosClient",