Create Tutorials for Use - Githubissues

IanFooMZ / SonyBayerFilter

Other

1 stars 0 forks source link

Create Tutorials for Use #35

Open Tyronitar opened 1 month ago

Tyronitar commented 1 month ago

A Jupyter notebook seems great for this

Tyronitar commented 1 week ago

Ideas for tutorials I had:

Creating Simulation from Scratch

Can use the Config class to demonstrate it's usefulness

Can also use Jinja2 code to show how you can template stuff

Show that the save files can work with Lumerical

Will need to demonstrate the FDTD class as well
[!] MUST HAVE AN IMPORT OBJECT TO WORK WITH OPTIMIZATION!!!

Creating a Device

Mini sub-tutorial on Filters

All the different parameters for the design region

And differences in initialization

Defining a New FoM

Defining your FoM and Gradient function

Creating a FoM

Setting up monitors and sources based on a simulation

Creating and Managing Projects

Full tutorial of project.py and how to save and load previous optimizations