Skip to content

Commit 7c86a35

Browse files
authored
Update README.md
1 parent 887b976 commit 7c86a35

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
11
# awg-matlab
2-
AWG model with Matlab
2+
Start with the examples in `examples/` directory.
3+
4+
## Important notes
5+
* All lengths are [µm] and frequencies are [THz] by default. This means, for example, that 1550nm wavelength will be written 1.55 and 193.5THz is simply 193.5.
6+
7+
* The model currently only handles strip waveguides with constant 220nm height, widths may vary from 350nm to 2µm, freespace wavelength must be within 1.4 to 1.6µm, core material is Silicon.
8+
9+
* Spot size gaussian approximation is used by default to calculate strip waveguide profiles. It is possible to use real modes by including the option `‘RealModes’, true` in the transfer function script inputs (see example 2).
10+
11+
* When running example scripts, make sure the active directory is the root AWG model directory and not the examples directory.

0 commit comments

Comments
 (0)