Metadata-Version: 2.1
Name: SPLayout
Version: 0.4.9
Summary: Silicon Photonics Design Tools for GDSII Files.
Home-page: https://github.com/Hideousmon/SPLayout
Author: Zhenyu ZHAO
Author-email: mailtozyzhao@163.com
License-File: LICENSE
Requires-Dist: gdspy
Requires-Dist: numpy
Requires-Dist: scipy

SPLayout
========

|GitHub repository| |GitHub license|

SPLayout (**S**\ilicon **P**\hotonics **Layout** Design Tools) is a package for silicon photonics structures design. It provides commonly used silicon photonics structure classes for fast integration and pixelized blocks for inverse design and optimization. Some inverse design algorithms are also integrated in it like DBS (Direct Binary Search) and BBA (Binary Bat Algorithm).

The GDSII streaming is based on gdspy(https://github.com/heitzmann/gdspy) and FDTD simulation is executed on Ansys Lumerical.


Dependency
----------

-  Python 3.6+
-  gdspy
-  scipy
-  numpy
-  (Ansys Lumerical for FDTDSimulation and MODESimulation)

Installation
------------

use pip:

::

    pip install splayout

or download from the source and build/install with:

::

    python setup.py install

Documentation
-------------

The documentation can be found
`here <https://splayout.readthedocs.io/en/latest/>`__.


`History (Click Here) <https://github.com/Hideousmon/SPLayout/tree/main/history.md>`__
-------------------------------------------------------------------------------------------


.. |GitHub repository| image:: https://img.shields.io/badge/github-SPLayout-blue
   :target: https://github.com/Hideousmon/SPLayout
.. |GitHub license| image:: https://img.shields.io/badge/lisence-GNU--3.0-green
   :target: https://github.com/Hideousmon/SPLayout/blob/main/LICENSE

