gds-fdtd 0.3.0__tar.gz

gds_fdtd-0.3.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, Mustafa Hammood
+
+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.
+

gds_fdtd-0.3.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: gds_fdtd
+Version: 0.3.0
+Summary: A minimalist package for simulating photonics designs.
+Keywords: photonics,fdtd,simulation,gds,silicon-photonics,optics,simulation
+Author-email: Mustafa Hammood <mustafa@siepic.com>
+Description-Content-Type: text/markdown
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Requires-Dist: pip>=23.3
+Requires-Dist: bump2version==0.5.11
+Requires-Dist: wheel>=0.38.1
+Requires-Dist: watchdog==2.3.0
+Requires-Dist: twine==1.14.0
+Requires-Dist: klayout==0.30.1
+Requires-Dist: tidy3d==2.8.0
+Requires-Dist: docutils<0.21
+Requires-Dist: sphinx-rtd-theme>=1.2.0
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: coverage ; extra == "dev"
+Requires-Dist: gdsfactory>=9.5.0 ; extra == "gdsfactory"
+Requires-Dist: prefab==1.2.0 ; extra == "prefab"
+Provides-Extra: dev
+Provides-Extra: gdsfactory
+Provides-Extra: prefab
+
+# gds_fdtd
+
+![alternative text](/docs/banner.png)
+
+![codecov](https://codecov.io/gh/mustafacc/gds_fdtd/branch/main/graph/badge.svg)
+![build](https://github.com/mustafacc/gds_fdtd/actions/workflows/main.yml/badge.svg)
+
+**gds_fdtd** is a minimal Python module to assist in setting up FDTD simulations for planar nanophotonic devices using FDTD solvers such as Tidy3D.
+
+## Features
+
+- **Automated FDTD Setup:** Easily set up Tidy3D simulations for devices designed in GDS.
+- **Integration with gdsfactory:** Generate Tidy3D simulations directly from [gdsfactory](https://github.com/gdsfactory/gdsfactory) designs by identifying ports and simulation regions from an input technology stack.
+- **S-Parameter Extraction:** Automatically generate and export S-parameters of your photonic devices in standard formats.
+- **Multimode/Dual Polarization Simulations:** Set up simulations that support multimode or dual polarization configurations for advanced device analysis.
+
+## Installation
+
+You can install `gds_fdtd` using the following options:
+
+### Option 1: Basic Installation
+
+To install the core functionality of `gds_fdtd`, clone the repository and install using `pip`:
+
+```bash
+git clone git@github.com:mustafacc/gds_fdtd.git
+cd gds_fdtd
+pip install .
+```
+
+### Option 2: Development Installation
+
+For contributing to the development or if you need testing utilities, install with the dev dependencies:
+
+```bash
+git clone git@github.com:mustafacc/gds_fdtd.git
+cd gds_fdtd
+pip install -e .[dev]
+```
+
+This will install additional tools like `pytest` and `coverage` for testing.
+
+### Optional Dependencies
+
+If your workflow includes specific dependencies such as gdsfactory or prefab, you can install those optional extras:
+
+with [gdsfactory](https://github.com/gdsfactory/gdsfactory):
+
+```bash
+pip install -e .[gdsfactory]
+```
+
+Refer to [gdsfactory example](/examples/06_gdsfactory/06a_gf_bend.py) for usage.
+
+with [prefab](https://github.com/PreFab-Photonics/PreFab):
+
+```bash
+pip install -e .[prefab]
+```
+
+Refer to [prefab example](/examples/08_prefab/08a_bragg_prefab.py) for usage.
+
+If you want everything installed for both development and optional features, run the following command:
+
+```bash
+pip install -e .[dev,gdsfactory,prefab]
+```
+
+
+### Running tests
+
+If you've installed the `dev` dependencies, you can run the test suite with:
+
+```bash
+pytest --cov=gds_fdtd tests
+```
+

gds_fdtd-0.3.0/README.md

@@ -0,0 +1,76 @@
+# gds_fdtd
+
+![alternative text](/docs/banner.png)
+
+![codecov](https://codecov.io/gh/mustafacc/gds_fdtd/branch/main/graph/badge.svg)
+![build](https://github.com/mustafacc/gds_fdtd/actions/workflows/main.yml/badge.svg)
+
+**gds_fdtd** is a minimal Python module to assist in setting up FDTD simulations for planar nanophotonic devices using FDTD solvers such as Tidy3D.
+
+## Features
+
+- **Automated FDTD Setup:** Easily set up Tidy3D simulations for devices designed in GDS.
+- **Integration with gdsfactory:** Generate Tidy3D simulations directly from [gdsfactory](https://github.com/gdsfactory/gdsfactory) designs by identifying ports and simulation regions from an input technology stack.
+- **S-Parameter Extraction:** Automatically generate and export S-parameters of your photonic devices in standard formats.
+- **Multimode/Dual Polarization Simulations:** Set up simulations that support multimode or dual polarization configurations for advanced device analysis.
+
+## Installation
+
+You can install `gds_fdtd` using the following options:
+
+### Option 1: Basic Installation
+
+To install the core functionality of `gds_fdtd`, clone the repository and install using `pip`:
+
+```bash
+git clone git@github.com:mustafacc/gds_fdtd.git
+cd gds_fdtd
+pip install .
+```
+
+### Option 2: Development Installation
+
+For contributing to the development or if you need testing utilities, install with the dev dependencies:
+
+```bash
+git clone git@github.com:mustafacc/gds_fdtd.git
+cd gds_fdtd
+pip install -e .[dev]
+```
+
+This will install additional tools like `pytest` and `coverage` for testing.
+
+### Optional Dependencies
+
+If your workflow includes specific dependencies such as gdsfactory or prefab, you can install those optional extras:
+
+with [gdsfactory](https://github.com/gdsfactory/gdsfactory):
+
+```bash
+pip install -e .[gdsfactory]
+```
+
+Refer to [gdsfactory example](/examples/06_gdsfactory/06a_gf_bend.py) for usage.
+
+with [prefab](https://github.com/PreFab-Photonics/PreFab):
+
+```bash
+pip install -e .[prefab]
+```
+
+Refer to [prefab example](/examples/08_prefab/08a_bragg_prefab.py) for usage.
+
+If you want everything installed for both development and optional features, run the following command:
+
+```bash
+pip install -e .[dev,gdsfactory,prefab]
+```
+
+
+### Running tests
+
+If you've installed the `dev` dependencies, you can run the test suite with:
+
+```bash
+pytest --cov=gds_fdtd tests
+```

gds_fdtd-0.3.0/gds_fdtd/__init__.py

@@ -0,0 +1,6 @@
+"""gds_fdtd Top-level package imports."""
+from . import core, lyprocessor, simprocessor
+
+__author__ = """Mustafa Hammood"""
+__email__ = "mustafa@siepic.com"
+__version__ = "0.3.0"