openEMS/python/doc/openEMS.rst
Thorsten Liebig 1ebb7932c1 python: add documentation
Signed-off-by: Thorsten Liebig <Thorsten.Liebig@gmx.de>
2016-09-08 22:10:27 +02:00

60 lines
948 B
ReStructuredText

openEMS Python Interface
========================
openEMS
-------
.. automodule:: openEMS.openEMS
:members: openEMS
:undoc-members:
Ports
-----
.. automodule:: openEMS.ports
Port (Base Class)
-----------------
.. autoclass:: Port
:members:
:show-inheritance:
Lumped Port
-----------
.. autoclass:: LumpedPort
:members:
:show-inheritance:
MSL Port
--------
.. autoclass:: MSLPort
:members:
:show-inheritance:
Waveguide Port
--------------
.. autoclass:: WaveguidePort
:members:
:show-inheritance:
Rect Waveguide Port
-------------------
.. autoclass:: RectWGPort
:members:
:show-inheritance:
NF2FF
-----
.. automodule:: openEMS.nf2ff
NF2FF
-----
.. autoclass:: nf2ff
:members:
NF2FF Results
-----------------
.. autoclass:: nf2ff_results
:members: