GPR-MAX UI

GprMax is open-source software that simulates electromagnetic wave propagation. It solves Maxwell’s equations in 3D using the Finite-Difference Time-Domain (FDTD) method. Although it was designed initially for modeling Ground Penetrating Radar (GPR), it can also be used to model electromagnetic wave propagation for many other applications. GprMax-UI enhances this functionality by providing a high-level API for executing GprMax models, along with tools for visualization, analysis, and result interpretation.

The following video have been created using gprmaxui:

Prerequisites

• Python 3.10+
• gprMax

Install Pycuda

bash sudo apt install build-essential clang sudo apt install libstdc++-12-dev export CUDA_HOME=/usr/local/cuda export PATH=$CUDA_HOME/bin:$PATH export LD_LIBRARY_PATH=$CUDA_HOME/lib64:$LD_LIBRARY_PATH uv add pycuda --optional gpu

Install gprMax

bash git clone https://github.com/gprMax/gprMax.git sudo apt install libgomp1 sudo apt install libomp-dev python setup.py build python setup.py develop --no-deps

Installation gprMaxUI

bash pip install gprmaxui

Build the documentation

bash mkdocs build mkdocs serve -a localhost:8000

Usage

```Python from gprmaxui.commands import * from gprmaxui import GprMaxModel

Create a GPRMax model

model = GprMaxModel( title="B scan from a single target buried in a dielectric sand-space", outputfolder=Path("output"), domainsize=DomainSize(x=0.2, y=0.2, z=0.002), domainresolution=DomainResolution(dx=0.002, dy=0.002, dz=0.002), timewindow=TimeWindow(twt=3e-9), )

Register model materials

model.registermaterials( Material( id="halfspace", permittivity=6, conductivity=0, permeability=1, color="red" ) )

Register model sources

txrxsep = 2e-2 model.setsource( TxRxPair( tx=Tx( waveform=Waveform(wavefamily="ricker", amplitude=1.0, frequency=1.5e9), source=HertzianDipole(polarization="z", x=0.03, y=0.15, z=0.0), ), rx=Rx(x=0.03 + txrxsep, y=0.15, z=0.0), srcsteps=SrcSteps(dx=0.002, dy=0.0, dz=0.0), rxsteps=RxSteps(dx=0.002, dy=0.0, dz=0.0), ) )

add model geometries

box = DomainBox( xmin=0.0, ymin=0.0, zmin=0.0, xmax=0.2, ymax=0.145, zmax=0.002, material="halfspace", ) model.addgeometry(box)

cx = model.domainsize.x / 2 sphere = DomainSphere(cx=cx, cy=0.1, cz=0.0, radius=0.005, material="pec") model.addgeometry(sphere)

print(model) model.run(n="auto", geometry=True, snapshots=True)

```