Welcome to openEMS’s documentation!
Contents:
- Introduction
- Install
- Development
- Concepts
- CSXCAD
- Properties
- Primitives
- Mesh
- Boundary Conditions
- Ports
- Excitation Sources
- Signal Waveforms
- Field Dump
- Lumped Elements
- Dispersive Materials
- Symbolic Expression Parser:
fparser - Simulation
- Post-Processing
- Tutorials
- 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:
./update_openEMS.shis a black box, I need explicit control over the installation.
- Q: I don’t want
- Install Python Extensions Manually
- Install Python Extensions Automatically
- CSXCAD Python Interface
- CSXCAD
ContinuousStructureContinuousStructure.AddAbsorbingBC()ContinuousStructure.AddConductingSheet()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.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()
- 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.AddEdges2Grid()openEMS.AddLumpedPort()openEMS.AddMSLPort()openEMS.AddRectWaveGuidePort()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
- Optimization
- Near-Field to Far-Field Transform
- Misc
- Learn More
- Publications