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")],
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(withcreate_gds_layer_config/create_gds_structure_override),create_voxels_model_primitive. - Per-primitive sub-pixel flag (
subpixel=True/Falseon 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.
1 maintainer
Metadata
1 maintainer
Release files for wavesimpro 1.10.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| wavesimpro-1.10.2.tar.gz | 80.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wavesimpro-1.10.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 165.1 kB
Release files / wavesimpro-1.10.2.tar.gz
| Download URL | wavesimpro-1.10.2.tar.gz |
|---|---|
| Size | 80.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a693b8f507d6015cc1544756477a7bfec6aac4884c0a8ac59559914f9eb777ad
|
|
BLAKE2b-256 checksum How to use checksums |
b1f8d679bcf4fe2b99abf288654f96cc5ce0947cb00025619c05465f12be0d12
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RayfosJobServer-PypiPublish/1.0
|
Release files / wavesimpro-1.10.2-py3-none-any.whl
| Download URL | wavesimpro-1.10.2-py3-none-any.whl |
|---|---|
| Size | 84.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c7f3c4b504b6e83f0e56c41afc667dfa1a9456012aecbe3faab201e277c6cf4e
|
|
BLAKE2b-256 checksum How to use checksums |
8940ac8990178aa8f083d7d6f20321d267132e9c7c7b2c1a1d3f56b11e1d4df2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RayfosJobServer-PypiPublish/1.0
|
Security for wavesimpro 1.10.2
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.
