API Reference

Auto-generated from NumPy-style docstrings in src/geopulse/. Each module below expands to a dedicated page with all public classes, functions, and their signatures.

Top-level package

geopulse.constants	Physical constants used throughout GeoPulse.
geopulse.exceptions	Custom exception hierarchy for GeoPulse.
geopulse.types	Type aliases and custom types used across GeoPulse.
geopulse.geo	Geographic projections used for line integrals of the geoelectric field.
geopulse.config	YAML configuration loader for GeoPulse pipelines.
geopulse.cli	GeoPulse command-line interface.

B-field sources

geopulse.sources	B-field data adapters — SuperMAG, INTERMAGNET, MHD, synthetic.
geopulse.sources.base	Abstract base class for magnetic-field data sources.
geopulse.sources.synthetic	Synthetic B-field waveforms for smoke tests and controlled experiments.
geopulse.sources.intermagnet	INTERMAGNET IAGA-2002 loader.
geopulse.sources.supermag	SuperMAG CSV / ASCII loader.

Earth models & impedance

geopulse.earth	Earth conductivity models and the surface-impedance abstraction.
geopulse.earth.base	Abstract base class for Earth conductivity models.
geopulse.earth.impedance	Surface-impedance abstraction — the polymorphism spine of GeoPulse.
geopulse.earth.layered_1d	1-D layered-Earth surface impedance via Wait (1954) recursion.
geopulse.earth.library	Built-in 1-D Earth-model registry.
geopulse.earth.structured_2d	2-D structured Earth models.

Geoelectric field

geopulse.efield	Geoelectric-field synthesis: plane-wave, convolution, coastal, non-uniform.
geopulse.efield.planewave	Plane-wave geoelectric field: E(ω) = Z(ω) · B(ω) / μ₀.

Conductor networks

geopulse.network	Grounded-conductor network models.
geopulse.network.base	Abstract base class for grounded conductor networks.
geopulse.network.powergrid	Power-grid conductor network (substations + transmission lines).
geopulse.network.pipeline	Pipeline network via Distributed-Source Transmission-Line (DSTL) theory.

Circuit solvers

geopulse.solver	Circuit solvers: LPM, MNA, and PySpice bridge.
geopulse.solver.base	Abstract base class for circuit solvers.
geopulse.solver.lpm	Lehtinen-Pirjola matrix method for DC/quasi-DC GIC in earthed networks.

Devices

geopulse.devices	Nonlinear device models: transformers, rectifiers, cathodic protection.
geopulse.devices.base	Abstract base class for nonlinear device models.
geopulse.devices.transformer	Transformer thermal response — Mate et al. (2021) top-oil + hot-spot model.

Uncertainty quantification

geopulse.uq	Uncertainty-quantification utilities.
geopulse.uq.uncertain	Core uncertainty type: Uncertain[T].

I/O

geopulse.io	Data I/O: HDF5, GeoJSON, IAGA-2002.
geopulse.io.hdf5	Schema-versioned HDF5 reader/writer.
geopulse.io.matpower	MATPOWER-GMD (.m) parser for power-grid GIC test cases.
geopulse.io.iaga2002	IAGA-2002 magnetometer format parser.