The README is clear but too short for this kind of package. Right now it gives the purpose, a quick start, and high-level outputs.
Before a real alpha release, add:
A “units and conventions” section: microns, Hz, C_0, field normalization, sign convention, propagation direction, and what k_eff means.
A “platform/install” section: wheels, source-build dependencies, unsupported platforms, and troubleshooting.
A minimal validation example: slab or strip waveguide with expected n_eff.
A “known limitations” section: current tensor/PML/bend/angle validation status, unsupported fixture categories, and accuracy expectations.
The README is clear but too short for this kind of package. Right now it gives the purpose, a quick start, and high-level outputs.
Before a real alpha release, add:
A “units and conventions” section: microns, Hz, C_0, field normalization, sign convention, propagation direction, and what k_eff means.
A “platform/install” section: wheels, source-build dependencies, unsupported platforms, and troubleshooting.
A minimal validation example: slab or strip waveguide with expected n_eff.
A “known limitations” section: current tensor/PML/bend/angle validation status, unsupported fixture categories, and accuracy expectations.