simpleEMS 0.1.0__tar.gz

simpleems-0.1.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: simpleEMS
+Version: 0.1.0
+Summary: simpleEMS is a framework built on top of openEMS to make design and simulation of antennas and other microwave structures simpler
+License-Expression: AGPL-3.0-or-later
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: cadquery==2.8.0
+Requires-Dist: h5py==3.15.1
+Requires-Dist: matplotlib==3.10.8
+Requires-Dist: mplcursors==0.7
+Requires-Dist: numpy==2.4.4
+Requires-Dist: pyqt6==6.10.1
+Requires-Dist: pysmithchart==0.4.1
+Requires-Dist: pyvista==0.46.4
+Requires-Dist: pyvistaqt==0.11.3
+Requires-Dist: rich==14.3.3
+Requires-Dist: scikit-rf==1.9.0
+Requires-Dist: scipy==1.16.3
+Requires-Dist: typer==0.26.8
+Requires-Dist: bump-my-version==1.4.1 ; extra == 'dev'
+Requires-Dist: myst-parser==5.0.0 ; extra == 'dev'
+Requires-Dist: prek==0.3.13 ; extra == 'dev'
+Requires-Dist: pydata-sphinx-theme==0.16.1 ; extra == 'dev'
+Requires-Dist: ruff==0.15.12 ; extra == 'dev'
+Requires-Dist: sphinx>=7.2 ; extra == 'dev'
+Requires-Dist: sphinx-automodapi==0.22.0 ; extra == 'dev'
+Requires-Dist: sphinx-copybutton>=0.5.2 ; extra == 'dev'
+Requires-Python: >=3.11
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# simpleEMS
+[![License: AGPL-3.0-or-later](https://img.shields.io/badge/License-AGPL_v3_or_later-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+[![PyPI Version](https://img.shields.io/pypi/v/project-name.svg)](https://pypi.org/project/project-name/)
+[![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org)
+
+simpleEMS is a python library built on top of [openEMS](https://openems.readthedocs.io/en/latest/) to make the design of antennas and other RF structures simpler.
+
+## Motivation
+
+This Python package provides an alternative to proprietary suites with expensive licenses or the restrictive "Student" versions such as CST, HFSS and Sonnet
+which often impose stifling mesh cell limits and memory caps. By leveraging the openEMS FDTD engine, it offers a scalable framework for simulating, optimizing, and
+visualizing complex RF designs. whether you are a professional engineer, a freelancer, or a dedicated hobbyist,
+this library will enable you to design RF circuits easily.
+
+## Key Features:
+
+### **Antenna Design**
+- Inset-Fed Patch Antenna Design
+- Probe-Fed Patch Antenna Design
+
+### **Filter Design**
+- Bandpass Quarter-Wave Filter Design
+- Bandstop Quarter-wave Filter Design
+
+### **Simulation & Optimization**
+- Parameter Sweep
+- S11 Optimization
+- S21 Optimization
+
+### **Network Parameters Calculation**
+- S11 (Reflection Coefficient)
+- S21 (Insertion Loss)
+- VSWR (Voltage Standing Wave Ratio)
+- Z11 (Input Impedance)
+- Input Power
+
+### **Visualization & Plotting**
+- Geometry Structure Visualization
+- S11 Plotting
+- S21 Plotting
+- VSWR Plotting
+- Smith Chart for S11
+- Complex Impedance (Z11) Plotting
+- 2D Radiation Pattern
+- 2D Directivity Plot
+- 3D Radiation Pattern, Gain & Power Plot
+
+### **Field Dump**
+- Field Dump for ParaView
+  - E-Field (Time and Frequency Domain)
+  - H-Field (Time and Frequency Domain)
+  - Current Density (Time and Frequency Domain)
+
+### **Export Options**
+- Gerber Export
+- STL Export
+- Touchstone SnP Export
+
+## Demo
+[This example](./examples/simple_inset_fed_patch_antenna.py) creates an inset fed patch antenna and simulates the created model.
+
+```{literalinclude} ../../examples/simple_inset_fed_patch_antenna.py
+```
+
+Below is a visualisation of the model created by the above code
+
+![patch_antenna_2_45GHz.png](./images/patch_antenna_2_45GHz.png)
+The result of the simulation
+![s11.png](./images/s11.png)
+
+![smith_chart.png](./images/smith_chart.png)
+
+![z11.png](./images/z11.png)
+
+![vswr.png](./images/vswr.png)
+
+![radiation_pattern.png](./images/radiation_polar.png)
+
+![directivity_polar.png](./images/directivity_polar.png)
+
+![3d_directivity.png](./images/3d_directivity.png)
+
+![3d_gain.png](./images/3d_gain.png)
+
+![3d_power.png](./images/3d_power_pattern.png)
+
+
+
+## Installation
+
+Refer to the installation instructions in the docs.
+

simpleems-0.1.0/README.md

@@ -0,0 +1,92 @@
+# simpleEMS
+[![License: AGPL-3.0-or-later](https://img.shields.io/badge/License-AGPL_v3_or_later-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+[![PyPI Version](https://img.shields.io/pypi/v/project-name.svg)](https://pypi.org/project/project-name/)
+[![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org)
+
+simpleEMS is a python library built on top of [openEMS](https://openems.readthedocs.io/en/latest/) to make the design of antennas and other RF structures simpler.
+
+## Motivation
+
+This Python package provides an alternative to proprietary suites with expensive licenses or the restrictive "Student" versions such as CST, HFSS and Sonnet
+which often impose stifling mesh cell limits and memory caps. By leveraging the openEMS FDTD engine, it offers a scalable framework for simulating, optimizing, and
+visualizing complex RF designs. whether you are a professional engineer, a freelancer, or a dedicated hobbyist,
+this library will enable you to design RF circuits easily.
+
+## Key Features:
+
+### **Antenna Design**
+- Inset-Fed Patch Antenna Design
+- Probe-Fed Patch Antenna Design
+
+### **Filter Design**
+- Bandpass Quarter-Wave Filter Design
+- Bandstop Quarter-wave Filter Design
+
+### **Simulation & Optimization**
+- Parameter Sweep
+- S11 Optimization
+- S21 Optimization
+
+### **Network Parameters Calculation**
+- S11 (Reflection Coefficient)
+- S21 (Insertion Loss)
+- VSWR (Voltage Standing Wave Ratio)
+- Z11 (Input Impedance)
+- Input Power
+
+### **Visualization & Plotting**
+- Geometry Structure Visualization
+- S11 Plotting
+- S21 Plotting
+- VSWR Plotting
+- Smith Chart for S11
+- Complex Impedance (Z11) Plotting
+- 2D Radiation Pattern
+- 2D Directivity Plot
+- 3D Radiation Pattern, Gain & Power Plot
+
+### **Field Dump**
+- Field Dump for ParaView
+  - E-Field (Time and Frequency Domain)
+  - H-Field (Time and Frequency Domain)
+  - Current Density (Time and Frequency Domain)
+
+### **Export Options**
+- Gerber Export
+- STL Export
+- Touchstone SnP Export
+
+## Demo
+[This example](./examples/simple_inset_fed_patch_antenna.py) creates an inset fed patch antenna and simulates the created model.
+
+```{literalinclude} ../../examples/simple_inset_fed_patch_antenna.py
+```
+
+Below is a visualisation of the model created by the above code
+
+![patch_antenna_2_45GHz.png](./images/patch_antenna_2_45GHz.png)
+The result of the simulation
+![s11.png](./images/s11.png)
+
+![smith_chart.png](./images/smith_chart.png)
+
+![z11.png](./images/z11.png)
+
+![vswr.png](./images/vswr.png)
+
+![radiation_pattern.png](./images/radiation_polar.png)
+
+![directivity_polar.png](./images/directivity_polar.png)
+
+![3d_directivity.png](./images/3d_directivity.png)
+
+![3d_gain.png](./images/3d_gain.png)
+
+![3d_power.png](./images/3d_power_pattern.png)
+
+
+
+## Installation
+
+Refer to the installation instructions in the docs.
+

simpleems-0.1.0/pyproject.toml

@@ -0,0 +1,75 @@
+[project]
+name = "simpleEMS"
+version = "0.1.0"
+description = "simpleEMS is a framework built on top of openEMS to make design and simulation of antennas and other microwave structures simpler"
+readme = "README.md"
+license = "AGPL-3.0-or-later"
+requires-python = ">=3.11"
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+]
+
+
+dependencies = [
+    "cadquery==2.8.0",
+    "h5py==3.15.1",
+    "matplotlib==3.10.8",
+    "mplcursors==0.7",
+    "numpy==2.4.4",
+    "pyqt6==6.10.1",
+    "pysmithchart==0.4.1",
+    "pyvista==0.46.4",
+    "pyvistaqt==0.11.3",
+    "rich==14.3.3",
+    "scikit-rf==1.9.0",
+    "scipy==1.16.3",
+    "typer==0.26.8",
+]
+
+[project.optional-dependencies]
+dev = [
+    "bump-my-version==1.4.1",
+    "myst-parser==5.0.0",
+    "prek==0.3.13",
+    "pydata-sphinx-theme==0.16.1",
+    "ruff==0.15.12",
+    "sphinx>=7.2",
+    "sphinx-automodapi==0.22.0",
+    "sphinx-copybutton>=0.5.2",
+]
+
+[project.scripts]
+simpleems = "simpleEMS.cli:app"
+
+[build-system]
+requires = ["uv_build>=0.11.24,<0.12"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "simpleEMS"
+module-root = ""
+
+[tool.bumpversion]
+current_version = "0.1.0"
+commit = true
+tag = true
+tag_name = "v{new_version}"
+allow_dirty = false
+message = "Bump version: {current_version} → {new_version}"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "simpleEMS/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'

simpleems-0.1.0/simpleEMS/__init__.py

@@ -0,0 +1,89 @@
+# simpleEMS
+# Copyright (C) 2026 Mohamoud Ali
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+simpleEMS — A Python library built on openEMS for simplified antenna
+and RF structure design, simulation, optimisation, and visualisation.
+"""
+
+import importlib
+
+
+_NAMES_BY_MODULE = {
+    "microstrip_line": ["MicrostripLine", "MicrostripLineParams"],
+    "patch_antenna": [
+        "InsetFedPatchAntenna",
+        "InsetFedPatchParams",
+        "ProbeFedPatchAntenna",
+        "ProbeFedPatchParams",
+    ],
+    "quarterwave_stub_filter": [
+        "QuarterWaveFilterParams",
+        "BandStopQuarterWaveFilter",
+        "BandPassQuarterWaveFilter",
+    ],
+    "standalone_model": ["simulate_model"],
+    "sim_tools": [
+        "DumpType",
+        "SimTools",
+        "optimize_s11",
+        "optimize_s21",
+        "optimize_s_params",
+        "param_sweep",
+        "setup_simulation",
+    ],
+}
+
+_NAME_TO_MODULE = {}
+
+for _module_name, _names in _NAMES_BY_MODULE.items():
+    for _name in _names:
+        _NAME_TO_MODULE[_name] = _module_name
+
+
+def __getattr__(name: str) -> object:
+    module_name = _NAME_TO_MODULE.get(name)
+    if module_name is not None:
+        module = importlib.import_module(f".{module_name}", __package__)
+        value = getattr(module, name)
+        globals()[name] = value
+        return value
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = [
+    "InsetFedPatchAntenna",
+    "ProbeFedPatchAntenna",
+    "MicrostripLine",
+    "InsetFedPatchParams",
+    "ProbeFedPatchParams",
+    "MicrostripLineParams",
+    "QuarterWaveFilterParams",
+    "BandStopQuarterWaveFilter",
+    "BandPassQuarterWaveFilter",
+    "DumpType",
+    "SimTools",
+    "setup_simulation",
+    "optimize_s11",
+    "optimize_s21",
+    "optimize_s_params",
+    "param_sweep",
+    "simulate_model",
+]
+
+__version__ = "0.1.0"
+__author__ = "Mohamoud Ali"
+__license__ = "AGPL-3.0-or-later"