Skip to main content

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

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

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.

Metadata

Release files for wavesimpro 1.16.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wavesimpro 1.16.0
File Size Uploaded Provenance Actions
wavesimpro-1.16.0.tar.gz 89.6 kB Without provenance Details for wavesimpro-1.16.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for wavesimpro 1.16.0
File Interpreter ABI Platform Actions
wavesimpro-1.16.0-py3-none-any.whl Python 3 none any Details for wavesimpro-1.16.0-py3-none-any.whl

Total release size: 180.1 kB

Release files / wavesimpro-1.16.0.tar.gz

Download URL wavesimpro-1.16.0.tar.gz
Size 89.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e92b5d421c0694ea09f4d4677acd662a3c9f3faea43eb1c994eb69f3831cf5b0
BLAKE2b-256 checksum
How to use checksums
657c9edb51814c9e99e550d495b997312e07641969b32e8e2295fe2600afebfe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via RayfosJobServer-PypiPublish/1.0

Release files / wavesimpro-1.16.0-py3-none-any.whl

Download URL wavesimpro-1.16.0-py3-none-any.whl
Size 90.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fa1c4d9fc31f1962b57887ae6894a67b8895274dc31dc2bbe1236535c1d1d429
BLAKE2b-256 checksum
How to use checksums
ebf94ace6763ffac61fd8349a1f9783a1e8f6d8d775fa45d2d7ff325f6d3c029
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via RayfosJobServer-PypiPublish/1.0

Security for wavesimpro 1.16.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.16.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page