gprMax User Guide

Introduction

• Getting Started
  • What is gprMax?
  • Package Overview
  • Installation
  • Running gprMax
  • Updating gprMax
  • Thanks To Our Contributors ✨🔗
• Software Features
  • What’s new/changed?
  • Key features
• Guidance on GPR modelling
  • Basic concepts
  • Coordinate system and conventions
  • Spatial discretization
  • Absorbing boundary conditions

Using gprMax

• Input file commands
  • Essential commands
  • General commands
  • Material commands
  • Object construction commands
  • Source and output commands
  • PML commands
• Output data
  • Field(s) output
  • Geometry output

Python tools

• Plotting
  • A-scans
  • B-scans
  • Antenna parameters
  • Built-in waveforms
• File utilities
  • inputfile_old2new.py
  • outputfiles_merge.py
  • convert_png2h5.py

Advanced topics

• Scripting the input file
  • Constants/variables
  • Functions for input commands
• OpenMP, MPI, and HPC
  • OpenMP
  • MPI
  • HPC job script examples
• GPGPU
  • Extra installation steps for GPU usage
  • Running gprMax using GPU(s)

User libraries

• GPR antenna models
  • Information
  • Module overview
  • How to use the module
• Antenna patterns
  • Information
  • Module overview
  • How to use the module
• AustinMan/AustinWoman
  • Information
  • Package overview
  • How to use the models
• Materials
  • Information
  • How to use the module
  • Eccosorb
• Optimisation - Taguchi’s method
  • Information
  • Package overview
  • How to use the package

Examples

• Introductory (2D) models
  • A-scan from a metal cylinder
  • B-scan from a metal cylinder
• Antenna models
  • Wire dipole antenna model
  • Bowtie antenna model
  • B-scan with a bowtie antenna model
• Advanced features
  • Building a heterogeneous soil

Help and support

• FAQs
• Screencasts & videos
  • Installation
  • Plotting
  • Visualise EM wave propagation
• Code Overview

Accuracy and performance

• Analytical comparisons
  • Hertzian dipole in free space
  • Half-wave dipole in free space
• Numerical comparisons
  • FDTD/MoM
• Performance benchmarking
  • How to benchmark?
  • Results: CPU
  • Results: GPU

Appendices

• References