https://github.com/chriskeraly/lumopt

Python based continuous adjoint optimization wrapper for Lumerical
https://github.com/chriskeraly/lumopt

Last synced: about 2 months ago
JSON representation

Python based continuous adjoint optimization wrapper for Lumerical

• Host: GitHub
• URL: https://github.com/chriskeraly/lumopt
• Owner: chriskeraly
• License: other
• Created: 2018-04-01T13:34:25.000Z (almost 7 years ago)
• Default Branch: release
• Last Pushed: 2024-03-20T00:35:04.000Z (10 months ago)
• Last Synced: 2024-08-03T03:06:31.529Z (5 months ago)
• Language: Python
• Homepage:
• Size: 6.21 MB
• Stars: 154
• Watchers: 18
• Forks: 77
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_photonics - lumopt

README

        
# Continuous adjoint optimization wrapper for Lumerical

## Introduction

This is a continuous adjoint opimtization wrapper for Lumerical, using Python as the main user interface. It is released under an MIT license. It is still work in progress 

and any contribution will be very welcome! New features to come out soon, and make it even easier to use (hopefully)!

If you use this tool in any published work, please cite https://www.osapublishing.org/oe/abstract.cfm?uri=oe-21-18-21693 and give a link to this repo. Thanks!

## Tutorials, Examples, and Documentation

It is all here: https://lumopt.readthedocs.io/en/latest/

## Install

Make sure you have Python 3 and the latest version of Lumerical installed (it won't work correctly with older versions), and that lumapi (the python api) works.

```bash

cd your/install/folder/

git clone https://github.com/chriskeraly/LumOpt.git

python setup.py develop

```

I would strongly recommend using jupyter notebooks to run optimizations.

## First optimization

If you are not using jupyter notebooks:

```bash

cd your/install/folder/examples/Ysplitter

python splitter_opt_2D.py

```

Otherwise copy `your/install/folder/examples/Ysplitter/splitter_opt_2D.py` into a notebook