solwa 0.1.0__tar.gz

solwa-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+Original TORCWA: GPU-accelerated rigorous coupled-wave analysis with automatic differentiation
+Copyright (C) 2022 Changhyun Kim
+
+SOLWA:
+Copyright (C) 2025 Johannes Zeiser
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of the 
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.

solwa-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: solwa
+Version: 0.1.0
+Summary: Differentiable RCWA in PyTorch, based on TORCWA
+Author: Johannes Zeiser
+License: LGPL-3.0-or-later
+Project-URL: Repository, https://github.com/johannesz-codes/solwa
+Project-URL: Issues, https://github.com/johannesz-codes/solwa/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0
+Requires-Dist: numpy
+Requires-Dist: scipy
+Dynamic: license-file
+
+**solwa-0.1.0**
+======
+
+* License: LGPL
+
+Differentiable Rigorous Coupled-Wave Analysis (RCWA) package based on PyTorch
+
+<br/>
+
+Features
+--------
+**solwa** (**solar** + **rcwa**) is a PyTorch implementation of rigorous coupled-wave analysis (RCWA) based on **torcwa** https://github.com/kch3782/torcwa
+
+* **GPU-accelerated** simulation
+
+* Supporting **automatic differentiation** for optimization
+
+* Units: Lorentz-Heaviside units
+
+	* Speed of light: 1
+
+	* Permittivity and permeability of vacuum: both 1
+
+* Notation: exp(-*jωt*)
+
+<br/>
+
+Installation
+------------
+currently only installation from source is supported
+
+PyTorch ≥ 2.10 is recommended for improved CUDA performance
+(see PR: https://github.com/pytorch/pytorch/pull/166715)
+
+<br/>
+
+significant changes from the original torcwa
+------------
+1. Constants are loaded from standard libraries instead of defining them again in the code.
+2. Major cleanup of the code structure for better readability and maintainability.
+3. Better error handling and messages.
+4. Addition of functions for calculation of the poynting vector and power flux.
+
+
+<br/>
+
+**solwa** Examples
+---------------
+1. [Example 0](./example/Example0.ipynb): Fresnel equation
+
+2. [Example 1](./example/Example1.ipynb): Simulation with rectangular meta-atom  
+Normal incidence / Parametric sweep on wavelength / View electromagnetic field
+
+3. [Example 1-1](./example/Example1-1.ipynb): Simulation with stacked meta-atom  
+Normal incidence / View electromagnetic field
+
+4. [Example 2](./example/Example2.ipynb): Simulation with square meta-atom  
+Oblique incidence / View electromagnetic field
+
+5. [Example 3](./example/Example3.ipynb): Simulation with rectangular meta-atom  
+Normal incidence / Parametric sweep on geometric parameters
+
+6. [Example 4](./example/Example4.ipynb): Gradient calculation of cylindrical meta-atom  
+Differentiation of transmittance with respect to radius
+
+7. [Example 5](./example/Example5.ipynb): Shape optimization  
+Maximize anisotropy
+
+8. [Example 6](./example/Example6.ipynb): Topology optimization  
+Maximize 1st order diffraction
+
+<br/>
+
+Acknowledgements
+----------------
+The fundamental implementation, including mathematical formulation, was implemented in the **torcwa** package 
+by Changhyun Kim and Byoungho Lee.
+
+This **solwa** package is a modified version of **torcwa** for better usability.
+It will be continuously updated to include more features and improvements.
+
+If this package is useful for your research, please cite the following paper:
+```
+@article{
+	title = {TORCWA: GPU-accelerated Fourier modal method and gradient-based optimization for metasurface design},
+	journal = {Computer Physics Communications},
+	volume = {282},
+	pages = {108552},
+	year = {2023},
+	doi = {https://doi.org/10.1016/j.cpc.2022.108552},
+	author = {Changhyun Kim and Byoungho Lee},
+}
+```
+
+Work on the **solwa** package is supported by the ERC Consolidator Grant (No. 101125948, PHASE).
+
+Furthermore, the authors acknowledge support by the state of Baden-Württemberg through bwHPC
+through providing computational resources.
+
+
+
+The work on the original **torcwa** was supported by the National Research Foundation of Korea (NRF) grant funded by the Korea government (MSIT) (No. 2020R1A2B5B02002730) and Samsung Electronics Co., Ltd (IO201214-08164-01).

solwa-0.1.0/README.md

@@ -0,0 +1,102 @@
+**solwa-0.1.0**
+======
+
+* License: LGPL
+
+Differentiable Rigorous Coupled-Wave Analysis (RCWA) package based on PyTorch
+
+<br/>
+
+Features
+--------
+**solwa** (**solar** + **rcwa**) is a PyTorch implementation of rigorous coupled-wave analysis (RCWA) based on **torcwa** https://github.com/kch3782/torcwa
+
+* **GPU-accelerated** simulation
+
+* Supporting **automatic differentiation** for optimization
+
+* Units: Lorentz-Heaviside units
+
+	* Speed of light: 1
+
+	* Permittivity and permeability of vacuum: both 1
+
+* Notation: exp(-*jωt*)
+
+<br/>
+
+Installation
+------------
+currently only installation from source is supported
+
+PyTorch ≥ 2.10 is recommended for improved CUDA performance
+(see PR: https://github.com/pytorch/pytorch/pull/166715)
+
+<br/>
+
+significant changes from the original torcwa
+------------
+1. Constants are loaded from standard libraries instead of defining them again in the code.
+2. Major cleanup of the code structure for better readability and maintainability.
+3. Better error handling and messages.
+4. Addition of functions for calculation of the poynting vector and power flux.
+
+
+<br/>
+
+**solwa** Examples
+---------------
+1. [Example 0](./example/Example0.ipynb): Fresnel equation
+
+2. [Example 1](./example/Example1.ipynb): Simulation with rectangular meta-atom  
+Normal incidence / Parametric sweep on wavelength / View electromagnetic field
+
+3. [Example 1-1](./example/Example1-1.ipynb): Simulation with stacked meta-atom  
+Normal incidence / View electromagnetic field
+
+4. [Example 2](./example/Example2.ipynb): Simulation with square meta-atom  
+Oblique incidence / View electromagnetic field
+
+5. [Example 3](./example/Example3.ipynb): Simulation with rectangular meta-atom  
+Normal incidence / Parametric sweep on geometric parameters
+
+6. [Example 4](./example/Example4.ipynb): Gradient calculation of cylindrical meta-atom  
+Differentiation of transmittance with respect to radius
+
+7. [Example 5](./example/Example5.ipynb): Shape optimization  
+Maximize anisotropy
+
+8. [Example 6](./example/Example6.ipynb): Topology optimization  
+Maximize 1st order diffraction
+
+<br/>
+
+Acknowledgements
+----------------
+The fundamental implementation, including mathematical formulation, was implemented in the **torcwa** package 
+by Changhyun Kim and Byoungho Lee.
+
+This **solwa** package is a modified version of **torcwa** for better usability.
+It will be continuously updated to include more features and improvements.
+
+If this package is useful for your research, please cite the following paper:
+```
+@article{
+	title = {TORCWA: GPU-accelerated Fourier modal method and gradient-based optimization for metasurface design},
+	journal = {Computer Physics Communications},
+	volume = {282},
+	pages = {108552},
+	year = {2023},
+	doi = {https://doi.org/10.1016/j.cpc.2022.108552},
+	author = {Changhyun Kim and Byoungho Lee},
+}
+```
+
+Work on the **solwa** package is supported by the ERC Consolidator Grant (No. 101125948, PHASE).
+
+Furthermore, the authors acknowledge support by the state of Baden-Württemberg through bwHPC
+through providing computational resources.
+
+
+
+The work on the original **torcwa** was supported by the National Research Foundation of Korea (NRF) grant funded by the Korea government (MSIT) (No. 2020R1A2B5B02002730) and Samsung Electronics Co., Ltd (IO201214-08164-01).

solwa-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "solwa"
+version = "0.1.0"
+description = "Differentiable RCWA in PyTorch, based on TORCWA"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "LGPL-3.0-or-later" }
+authors = [{ name = "Johannes Zeiser" }]
+dependencies = [
+  "torch>=2.0",
+  "numpy",
+  "scipy",
+]
+
+[project.urls]
+Repository = "https://github.com/johannesz-codes/solwa"
+Issues = "https://github.com/johannesz-codes/solwa/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["solwa*"]

solwa-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

solwa-0.1.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

solwa-0.1.0/src/solwa/__init__.py

@@ -0,0 +1,23 @@
+"""
+SOLWA: PyTorch-based Rigorous Coupled-Wave Analysis.
+
+GPU-accelerated Fourier Modal Method with automatic differentiation support
+for metasurface design and optimization.
+
+This package provides:
+- RCWA simulation (rcwa class)
+- Geometry generation utilities (geometry, rcwa_geo)
+- Material property management (materials)
+- Stable eigendecomposition (Eig)
+
+Uses Lorentz-Heaviside units with speed of light = 1 and
+time harmonics notation exp(-jωt).
+"""
+
+from .torch_eig import Eig as Eig
+from .geometry import geometry as geometry, rcwa_geo as rcwa_geo
+from .rcwa import rcwa as rcwa
+from . import materials as materials
+
+__author__ = """Johannes Zeiser"""
+__version__ = "0.1.0"