Welcome to openEMS’s documentation!
Contents:
- Introduction
- Install
- Concepts
- CSXCAD
- Properties
- Discrete (Voxelized) Material
- Primitives
- Mesh
- Boundary Conditions
- Ports
- Excitation Sources
- Signal Waveforms
- Field Dump
- Lumped Elements
- Dispersive Materials
- Simulation
- Post-Processing
- Python Tutorials
- Octave/Matlab Tutorials
- Transmission Lines and Filters
- Waveguides
- Patch Antennas
- Simple Patch Antenna
- Bent Patch Antenna
- Octave/Matlab Script
- Simulation Parameters
- FDTD Solver Initialization
- Geometry Initialization
- Radiating Patch Element
- Dielectric Substrate
- Current Density Probe
- Ground Plane
- Feed Port
- Mesh Generation
- Near-Field to Far-Field Box
- Write and Run Simulation
- S-Parameter and Impedance Post-Processing
- Current Distribution Export
- Far-Field Pattern Calculation
- Three-Dimensional Far-Field Pattern
- Images
- Patch Antenna Phased Array
- Octave/Matlab Script
- Full S-Parameter Simulation Loop
- Export S-Parameters to Touchstone
- Port Current Calculation via Circuit Theory
- Reference Simulation for Verification
- Superposition Weighting Coefficients
- Far-Field Pattern Visualization
- Array Element Helper Function
- Simulation Parameters
- FDTD Parameters and Excitation
- CSXCAD Geometry and Mesh Initialization
- Patch Elements and Feed Ports
- Dielectric Substrate
- Ground Plane
- Mesh Finalization
- Near-Field to Far-Field Box
- Prepare Simulation Folder
- Write Model to XML
- Visualize Structure
- Run openEMS Solver
- Images
- Literature
- Horn and Wire Antennas
- Horn Antenna
- Octave/Matlab Script
- Simulation Parameters
- FDTD Solver and Excitation Setup
- CSXCAD Geometry and Mesh Initialization
- Horn Antenna Geometry
- Waveguide Port Excitation
- Near-Field to Far-Field Transformation Box
- Simulation Output Directory
- Export CSXCAD XML
- Geometry Visualization
- Run the FDTD Simulation
- S-Parameter Post-Processing
- Far-Field Radiation Pattern
- Normalized Directivity Plots
- Three-Dimensional Far-Field Pattern
- VTK Far-Field Export
- Images
- Conical Horn Antenna
- Octave/Matlab Script
- Simulation Parameters
- FDTD Solver and Excitation Setup
- CSXCAD Geometry and Mesh
- Conical Horn Geometry
- Waveguide Feed Port
- Excitation Field Dump
- Near-Field to Far-Field Box
- Simulation Folder Setup
- Write OpenEMS XML File
- Preview Geometry
- Run Simulation
- Post-Processing and S-Parameter Plot
- Far-Field Radiation Patterns
- Normalised Directivity Plots
- Three-Dimensional Far-Field Pattern
- Export Pattern to VTK
- Images
- Helical Antenna
- Octave/Matlab Script
- Simulation Parameters
- FDTD Solver Configuration
- Mesh Setup
- Helix Wire Geometry
- Circular Ground Plane
- Lumped Feed Port
- Near-Field to Far-Field Box
- Simulation Folder Setup
- Export Simulation to XML
- Geometry Preview
- Run Simulation
- Port Post-Processing and S-Parameters
- Far-Field Pattern Calculation
- Directivity Decomposition
- Radiation Pattern Plot
- Export Far-Field to VTK
- Images
- Horn Antenna
- CRLH Structures
- CRLH Parameter Extraction
- Octave/Matlab Script
- Simulation Parameters
- FDTD Parameters and Excitation
- Mesh Initialization and CRLH Unit Cell
- Substrate Layers
- Microstrip Feed Ports
- Write and Run the Simulation
- S-Parameter Post-Processing
- CRLH Lumped Parameter Extraction
- Analytical Dispersion Relation
- Dispersion Diagram
- Images
- Notes
- CRLH Leaky Wave Antenna
- Octave/Matlab Script
- Simulation Parameters
- FDTD Parameters and Excitation
- Mesh Setup and CRLH Unit Cell Instantiation
- Substrate Layer Definition
- Ground Plane and MSL Feed Ports
- Near-Field to Far-Field Box
- Write Geometry, Preview, and Run Simulation
- S-Parameter Post-Processing
- 3D Radiation Pattern Calculation
- Directivity and Radiation Efficiency
- VTK Far-Field Pattern Export
- Images
- Notes
- CRLH Parameter Extraction
- Scattering and Radar
- Metal Sphere Radar Cross Section
- Octave/Matlab Script
- Setup the Simulation
- FDTD Parameters and Excitation
- CSXCAD Geometry and Mesh
- Create the Metal Sphere
- Plane Wave Excitation
- Electric Field Dump
- Near-Field to Far-Field Box
- Prepare Simulation Folder
- Write XML File
- Show the Structure
- Run openEMS
- Post-Processing: Incident Power
- Bistatic RCS at Single Frequency
- Back-Scatter over Frequency Range
- Plot RCS vs Frequency
- Normalized Radar Cross Section
- Images
- UWB Radar — Delay and Fidelity
- Metal Sphere Radar Cross Section
- Biomedical and SAR
- Dipole SAR
- Octave/Matlab Script
- Switches and Options
- Simulation Folder Setup
- Simulation Parameters
- Human Head Phantom Definition
- FDTD Parameters and Excitation
- FDTD Solver Configuration
- CSXCAD Geometry Initialisation
- Dipole Antenna Geometry
- Phantom Dielectric Layers
- Lumped Port Excitation
- Mesh Smoothing Over Dipole and Phantom
- Air-Box and Final Mesh Smoothing
- SAR Dump Box Configuration
- Near-Field to Far-Field Box
- PML Padding and Mesh Finalisation
- Write Geometry and Run Simulation
- Port Post-Processing
- Feed Impedance and Reflection Plots
- SAR Data Import
- Far-Field Pattern Calculation
- Power Budget Summary
- SAR Distribution on the XY Plane
- SAR Distribution on the XZ Plane
- VTK Export for 3D Visualisation
- Images
- MRI Loop Coil
- Octave/Matlab Script
- Simulation Parameters
- Human Body Model Setup
- Air Box Size
- FDTD Solver and Excitation
- Geometry Initialisation
- Loop Coil Geometry
- Body Model Placement
- Mesh Generation
- Field and SAR Dump Boxes
- Absorbing Boundary Padding
- Finalise and Apply Mesh
- Simulation Folder Preparation
- Write Simulation XML
- Visualise and Export Geometry
- Run the Simulation
- Port Post-Processing
- S-Parameter and Admittance Plots
- SAR Distribution – Axial Plane (XY)
- SAR Distribution – Sagittal Plane (XZ)
- B1 Field Maps – Axial Plane (XY)
- B1 Field Maps – Sagittal Plane (XZ)
- Export SAR Data to VTK
- Export B1 Field Data to VTK
- Images
- Body Model
- Literature
- MRI Linear Polarized Birdcage Coil
- Octave/Matlab Script
- Human Body Model (Virtual Family)
- Simulation Parameters
- FDTD Solver Setup and Excitation
- CSXCAD Geometry and Mesh Initialization
- Birdcage Coil Construction
- Mesh Smoothing
- Cell Count Sanity Check
- Body Model Material Assignment
- Field and SAR Dump Boxes
- Mesh Finalization
- Write Geometry and Run Simulation
- S-Parameter Calculation
- SAR Distribution Plot
- B1 Field Analysis
- VTK Export for 3D Visualization
- Images
- Body Model
- Literature
- Dipole SAR
- Python Interface
- Install
- Install Python Extensions Automatically
- Methods
- Quick Start
- Customize Install
- Typical Customization Cases
- Q: I don’t want
update_openEMS.shto create a newvenvfor me, because I have my own. - Q: I want to create a new
venv, but not under the/venvsubdirectory of openEMS. - Q: All system packages are invisible in the Python
venv. I don’t want to reinstall them viapip3for thevenv, I want to use the existing system Python packages. - Q: I don’t want
./update_openEMS.shto download dependencies usingpip3because I don’t have Internet access. - Q: I don’t want to use
pip3to manage Python package dependencies, I want to use my system’s own package manager. - Q: I have Internet access, but behind a proxy.
- Q: I have Internet access, but behind an HTTP proxy.
- Q: I have Internet access, but behind a SOCKS proxy.
- Q: I don’t want to use a Python
venvat all, I want to install Python extensions to the default paths, which is the legacy behavior in previous openEMS versions. - Q: I’m debugging
./update_openEMS.sh --python, but the Python errors are incomprehensible - Q:
./update_openEMS.shis a black box, I need explicit control over the installation.
- Q: I don’t want
- Install Python Extensions Manually
- Methods
- Requirements
- Quick Start
- Environment Variables
- Basic Install
- Offline Install or Manual Package Management
- Advanced Install Concepts
- Windows
- Troubleshooting
- AttributeError: module ‘CSXCAD.CSRectGrid’ has no attribute…
- FileNotFoundError: [Errno 2] No such file or directory:
/CSXCAD/python - Unable to detect CSXCAD’s Python source code path
- ModuleNotFoundError: No module named ‘CSXCAD.CSXCAD’
- ModuleNotFoundError: No module named ‘openEMS.openEMS’
- error: invalid command ‘bdist_wheel’
- CSXCAD Tests and Examples
- Install Python Extensions Automatically
- CSXCAD Python Interface
- CSXCAD
ContinuousStructureContinuousStructure.AddAbsorbingBC()ContinuousStructure.AddConductingSheet()ContinuousStructure.AddDiscMaterial()ContinuousStructure.AddDump()ContinuousStructure.AddExcitation()ContinuousStructure.AddLumpedElement()ContinuousStructure.AddMaterial()ContinuousStructure.AddMetal()ContinuousStructure.AddProbe()ContinuousStructure.AddProperty()ContinuousStructure.Clear()ContinuousStructure.DefineGrid()ContinuousStructure.DeleteProperty()ContinuousStructure.GetAllPrimitives()ContinuousStructure.GetAllProperties()ContinuousStructure.GetBackgroundMaterial()ContinuousStructure.GetCoordInputType()ContinuousStructure.GetGrid()ContinuousStructure.GetParameterSet()ContinuousStructure.GetPropertiesByName()ContinuousStructure.GetProperty()ContinuousStructure.GetPropertyByCoordPriority()ContinuousStructure.GetPropertyByType()ContinuousStructure.GetQtyPrimitives()ContinuousStructure.GetQtyProperties()ContinuousStructure.ReadFromXML()ContinuousStructure.RemoveProperty()ContinuousStructure.Reset()ContinuousStructure.SetMeshType()ContinuousStructure.Update()ContinuousStructure.Write2XML()ContinuousStructure.grid
- CSProperties
- CSPrimitives
- CSTransform
CSTransformCSTransform.AddTransform()CSTransform.GetMatrix()CSTransform.HasTransform()CSTransform.Reset()CSTransform.RotateAxis()CSTransform.RotateOrigin()CSTransform.Scale()CSTransform.SetMatrix()CSTransform.SetPostMultiply()CSTransform.SetPreMultiply()CSTransform.Transform()CSTransform.Translate()CSTransform.copy()
- CSRectGrid
CSRectGridCSRectGrid.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()
CoordinateSystem
- Mesh
- Utilities
- CSXCAD
- openEMS Python Interface
- openEMS
openEMSopenEMS.AddCPWPort()openEMS.AddCircWaveGuidePort()openEMS.AddCoaxialPort()openEMS.AddCurvePort()openEMS.AddEdges2Grid()openEMS.AddLumpedPort()openEMS.AddMSLPort()openEMS.AddRectWaveGuidePort()openEMS.AddStripLinePort()openEMS.AddWaveGuidePort()openEMS.CreateNF2FFBox()openEMS.GetCSX()openEMS.ReadFromXML()openEMS.Reset()openEMS.Run()openEMS.SetAbort()openEMS.SetBoundaryCond()openEMS.SetCSX()openEMS.SetCellConstantMaterial()openEMS.SetCoordSystem()openEMS.SetCustomExcite()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()openEMS.Write2XML()
- Ports
- NF2FF
- openEMS
- Install
- Octave/Matlab Interface
- Install
- CSXCAD API
- Geometry
- Materials
- AddConductingSheet
- AddMetal
- AddMaterial
- AddLumpedElement
- AddDebyeMaterial
- AddDjordjevicSarkarMaterial
- AddDiscMaterial
- AddLorentzMaterial
- CalcDebyeMaterial
- CalcDjordjevicSarkarApprox
- CalcDrudeMaterial
- CalcLorentzMaterial
- SetBackgroundMaterial
- SetMaterialProperty
- SetMaterialWeight
- Convert_VF_DiscMaterial
- CreateDiscMaterial
- Mesh
- Excitations
- Probes and Field Dump
- Import & Export
- Misc
- openEMS API
- Excitations
- Ports
- Field Dump
- Simulation
- Post-processing
- calcLumpedPort
- calcPort
- calcTLPort
- calcWGPort
- calc_ypar
- plotFF3D
- plotFFdB
- plotRefl
- polarFF
- PlotHDF5FieldData
- GetField_Interpolation
- GetField_Range
- GetField_SubSampling
- GetField_TD2FD
- ReadHDF5Attribute
- ReadHDF5Dump
- ReadHDF5FieldData
- ReadHDF5Mesh
- ReadUI
- WriteHDF5
- ConvertHDF5_VTK
- AR_estimate
- DFT_time2freq
- DelayFidelity
- FFT_time2freq
- harminv
- CalcSAR
- Optimization
- Near-Field to Far-Field Transform
- Misc
- Learn More
- Frequently Asked Questions
- Publications
- Development