structured-optics 0.3__tar.gz → 0.4__tar.gz

structured_optics-0.4/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, <Your Altilano Cristino Barbosa>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

structured_optics-0.4/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: structured_optics
+Version: 0.4
+Summary: Package for Structured Light simulation
+Author: Altilano C. Barbosa
+License-Expression: BSD-3-Clause
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: PyQt6
+Dynamic: license-file
+
+# structured-optics
+
+A Python library for generating, propagating, and analyzing structured light beams
+(Hermite-Gaussian, Laguerre-Gaussian, Bessel, Ince-Gaussian, fiber LP modes, and more)
+on a discretized transverse grid.
+
+[![PyPI version](https://img.shields.io/pypi/v/structured-optics.svg)](https://pypi.org/project/structured-optics/)
+
+[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+## Features
+
+- **Mode generation**: Hermite-Gaussian, Laguerre-Gaussian, Bessel, Gaussian-Bessel,
+  Ince-Gaussian (even/odd/helical), fractional OAM, fiber LP modes, and geometric
+  apertures (circle, square, triangle).
+- **Propagation**: Fresnel, Fraunhofer, and incoherent propagation methods.
+- **Polarization**: vector beams with Ex/Ey/Ez components, Jones-matrix optics
+  (waveplates, polarizers).
+- **Optical elements**: lenses (spherical, astigmatic, tilted), slits, irises,
+  and other amplitude/phase masks.
+- **Analysis**: power, intensity and phase profiles, centroid, beam size (std),
+  angular sections, and modal decomposition (HG/LG/Bessel basis projections).
+- **Holography**: SLM and DMD hologram generation for experimental beam shaping.
+
+## Installation
+
+```bash
+pip install structured-optics
+```
+
+## Quick start
+
+```python
+import structured_optics as so
+
+# Create a beam on a 10mm x 10mm (2*5e-3) grid with 256x256 points
+beam = so.Beam(nix=5e-3, Dx=256, waist=1e-3, lamb=1064e-9)
+
+# Set the field to a Laguerre-Gaussian mode with l=2, p=0
+beam.lg(l=2, p=0)
+
+# Propagate 10 cm and check total power
+beam.propagate(z=0.1, method='fresnel')
+print(beam.Power())
+
+# Look at the intensity profile
+import matplotlib.pyplot as plt
+plt.pcolormesh(beam.x, beam.y, beam.int_profile())
+plt.show()
+```
+
+## Documentation
+
+Full API documentation, including all mode types, propagation methods, and
+optical elements, is available at:
+
+Soon...
+
+## Requirements
+
+- Python 3.9+
+- numpy
+- scipy
+- PyQt6
+
+
+
+## Contributing
+
+Issues and pull requests are welcome at
+[github.com/Altilano/structured-optics](https://github.com/Altilano/structured-optics).
+
+## License
+
+This project is licensed under the BSD-3-Clause License. See `LICENSE` for details.
+
+## Citation
+
+

structured_optics-0.4/README.md

@@ -0,0 +1,79 @@
+# structured-optics
+
+A Python library for generating, propagating, and analyzing structured light beams
+(Hermite-Gaussian, Laguerre-Gaussian, Bessel, Ince-Gaussian, fiber LP modes, and more)
+on a discretized transverse grid.
+
+[![PyPI version](https://img.shields.io/pypi/v/structured-optics.svg)](https://pypi.org/project/structured-optics/)
+
+[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+## Features
+
+- **Mode generation**: Hermite-Gaussian, Laguerre-Gaussian, Bessel, Gaussian-Bessel,
+  Ince-Gaussian (even/odd/helical), fractional OAM, fiber LP modes, and geometric
+  apertures (circle, square, triangle).
+- **Propagation**: Fresnel, Fraunhofer, and incoherent propagation methods.
+- **Polarization**: vector beams with Ex/Ey/Ez components, Jones-matrix optics
+  (waveplates, polarizers).
+- **Optical elements**: lenses (spherical, astigmatic, tilted), slits, irises,
+  and other amplitude/phase masks.
+- **Analysis**: power, intensity and phase profiles, centroid, beam size (std),
+  angular sections, and modal decomposition (HG/LG/Bessel basis projections).
+- **Holography**: SLM and DMD hologram generation for experimental beam shaping.
+
+## Installation
+
+```bash
+pip install structured-optics
+```
+
+## Quick start
+
+```python
+import structured_optics as so
+
+# Create a beam on a 10mm x 10mm (2*5e-3) grid with 256x256 points
+beam = so.Beam(nix=5e-3, Dx=256, waist=1e-3, lamb=1064e-9)
+
+# Set the field to a Laguerre-Gaussian mode with l=2, p=0
+beam.lg(l=2, p=0)
+
+# Propagate 10 cm and check total power
+beam.propagate(z=0.1, method='fresnel')
+print(beam.Power())
+
+# Look at the intensity profile
+import matplotlib.pyplot as plt
+plt.pcolormesh(beam.x, beam.y, beam.int_profile())
+plt.show()
+```
+
+## Documentation
+
+Full API documentation, including all mode types, propagation methods, and
+optical elements, is available at:
+
+Soon...
+
+## Requirements
+
+- Python 3.9+
+- numpy
+- scipy
+- PyQt6
+
+
+
+## Contributing
+
+Issues and pull requests are welcome at
+[github.com/Altilano/structured-optics](https://github.com/Altilano/structured-optics).
+
+## License
+
+This project is licensed under the BSD-3-Clause License. See `LICENSE` for details.
+
+## Citation
+
+

{structured_optics-0.3 → structured_optics-0.4}/pyproject.toml

@@ -4,8 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "structured_optics"
-version = "0.3"
+version = "0.4"
 description = "Package for Structured Light simulation"
+readme = "README.md"
+license = "BSD-3-Clause"
 requires-python = ">=3.9"
 authors = [
     { name = "Altilano C. Barbosa" }