Skip to content

Commit a2facd0

Browse files
committed
add badge and close #1
1 parent c439c45 commit a2facd0

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# PyMWM
2+
3+
[![PyPI version][pypi-image]][pypi-link]
4+
[![Anaconda Version][anaconda-v-image]][anaconda-v-link]
5+
6+
[pypi-image]: https://badge.fury.io/py/pymwm.svg
7+
[pypi-link]: https://pypi.org/project/pymwm
8+
[anaconda-v-image]: https://anaconda.org/mnishida/pymwm/badges/version.svg
9+
[anaconda-v-link]: https://anaconda.org/mnishida/pymwm
10+
211
PyMWM is a metallic waveguide mode solver written in Python.
312

413
It provides the dispersion relation, i.e. the relation between propagation constant β = α + iγ (with phase constant α and attenuation constant γ) and angular frequency ω, for cylindrical waveguide and planer waveguide (slits). It also provides the distribution of mode fields. Codes for coaxial waveguides are under development.
@@ -70,7 +79,7 @@ You can check the obtained waveguide modes in the specified range by showing the
7079
('E', 4, 1),
7180
('M', 1, 1)]}
7281
```
73-
where 'h' ('v') means that the modes have horizontally (vertically) oriented electric fields on the $x$ axis. The tuple (pol, n, m) with pol being 'E' or 'M' indicates TE-like or TM-like mode indexed by n and m.
82+
where 'h' ('v') means that the modes have horizontally (vertically) oriented electric fields on the x axis. The tuple (pol, n, m) with pol being 'E' or 'M' indicates TE-like or TM-like mode indexed by n and m.
7483
You can get β at ω=8.0 rad/μm for TM-like mode with n=0 and m=1 by
7584
```
7685
>>> wg.beta(8.0, ('M', 0, 1))

0 commit comments

Comments
 (0)