API Reference

Geophysical Simulation Modules

• Potential Fields
  • Gravity Simulation (simpeg.potential_fields.gravity)
  • Magnetics Simulation (simpeg.potential_fields.magnetics)
  • Base Potential Fields
• Electromagnetics
  • Induced Polarization (simpeg.electromagnetics.static.induced_polarization)
  • DC Resistivity (simpeg.electromagnetics.static.resistivity)
  • Spectral Induced Polarization (simpeg.electromagnetics.static.induced_polarization)
  • Self Potential (simpeg.electromagnetics.static.self_potential)
  • Frequency-Domain EM (simpeg.electromagnetics.frequency_domain)
  • Natural Source EM (simpeg.electromagnetics.natural_source)
  • Time-Domain EM (simpeg.electromagnetics.time_domain)
  • Viscous Remanent Magnetization (simpeg.electromagnetics.viscous_remanent_magnetization)
  • Electromagnetics Utilities
• Fluid Flow
  • Richards Flow (simpeg.flow.richards)
• Seismic
  • Straight Ray Tomography (simpeg.seismic.straight_ray_tomography)

SimPEG Building Blocks

Base SimPEG

• Base SimPEG Classes (simpeg)
  • Simulations
    • Base Simulations
    • Base Surveys, Sources and Receivers
    • Models
    • Data
    • Fields
    • Mappings
  • Inversions
    • Objective Function Pieces
    • Optimizations
    • Base inversion pieces

Regularizations

• Regularization (simpeg.regularization)
  • Basic Theory
  • Weighted Least Squares Regularization
  • Sparse Norm Regularization
  • Vector Regularizations
  • Joint Regularizations
  • Base Regularization Classes

Optimizers

Optimizers used within SimPEG inversions.

• SimPEG Optimizers (simpeg.optimization)
  • Optimizers
  • Minimization Base Classes

Directives

• Directives (simpeg.directives)
  • General purpose directives
  • Directives to save inversion results
  • Directives related to sparse inversions
  • Directives related to PGI
  • Directives related to joint inversions
  • Base directive classes

Utilities

Classes and functions for performing useful operations.

• Utility Classes and Functions (simpeg.utils)
  • Logger
  • Counter Utility Functions
  • IO Utility Functions
  • Matrix Utility Functions
  • Mesh Utility Functions
  • Model Utility Functions
  • Plotting Utility Functions
  • PGI Utility Classes and Functions
  • Code Utility Functions

Meta

Classes for encapsulating many simulations.

• Meta SimPEG Classes (simpeg.meta)
  • Serial Simulations
  • Parallel Simulations

Typing

PEP 484 type aliases used in simpeg.

• Typing (simpeg.typing)