summaryrefslogtreecommitdiff
path: root/openEMS/python/doc/Tutorials
diff options
context:
space:
mode:
Diffstat (limited to 'openEMS/python/doc/Tutorials')
-rw-r--r--openEMS/python/doc/Tutorials/Antenna_Tutorials.rst9
-rw-r--r--openEMS/python/doc/Tutorials/Bent_Patch_Antenna.rst35
-rw-r--r--openEMS/python/doc/Tutorials/CRLH_Extraction.rst40
-rw-r--r--openEMS/python/doc/Tutorials/Helical_Antenna.rst32
-rw-r--r--openEMS/python/doc/Tutorials/Intro_Tutorials.rst10
-rw-r--r--openEMS/python/doc/Tutorials/MSL_NotchFilter.rst27
-rw-r--r--openEMS/python/doc/Tutorials/MicroWave_Tutorials.rst10
-rw-r--r--openEMS/python/doc/Tutorials/RCS_Sphere.rst32
-rw-r--r--openEMS/python/doc/Tutorials/Rect_Waveguide.rst27
-rw-r--r--openEMS/python/doc/Tutorials/Simple_Patch_Antenna.rst42
-rw-r--r--openEMS/python/doc/Tutorials/images/Bent_Patch.pngbin0 -> 353961 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Bent_Patch_Pattern.pngbin0 -> 128101 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Bent_Patch_SPara.pngbin0 -> 44995 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/CRLH_Spara.pngbin0 -> 43439 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/CRLH_cell.pngbin0 -> 160686 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/CRLH_dispersion.pngbin0 -> 58633 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Helix_Ant.pngbin0 -> 311208 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Helix_Ant_Pattern.pngbin0 -> 63799 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Notch_Filter_SPara.pngbin0 -> 49022 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/RCS_norm.pngbin0 -> 43421 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/RCS_pattern.pngbin0 -> 61739 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Rect_WG_SPara.pngbin0 -> 28698 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Simp_Patch_Pattern.pngbin0 -> 53846 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Simp_Patch_S11.pngbin0 -> 28926 bytes
-rw-r--r--openEMS/python/doc/Tutorials/images/Simp_Patch_Zin.pngbin0 -> 39892 bytes
-rw-r--r--openEMS/python/doc/Tutorials/index.rst12
26 files changed, 276 insertions, 0 deletions
diff --git a/openEMS/python/doc/Tutorials/Antenna_Tutorials.rst b/openEMS/python/doc/Tutorials/Antenna_Tutorials.rst
new file mode 100644
index 0000000..4a5927a
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/Antenna_Tutorials.rst
@@ -0,0 +1,9 @@
+Antennas
+--------
+
+.. toctree::
+ :maxdepth: 1
+
+ Simple_Patch_Antenna
+ Helical_Antenna
+ Bent_Patch_Antenna
diff --git a/openEMS/python/doc/Tutorials/Bent_Patch_Antenna.rst b/openEMS/python/doc/Tutorials/Bent_Patch_Antenna.rst
new file mode 100644
index 0000000..9582563
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/Bent_Patch_Antenna.rst
@@ -0,0 +1,35 @@
+Bent Patch Antenna
+==================
+
+* Setup & Simulate a bent patch antenna using a cylindrical mesh
+
+Introduction
+-------------
+**This tutorial covers:**
+
+* Setup of a Bent Patch Antenna (see for comparison: :ref:`simple_patch_antenna`)
+* setup of a *cylindrical FDTD mesh*.
+* Calculate the S-Parameter and input impedance
+* Calculate far-field pattern 2D/3D
+
+
+Python Script
+-------------
+Get the latest version `from git <http://www.openems.de/gitweb/?p=openEMS.git;a=blob_plain;f=matlab/Tutorials/Bent_Patch_Antenna.m;hb=refs/heads/master>`_.
+
+.. include:: ./__Bent_Patch_Antenna.txt
+
+Images
+-------------
+.. figure:: images/Bent_Patch.png
+ :width: 49%
+ :alt: alternate text
+
+ 3D view of the Bent Patch Antenna (AppCSXCAD)
+
+.. figure:: images/Bent_Patch_Pattern.png
+ :width: 80%
+ :alt: Farfield pattern
+
+ Farfield pattern on an xy- and xz-plane
+
diff --git a/openEMS/python/doc/Tutorials/CRLH_Extraction.rst b/openEMS/python/doc/Tutorials/CRLH_Extraction.rst
new file mode 100644
index 0000000..156cf73
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/CRLH_Extraction.rst
@@ -0,0 +1,40 @@
+CRLH Parameter Extraction
+=========================
+
+* Setup a composite-right/left-handed (CRLH) unit cell and extract the equivalent circuit parameter.
+
+Introduction
+-------------
+**This tutorial covers:**
+
+* Setup a feeding mircostrip line & port
+* Apply an inhomogeneous mesh used for improved accuracy and simulation speed
+* Use an internal clss to setup a CRLH unit cell
+* Use the port voltages and currents to extract the unit cell equivalent circuit parameter
+
+.. figure:: images/CRLH_cell.png
+ :width: 80%
+ :alt: CRLH unit cell with feeding MSL.
+
+ CRLH unit cell with feeding MSL.
+
+Python Script
+-------------
+Get the latest version `from git <http://www.openems.de/gitweb/?p=openEMS.git;a=blob_plain;f=matlab/Tutorials/Bent_Patch_Antenna.m;hb=refs/heads/master>`_.
+
+.. include:: ./__CRLH_Extraction.txt
+
+Images
+-------------
+
+.. figure:: images/CRLH_Spara.png
+ :width: 80%
+ :alt: CRLH cell S-parameter
+
+ CRLH cell S-parameter
+
+.. figure:: images/CRLH_dispersion.png
+ :width: 80%
+ :alt: CRLH unit cell dispersion diagram
+
+ CRLH unit cell dispersion diagram
diff --git a/openEMS/python/doc/Tutorials/Helical_Antenna.rst b/openEMS/python/doc/Tutorials/Helical_Antenna.rst
new file mode 100644
index 0000000..6a94081
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/Helical_Antenna.rst
@@ -0,0 +1,32 @@
+Helical Antenna
+===============
+
+Introduction
+-------------
+**This tutorial covers:**
+
+* setup of a helix using the wire primitive
+* setup a lumped feeding port (R_in = 120 Ohms)
+* adding a near-field to far-field (nf2ff) box using an efficient subsampling
+* calculate the S-Parameter of the antenna
+* calculate and plot the far-field pattern
+
+Python Script
+-------------
+Get the latest version `from git <http://www.openems.de/gitweb/?p=openEMS.git;a=blob_plain;f=matlab/Tutorials/Helical_Antenna.m;hb=refs/heads/master>`_.
+
+.. include:: ./__Helical_Antenna.txt
+
+Images
+-------------
+.. figure:: images/Helix_Ant.png
+ :width: 49%
+ :alt: alternate text
+
+ 3D view of the Helical Antenna (AppCSXCAD)
+
+.. figure:: images/Helix_Ant_Pattern.png
+ :width: 49%
+ :alt: alternate text
+
+ Far-Field pattern showing a right-handed circular polarization.
diff --git a/openEMS/python/doc/Tutorials/Intro_Tutorials.rst b/openEMS/python/doc/Tutorials/Intro_Tutorials.rst
new file mode 100644
index 0000000..8126f33
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/Intro_Tutorials.rst
@@ -0,0 +1,10 @@
+.. _intro_tutorials:
+
+Introductional Tutorials
+------------------------
+
+
+.. toctree::
+
+ Rect_Waveguide
+ RCS_Sphere
diff --git a/openEMS/python/doc/Tutorials/MSL_NotchFilter.rst b/openEMS/python/doc/Tutorials/MSL_NotchFilter.rst
new file mode 100644
index 0000000..c84883e
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/MSL_NotchFilter.rst
@@ -0,0 +1,27 @@
+Microstrip Notch Filter
+=======================
+
+ * A straight MSL line with a open-ended stub to create a simple microwave filter.
+
+Introduction
+-------------
+**This tutorial covers:**
+
+
+* Setup a mircostrip line (MSL) and MSL port
+* Apply an inhomogeneous mesh used for improved accuracy and simulation speed
+* Calculate the S-Parameter of the filter
+
+Python Script
+-------------
+Get the latest version `from git <http://openems.de/gitweb/?p=openEMS.git;a=blob_plain;f=matlab/Tutorials/MSL_NotchFilter.m;hb=HEAD>`_.
+
+.. include:: ./__MSL_NotchFilter.txt
+
+Images
+-------------
+.. figure:: images/Notch_Filter_SPara.png
+ :width: 49%
+ :alt: S-Parameter over Frequency
+
+ S-Parameter over Frequency
diff --git a/openEMS/python/doc/Tutorials/MicroWave_Tutorials.rst b/openEMS/python/doc/Tutorials/MicroWave_Tutorials.rst
new file mode 100644
index 0000000..92fc0ce
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/MicroWave_Tutorials.rst
@@ -0,0 +1,10 @@
+.. _microwave_tutorials:
+
+Micro Wave Tutorials
+--------------------
+
+
+.. toctree::
+
+ MSL_NotchFilter
+ CRLH_Extraction
diff --git a/openEMS/python/doc/Tutorials/RCS_Sphere.rst b/openEMS/python/doc/Tutorials/RCS_Sphere.rst
new file mode 100644
index 0000000..1cbced8
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/RCS_Sphere.rst
@@ -0,0 +1,32 @@
+Metal Sphere Radar Cross Section
+================================
+
+ * A 3D simulation demonstrating a the total-field/scattered-field approach on a metallic sphere with a RCS (radar cross section) calculation.
+
+Introduction
+-------------
+**This tutorial covers:**
+
+
+* The total-field/scattered-field approach
+* Calculation of a radar cross section (RCS)
+
+Python Script
+-------------
+Get the latest version `from git <https://raw.githubusercontent.com/thliebig/openEMS/master/python/Tutorials/RCS_Sphere.py>`_.
+
+.. include:: ./__RCS_Sphere.txt
+
+Images
+-------------
+.. figure:: images/RCS_pattern.png
+ :width: 49%
+ :alt: Radar cross section pattern
+
+ Radar cross section pattern
+
+.. figure:: images/RCS_norm.png
+ :width: 49%
+ :alt: normalized radar cross section
+
+ Normalized radar cross Section over normalized wavelength
diff --git a/openEMS/python/doc/Tutorials/Rect_Waveguide.rst b/openEMS/python/doc/Tutorials/Rect_Waveguide.rst
new file mode 100644
index 0000000..8b955ac
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/Rect_Waveguide.rst
@@ -0,0 +1,27 @@
+Rectangular Waveguide
+=====================
+
+ * A simple rectangular waveguide, showing the openEMS mode profile capabilities.
+
+Introduction
+-------------
+**This tutorial covers:**
+
+* Setup a mode profile excitation
+* Create voltage and current probes using the mode profile
+* Calculate the waveguide impedance and S-Parameter
+
+
+Python Script
+-------------
+Get the latest version `from git <http://openems.de/gitweb/?p=openEMS.git;a=blob_plain;f=matlab/Tutorials/Rect_Waveguide.m;hb=HEAD>`_.
+
+.. include:: ./__Rect_Waveguide.txt
+
+Images
+-------------
+.. figure:: images/Rect_WG_SPara.png
+ :width: 49%
+ :alt: S-Parameter over Frequency
+
+ S-Parameter over Frequency
diff --git a/openEMS/python/doc/Tutorials/Simple_Patch_Antenna.rst b/openEMS/python/doc/Tutorials/Simple_Patch_Antenna.rst
new file mode 100644
index 0000000..4345c56
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/Simple_Patch_Antenna.rst
@@ -0,0 +1,42 @@
+.. _simple_patch_antenna:
+
+Simple Patch Antenna
+====================
+
+Introduction
+------------
+A simple patch antenna for 2.4 GHz.
+
+**This tutorial covers:**
+
+* Setup a patch, substrate and ground.
+* Setup of a lumped feeding port.
+* Adding a near-field to far-field (nf2ff) recording box.
+* Calculate the S-Parameter of the antenna.
+* Calculate and plot the far-field pattern
+
+Python Script
+-------------
+Get the latest version `from git <http://www.openems.de/gitweb/?p=openEMS.git;a=blob_plain;f=matlab/Tutorials/Simple_Patch_Antenna.m;hb=refs/heads/master>`_.
+
+.. include:: ./__Simple_Patch_Antenna.txt
+
+Images
+------
+.. figure:: images/Simp_Patch_S11.png
+ :width: 49%
+ :alt: S11 over Frequency
+
+ S-Parameter over Frequency
+
+.. figure:: images/Simp_Patch_Zin.png
+ :width: 49%
+ :alt: Input Impedance
+
+ Antenna Input Impedance
+
+.. figure:: images/Simp_Patch_Pattern.png
+ :width: 49%
+ :alt: Farfield pattern
+
+ Farfield pattern for the xy- and yz-plane.
diff --git a/openEMS/python/doc/Tutorials/images/Bent_Patch.png b/openEMS/python/doc/Tutorials/images/Bent_Patch.png
new file mode 100644
index 0000000..0beddf9
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Bent_Patch.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Bent_Patch_Pattern.png b/openEMS/python/doc/Tutorials/images/Bent_Patch_Pattern.png
new file mode 100644
index 0000000..4fc3211
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Bent_Patch_Pattern.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Bent_Patch_SPara.png b/openEMS/python/doc/Tutorials/images/Bent_Patch_SPara.png
new file mode 100644
index 0000000..d3970fb
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Bent_Patch_SPara.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/CRLH_Spara.png b/openEMS/python/doc/Tutorials/images/CRLH_Spara.png
new file mode 100644
index 0000000..d0f4a3b
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/CRLH_Spara.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/CRLH_cell.png b/openEMS/python/doc/Tutorials/images/CRLH_cell.png
new file mode 100644
index 0000000..85ae9b7
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/CRLH_cell.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/CRLH_dispersion.png b/openEMS/python/doc/Tutorials/images/CRLH_dispersion.png
new file mode 100644
index 0000000..65fc163
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/CRLH_dispersion.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Helix_Ant.png b/openEMS/python/doc/Tutorials/images/Helix_Ant.png
new file mode 100644
index 0000000..16c532c
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Helix_Ant.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Helix_Ant_Pattern.png b/openEMS/python/doc/Tutorials/images/Helix_Ant_Pattern.png
new file mode 100644
index 0000000..020aae1
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Helix_Ant_Pattern.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Notch_Filter_SPara.png b/openEMS/python/doc/Tutorials/images/Notch_Filter_SPara.png
new file mode 100644
index 0000000..9d1d7be
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Notch_Filter_SPara.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/RCS_norm.png b/openEMS/python/doc/Tutorials/images/RCS_norm.png
new file mode 100644
index 0000000..57712ba
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/RCS_norm.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/RCS_pattern.png b/openEMS/python/doc/Tutorials/images/RCS_pattern.png
new file mode 100644
index 0000000..b3d9d23
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/RCS_pattern.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Rect_WG_SPara.png b/openEMS/python/doc/Tutorials/images/Rect_WG_SPara.png
new file mode 100644
index 0000000..0c0ff27
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Rect_WG_SPara.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Simp_Patch_Pattern.png b/openEMS/python/doc/Tutorials/images/Simp_Patch_Pattern.png
new file mode 100644
index 0000000..2cd90d4
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Simp_Patch_Pattern.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Simp_Patch_S11.png b/openEMS/python/doc/Tutorials/images/Simp_Patch_S11.png
new file mode 100644
index 0000000..381bb3c
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Simp_Patch_S11.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/images/Simp_Patch_Zin.png b/openEMS/python/doc/Tutorials/images/Simp_Patch_Zin.png
new file mode 100644
index 0000000..bbabe54
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/images/Simp_Patch_Zin.png
Binary files differ
diff --git a/openEMS/python/doc/Tutorials/index.rst b/openEMS/python/doc/Tutorials/index.rst
new file mode 100644
index 0000000..fd5c5dc
--- /dev/null
+++ b/openEMS/python/doc/Tutorials/index.rst
@@ -0,0 +1,12 @@
+.. _tutorials:
+
+#########
+Tutorials
+#########
+
+.. toctree::
+ :maxdepth: 2
+
+ Intro_Tutorials
+ MicroWave_Tutorials
+ Antenna_Tutorials