Welcome to openEMS’s documentation!

Contents:

• Introduction
  • Features
  • Citation
• Install
  • Requirements
    • Debian/Ubuntu
    • Fedora
    • FreeBSD
    • macOS
    • Windows
  • Clone, Build and Install
    • Clone
    • Build and Install
    • openEMS search path
    • Setup the Octave/Matlab or Python Interfaces
    • Check Installation
    • Update Instruction
  • Installing Ready-Made Packages
    • Windows
      • Setup the Octave/Matlab or Python Interfaces
      • Check Installation
    • FreeBSD
      • Setup the Octave/Matlab or Python Interfaces
      • Check Installation
    • macOS
      • Setup Octave/Matlab Interfaces
      • Setup Python Interfaces
      • Check Installation
        • Troubleshooting
        • Updating
  • Manual Build and Install
    • Install Dependencies
    • Install Basic Programs
    • Install Python bindings (optional)
    • Install AppCSXCAD GUI (optional)
    • openEMS search path
      • Setup the Octave/Matlab or Python Interfaces
    • Troubleshooting
  • Check Installation
    • Prerequisites
    • openEMS executable
      • Linux
      • Windows
    • AppCSXCAD executable
      • Linux
      • Windows
    • Matlab/Octave Interface
    • Python interface
• Tutorials
  • How to run the tutorials
  • Tutorials
    • Introductional Tutorials
      • Rectangular Waveguide
        • Introduction
        • Python Script
        • Images
      • Metal Sphere Radar Cross Section
        • Introduction
        • Python Script
        • Images
    • Micro Wave Tutorials
      • Microstrip Notch Filter
        • Introduction
        • Python Script
        • Images
      • CRLH Parameter Extraction
        • Introduction
        • Python Script
        • Images
    • Antennas
      • Simple Patch Antenna
        • Introduction
        • Python Script
        • Images
      • Helical Antenna
        • Introduction
        • Python Script
        • Images
      • Bent Patch Antenna
        • Introduction
        • Python Script
        • Images
• Python Interface
  • Install
    • Module requirements
    • Linux
      • Build Modules Automatically
      • Build Modules From Source Manually
    • Windows
      • Install Pre-build Modules
      • Build Modules From Source
      • Setup
  • CSXCAD Python Interface
    • CSXCAD
      • ContinuousStructure
        • ContinuousStructure.AddConductingSheet()
        • ContinuousStructure.AddDump()
        • ContinuousStructure.AddExcitation()
        • ContinuousStructure.AddLumpedElement()
        • ContinuousStructure.AddMaterial()
        • ContinuousStructure.AddMetal()
        • ContinuousStructure.AddProbe()
        • ContinuousStructure.AddProperty()
        • ContinuousStructure.DefineGrid()
        • ContinuousStructure.GetAllPrimitives()
        • ContinuousStructure.GetAllProperties()
        • ContinuousStructure.GetGrid()
        • ContinuousStructure.GetParameterSet()
        • ContinuousStructure.GetPropertiesByName()
        • ContinuousStructure.GetProperty()
        • ContinuousStructure.GetPropertyByCoordPriority()
        • ContinuousStructure.GetPropertyByType()
        • ContinuousStructure.GetQtyPrimitives()
        • ContinuousStructure.GetQtyProperties()
        • ContinuousStructure.ReadFromXML()
        • ContinuousStructure.SetMeshType()
        • ContinuousStructure.Update()
        • ContinuousStructure.Write2XML()
    • CSProperties
      • Notes
      • Examples
      • CSProperties (Base Class)
        • CSProperties
      • CSPropMaterial
        • CSPropMaterial
      • CSPropLumpedElement
        • CSPropLumpedElement
      • CSPropMetal
        • CSPropMetal
      • CSPropConductingSheet
        • CSPropConductingSheet
      • CSPropExcitation
        • CSPropExcitation
      • CSPropProbeBox
        • CSPropProbeBox
      • CSPropDumpBox
        • CSPropDumpBox
    • CSPrimitives
      • Notes
      • Examples
      • CSPrimitives (Base Class)
        • CSPrimitives
      • CSPrimPoint
        • CSPrimPoint
      • CSPrimBox
        • CSPrimBox
      • CSPrimCylinder
        • CSPrimCylinder
      • CSPrimCylindricalShell
        • CSPrimCylindricalShell
      • CSPrimSphere
        • CSPrimSphere
      • CSPrimSphericalShell
        • CSPrimSphericalShell
      • CSPrimPolygon
        • CSPrimPolygon
      • CSPrimLinPoly
        • CSPrimLinPoly
      • CSPrimRotPoly
        • CSPrimRotPoly
      • CSPrimCurve
        • CSPrimCurve
      • CSPrimWire
        • CSPrimWire
      • CSPrimPolyhedron
        • CSPrimPolyhedron
      • CSPrimPolyhedronReader
        • CSPrimPolyhedronReader
    • CSTransform
      • CSTransform
        • CSTransform.AddTransform()
        • CSTransform.GetMatrix()
        • CSTransform.HasTransform()
        • CSTransform.Reset()
        • CSTransform.RotateAxis()
        • CSTransform.RotateOrigin()
        • CSTransform.Scale()
        • CSTransform.SetMatrix()
        • CSTransform.SetPostMultiply()
        • CSTransform.SetPreMultiply()
        • CSTransform.Transform()
        • CSTransform.Translate()
    • CSRectGrid
      • CSRectGrid
        • CSRectGrid.AddLine()
        • CSRectGrid.Clear()
        • CSRectGrid.ClearLines()
        • CSRectGrid.GetDeltaUnit()
        • CSRectGrid.GetLine()
        • CSRectGrid.GetLines()
        • CSRectGrid.GetMeshType()
        • CSRectGrid.GetQtyLines()
        • CSRectGrid.GetSimArea()
        • CSRectGrid.IsValid()
        • CSRectGrid.SetDeltaUnit()
        • CSRectGrid.SetLines()
        • CSRectGrid.SetMeshType()
        • CSRectGrid.SmoothMeshLines()
        • CSRectGrid.Snap2LineNumber()
        • CSRectGrid.Sort()
    • Mesh
      • SmoothMeshLines
        • CheckSymmetry()
        • MeshLinesSymmetric()
        • SmoothMeshLines()
        • SmoothRange()
        • Unique()
    • Utilities
      • CheckNyDir()
      • GetMultiDirs()
  • openEMS Python Interface
    • openEMS
      • openEMS
        • openEMS.AddEdges2Grid()
        • openEMS.AddLumpedPort()
        • openEMS.AddMSLPort()
        • openEMS.AddRectWaveGuidePort()
        • openEMS.AddWaveGuidePort()
        • openEMS.CreateNF2FFBox()
        • openEMS.GetCSX()
        • openEMS.Run()
        • openEMS.SetAbort()
        • openEMS.SetBoundaryCond()
        • openEMS.SetCSX()
        • openEMS.SetCellConstantMaterial()
        • openEMS.SetCoordSystem()
        • openEMS.SetCylinderCoords()
        • openEMS.SetDiracExcite()
        • openEMS.SetEndCriteria()
        • openEMS.SetGaussExcite()
        • openEMS.SetMaxTime()
        • openEMS.SetMultiGrid()
        • openEMS.SetNumberOfTimeSteps()
        • openEMS.SetOverSampling()
        • openEMS.SetSinusExcite()
        • openEMS.SetStepExcite()
        • openEMS.SetTimeStep()
        • openEMS.SetTimeStepFactor()
        • openEMS.SetTimeStepMethod()
        • openEMS.WelcomeScreen()
    • Ports
      • Port (Base Class)
        • Port
      • Lumped Port
        • LumpedPort
      • MSL Port
        • MSLPort
      • Waveguide Port
        • WaveguidePort
      • Rect Waveguide Port
        • RectWGPort
    • NF2FF
      • NF2FF
        • nf2ff
      • NF2FF Results
        • nf2ff_results
• Octave/Matlab Interface
  • Install
    • Requirements
    • Setup
      • Linux
      • Windows
• Learn More
  • Documentation and Q&A
  • FDTD
  • openEMS
• Publications
  • 2023
  • 2022
  • 2020
  • 2019
  • 2012
  • 2011

Indices and tables

• Index

• Module Index

• Search Page