Metadata-Version: 2.4
Name: vectorwaves
Version: 1.0.0
Summary: Three-dimensional electromagnetic field simulation and topology analysis
Author: Mayank Soni
License: MIT License
        
        Copyright (c) 2026 Mayank Soni
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/1Rayokelvin/VectorWaves
Project-URL: Repository, https://github.com/1Rayokelvin/VectorWaves
Project-URL: Issues, https://github.com/1Rayokelvin/VectorWaves/issues
Project-URL: Documentation, https://1rayokelvin.github.io/VectorWaves
Keywords: physics,optics,wave-optics,vector-optics,electromagnetism,electromagnetic-fields,structured-light,gaussian-beams,laguerre-gaussian,plane-wave-expansion,computational-physics,optical-singularities,polarization-singularities,phase-singularities,topological-optics,optical-vortices
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24.0
Requires-Dist: scipy>=1.10.0
Requires-Dist: numba>=0.59.0
Provides-Extra: viz
Requires-Dist: matplotlib>=3.7.0; extra == "viz"
Requires-Dist: pyvista>=0.40.0; extra == "viz"
Provides-Extra: progress
Requires-Dist: tqdm>=4.65.0; extra == "progress"
Provides-Extra: gpu
Requires-Dist: cupy-cuda12x>=12.0.0; extra == "gpu"
Provides-Extra: all
Requires-Dist: matplotlib>=3.7.0; extra == "all"
Requires-Dist: pyvista>=0.40.0; extra == "all"
Requires-Dist: tqdm>=4.65.0; extra == "all"
Requires-Dist: cupy-cuda12x>=12.0.0; extra == "all"
Dynamic: license-file

VectorWaves provides a framework for generating, computing, and analyzing fully three-dimensional electromagnetic fields and their topology through discrete plane-wave expansions.

## Installation

```bash
pip install vectorwaves
```

For additional features, you can install the optional dependencies:

| Extra | Purpose |
|---------|---------|
| `viz` | Matplotlib and PyVista for visualizations |
| `progress` | Progress bars via tqdm |
| `gpu` | CUDA acceleration via CuPy |
| `all` | All the above |

To install, 
```bash
pip install vectorwaves[extra]
```

## Features

- Physics-oriented configuration system with `numpy`, `numba`, and CuPy (GPU) backends.
- Exact non-paraxial 3D propagation via Fibonacci-sphere discrete plane-wave expansions.
- Monochromatic and polychromatic sources with arbitrary envelopes, structured light support.
- Stochastic process generation for speckle-like fields.
- Fully analytic computation of E-fields, B-fields, spatial derivatives.
- Topological polarization analysis: C, Cᵀ, and Lᵀ point finding with 3D line tracing.
  
## Quick Example

```python
import vectorwaves as vw

# Generate a tightly-focused Laguerre-Gaussian beam
config = vw.get_config()
config.source.k_space.laguerre_gauss(p=1, l=2, sigma_k_perp=1)
config.source.randomize.off()

# Construct the beam and visualize its plane-wave modes
beam = vw.setup_beam(config)

# Requires matplotlib, install with  'viz' extra: pip install vectorwaves[viz]
beam.plot_kspace_3d(plot_type='colored_vectors')
```

![LG beam k-space](https://github.com/1Rayokelvin/VectorWaves/blob/main/docs/images/LG_kspace.png?raw=true)

For tutorials and examples, please refer to the [official documentation](https://1rayokelvin.github.io/VectorWaves). Source code is available on [GitHub](https://github.com/1Rayokelvin/VectorWaves/).
