API reference#
This is the public class and function reference for pycsamt.
Use the search field to find an object by name, package, or description. For
conceptual guidance and worked examples, see the User Guide.
Runtime settings and the configure_* / reset_* pattern are documented
separately in API configuration. Private objects and test modules are
not included. Each entry links to the object’s canonical generated reference;
public facade paths are used when an object is implemented in a private module.
The owning public module is shown beneath its description and is searchable;
only supported public import paths are displayed. The catalogue is rebuilt
from each subpackage’s current public exports, including the IoT field stack.
Standardised output returned by every pycsamt agent. |
|
Train an AI inverter on synthetic data then predict on observed sites. |
|
Detect anomalous (station, frequency) observations in MT data. |
|
Abstract base class for all pycsamt agents. |
|
Process multiple MT profiles through a shared agent chain. |
|
Generate a reproducible Python script from a completed workflow. |
|
Parse a natural-language MT workflow request into a structured config. |
|
Orchestrate a sequence of pycsamt agents as a named workflow. |
|
One step in an |
|
Denoise MT impedance data using classical or AI-based methods. |
|
Write processed Sites to EDI files on disk. |
|
Ensemble 1-D MT inversion with uncertainty bands. |
|
Compute the USD cost for one LLM call. |
|
Return a human-readable cost string. |
|
Run a 1-D, 2-D, or 3-D MT forward model. |
|
Select optimal periods from MT data for inversion. |
|
Return the resolved |
|
Two-stage AI + physics MT inversion. |
|
Interpret a resistivity model in terms of geological formations. |
|
2-D MT profile inversion using a U-Net convolutional architecture. |
|
3-D MT profile inversion using a graph-convolutional network (GCN). |
|
Drive pycsamt.inversion physics-based backends. |
|
|
Compare two resistivity inversion results. |
Evaluate inversion quality: RMS, residual PT, misfit section. |
|
Prepare MT data files for 2-D / 3-D inversion codes. |
|
Assess and monitor an IoT-enabled EM field acquisition. |
|
Multi-modal MT joint inversion using DRCNN. |
|
Load MT data from any pycsamt-supported format and assess quality. |
|
Orchestrate a complete MARE2DEM 2.5-D EM inversion workflow. |
|
Plain-language entry point to the agent workflows. |
|
Browse, download, and run pre-trained EM inverters from the model zoo. |
|
Write a ModEM3D MT data file from EDI sources. |
|
Generate a complete Occam2D inversion input file set. |
|
Intelligently route an NL request to the correct agent chain. |
|
Answer free-form questions about pycsamt v2. |
|
Run a full phase tensor, strike, and dimensionality survey analysis. |
|
PINN-based MT inversion without labelled data. |
|
LLM-assisted MT processing pipeline selection and interpretation. |
|
Run data quality control on a MT/AMT dataset. |
|
Generate a structured MT survey report from agent results. |
|
Build horizontal resistivity depth-slice maps from 1-D inversion results. |
|
Classify a chat message into a |
|
Bostick sensitivity kernels and vertical resolution analysis. |
|
Detect and correct galvanic static shift in MT/AMT data. |
|
Rotate impedance tensors and tipper vectors by a fixed strike angle. |
|
Analyse tipper vectors and plot induction arrows. |
|
Validate plan and optionally raise on errors. |
|
Validated intermediate representation of a workflow request. |
|
Attach a right-side colorbar to ax using |
|
Abstract base class for EM neural network estimators. |
|
Abstract base class for ML-based EM data processing tasks. |
|
Download a pre-trained checkpoint to the local cache. |
|
Lightweight context manager shorthand. |
|
Minimal checkpoint for saving/loading EM network state. |
|
Context manager that applies the shared EM plot style. |
|
Return metadata for a registered pre-trained model. |
|
Split conformal prediction wrapper for calibrated regression intervals. |
|
Gaussianization normalising flow for calibrated posterior sampling. |
|
Deep ensemble of |
|
1-D EM neural-network inverter. |
|
U-Net–based 2-D MT inversion estimator. |
|
Graph-convolutional 3-D MT inversion estimator. |
|
Multi-modal joint inversion estimator based on DRCNN. |
|
Return a dict of available pre-trained models. |
|
Factory wrapper — call |
|
Factory wrapper for the Dense Residual CNN. |
|
Factory wrapper for the fully-convolutional 1-D EM network. |
|
Build a symmetric adjacency matrix from 2-D station coordinates. |
|
Factory that builds a PyTorch or TensorFlow GCN. |
|
Factory wrapper for the 1-D residual CNN. |
|
Factory wrapper for the 2-D U-Net. |
|
Multi-panel comparison of true and predicted 1-D resistivity profiles. |
|
Plot a single true/predicted resistivity–depth pair on ax. |
|
Plot train / validation loss curves from a trainer history dict. |
|
Standalone learning-rate schedule plot. |
|
Plot a confusion matrix for a classification model. |
|
Horizontal bar chart of feature importances. |
|
Per-layer mean absolute error bar chart. |
|
Scatter plots of predicted vs. true for each model parameter. |
|
1-D prediction curve with uncertainty bands. |
|
Apparent-resistivity or phase pseudo-section plot. |
|
Plot a 2-D resistivity section. |
|
Side-by-side comparison of true and predicted 2-D resistivity sections. |
|
Profile-level unsupervised anomaly detector. |
|
MLP classifier for MT data dimensionality (1-D / 2-D / 3-D). |
|
Convolutional autoencoder for MT impedance tensor denoising. |
|
Extract an impedance feature array from a site collection. |
|
ML-based per-frequency QC scorer for MT impedance data. |
|
Randomly zero-out a fraction of frequency channels. |
|
Mixup augmentation (Zhang et al. 2018). |
|
Add multiplicative log-Gaussian noise to feature amplitudes. |
|
Apply a random static shift to amplitude features. |
|
Sequentially apply a list of augmenters. |
|
Apply an augmenter with probability p. |
|
PyTorch |
|
Z-score normaliser that handles NaN values. |
|
RMSE on the resistivity sub-vector only (first |
|
Per-column RMSE vector. |
|
Mean absolute error, ignoring NaN. |
|
MSE loss that ignores |
|
Coefficient of determination R², ignoring NaN. |
|
Normalised RMSE: |
|
Root mean square error, ignoring NaN. |
|
Compute all scalar metrics and return as a dict. |
|
Training loop manager for EM 1-D inversion networks. |
|
Global LLM configuration singleton for all pycsamt agents. |
|
Raised when an LLM call would be made after the session budget is used. |
|
Configure |
|
Reset |
|
Build / processing execution settings. |
|
Configure |
|
Logging / verbosity settings. |
|
Output format and destination settings. |
|
Package-wide CLI configuration container. |
|
Reset |
|
Attach verbose, no-color, format, and output-dir to a command. |
|
A Click Path type for a directory that contains EDI files. |
|
A Click Path type that additionally requires a |
|
Parse a |
|
Parse a comma-separated list of station identifiers. |
|
Configure |
|
Control the 1-D frequency/period axis. |
|
Control how phase values are wrapped and displayed. |
|
Package-wide plotting-view control container. |
|
Reset |
|
Control apparent-resistivity display scale. |
|
Wrap phase values into |
|
Add the text, JSON, or CSV output-format option to a Click command. |
|
Configure |
|
Visual parameters for 1-D hydrogeophysical profile plots. |
|
Visual parameters for 2-D hydrogeophysical colour sections. |
|
Complete visual bundle for one hydrogeophysical interpretation preset. |
|
Package-wide visual control container for hydro-geophysical plots. |
|
Reset |
|
Activate a named preset in |
|
Add the positive |
|
Add the |
|
Add the |
|
Add the writable |
|
Add the |
|
Configure the global |
|
Runtime configuration for the pyCSAMT pipeline engine. |
|
Reset |
|
(Re-)load a config file into |
|
Global plot-export configuration singleton for pyCSAMT. |
|
Reset |
|
Save a pyCSAMT figure using the global |
|
Set the global raster DPI on |
|
Set the global export format(s) on |
|
Set the global output directory on |
|
Write a template config file with the current |
|
Small mixin for attaching free-form object metadata. |
|
Root object for lightweight pyCSAMT API behavior. |
|
Visual style bundle shared by all pycsamt rose diagram functions. |
|
Configure |
|
Package-wide section-view control container. |
|
Reset |
|
Axis behavior for section-like plots. |
|
Colorbar geometry and tick-density controls. |
|
Figure geometry for section-like plots. |
|
Complete visual-control bundle for one section preset. |
|
Configure |
|
Package-wide station rendering control container. |
|
Reset |
|
Station-axis tick, label, and marker configuration. |
|
Marker style used to draw stations along a profile axis. |
|
Configure |
|
Consistent before/after visual pair for any 1-D correction workflow. |
|
Consistent colours and markers for MT impedance components and modes. |
|
Gradient-first coloring for multi-line (multi-station / multi-profile) plots. |
|
Visual style for phase-tensor ellipse plots (psection, map, summary). |
|
Global visual-style container for pyCSAMT. |
|
Visual style for raw, unprocessed EM observations. |
|
Reset |
|
Apply a named full-package style preset to |
|
Add the repeatable |
|
Package-wide policy for dataframe-like public API views. |
|
Configure the global API view backend. |
|
Reset the global API view backend. |
|
Decorate a function so dataframe-like returns become |
|
A pyCSAMT dataframe view that keeps pandas behavior intact. |
|
Small immutable profile describing a dataframe. |
|
Conditionally wrap data as an |
|
Wrap dataframe-like data using the configured API view backend. |
|
Read one EDI file and return an |
|
Read many EDI files and return a public survey view. |
|
Alias for |
|
Yield items, optionally wrapped by |
|
Return whether progress should be displayed. |
|
Configuration for terminal progress display. |
|
Container for named result parts, including one or more tables. |
|
Wrap a mapping of result parts as an |
|
Friendly public facade over an |
|
Return a public APIFrame for a geology catalog. |
|
Alias for |
|
Return a public APIFrame wrapper around metadata quality rows. |
|
Alias for |
|
Return a public APIFrame wrapper around |
|
Detect the best available backend and activate it. |
|
Return a list of available deep-learning backends. |
|
Return the name of the currently active backend. |
|
Return the concrete |
|
Return version strings for installed backends. |
|
Return availability status for all known backends. |
|
Return |
|
Set the active AI backend. |
|
Minimal base class for PyCSAMT objects and mixins. |
|
Common electromagnetic and MT utilities. |
|
Lightweight, neutral payload for transfer functions. |
|
Dispatch |
|
Context manager for temporary configuration overrides. |
|
Update configuration fields with validation. |
|
Global configuration container for |
|
Return the adapter factory for a key. |
|
Return the live |
|
List registered adapters with readable names. |
|
Register a format adapter that yields an EDI object or collection. |
|
Reset the global configuration to factory defaults. |
|
Rules to validate and synthesize station names. |
|
Serialize the current configuration to a plain dict. |
|
Disk-backed |
|
Best-effort classification for common MT/EM artefacts. |
|
Container mapping record ids to |
|
Interface for loading and saving |
|
Build a |
|
Mixin for containers of items that implement |
|
Mixin for single items convertible to and from bundles. |
|
A single registry item with identifiers and metadata. |
|
High-level helper to manage a file-backed registry. |
|
Return the registered packer for |
|
List available packers as a mapping of kind to signatures. |
|
Serialize an object to |
|
Register a serializer/deserializer pair for a given |
|
Convenience façade over |
|
Deserialize an object from |
|
Error raised for registry and manifest operations. |
|
Template utilities for AVG/J -> EDI transformations. |
|
Per-frequency anisotropy metrics for a set of CSAMT sites. |
|
Per-station summary of anisotropy metrics. |
|
Plot anisotropy metric pseudo-section (station × frequency). |
|
Bostick depth estimate per station per frequency from measured data. |
|
Bostick depth estimate D(f) from apparent resistivity. |
|
Summary depth-coverage statistics per station. |
|
Invert the Bostick formula: return the frequency (Hz) that maps to a given depth for a background resistivity rho. |
|
Design a CSUMT frequency schedule that samples a set of target depths. |
|
Pseudosection of Bostick depth across stations and periods/frequencies. |
|
Vertical resolution ΔD between adjacent frequencies per station. |
|
Vertical resolution ΔD between two adjacent frequencies. |
|
Empirical coverage fraction of a prediction interval (kouadio2025 eq. |
|
Per-station coverage summary. |
|
Polar coverage plot: angle ∝ log₁₀(f), radius ∝ ρ_a,obs. |
|
Polar rose diagram of relative residuals (ε = (ρ_pred − ρ_obs)/ρ_obs × 100 %). |
|
Mean relative interval width per frequency band (horizon-drift analogue). |
|
Per-frequency coverage of observed ρ_a within predicted quantile bounds. |
|
Per-frequency relative error between observed and predicted ρ_a. |
|
Summarise dimensionality and strike checks before 2-D inversion. |
|
Normalize arbitrary user input to a |
|
Classify CSAMT measurement zones per station per frequency. |
|
Near-field correction factor for apparent resistivity (equatorial HED). |
|
Pseudosection of CSAMT field zones across stations and frequencies. |
|
Drop rows whose frequency confidence is below |
|
Edit frequency rows and return diagnostics in one workflow. |
|
Return one row per original station-frequency edit decision. |
|
Summarize station-level changes after frequency editing. |
|
Container returned by confidence-based frequency editing. |
|
Set low-confidence frequency rows to NaN without changing the grid. |
|
Plot dropped, masked, recovered, and kept frequency decisions. |
|
Plot station-level before/after frequency-edit summary. |
|
|
Recover recoverable frequency rows using trusted neighboring rows. |
Remove fitted Groom-Bailey galvanic distortion from impedance tensors. |
|
Estimate, and optionally apply, Groom-Bailey distortion correction. |
|
Estimate Groom-Bailey-style galvanic distortion parameters. |
|
Container returned by |
|
Pseudo-section of a gradient apparent resistivity quantity. |
|
Vertical (log-frequency) apparent resistivity gradient. |
|
Joint vertical-transverse apparent resistivity gradient. |
|
Transverse (along-line) apparent resistivity gradient. |
|
Full four-component impedance tensor + tipper response for one station. |
|
Draw a period-vs-station pseudosection. |
|
Plot raw or processed 1-D rho/phase panels by station. |
|
Plot impedance response panels with station-level tipper rows. |
|
Compute the composite confidence ratio from diagnostic scores. |
|
Return frequency-level confidence scores for EM stations. |
|
Overlay lower and upper noise envelopes on an existing period axis. |
|
Highlight gaps in spectral coverage on an existing QC plot. |
|
Plot line-wide confidence statistics for each period sample. |
|
Profile confidence-ratio (CR) scatter plot along the survey line. |
|
Plot cross-station response consistency as a fan diagram. |
|
Plot frequency coverage and data availability as a pseudosection. |
|
Plot frequency confidence as a station-period pseudo-section. |
|
Create a compact multi-panel quality-control summary for a survey. |
|
Plot the distribution of signal-to-noise ratios across survey data. |
|
Plot a 2-by-3 confidence dashboard for one station. |
|
Plot confidence components versus period for one station. |
|
Map XY/YX crossover behaviour across stations and frequencies. |
|
Return station-level confidence scores for EM transfer functions. |
|
Apply one EMAP-style spatial filter to MT/AMT sites. |
|
Apply EMAP filtering only as strongly as confidence requires. |
|
Remove static shift via Hanning adaptive moving-average (AMA) spatial filter. |
|
Drop Z (and tipper) rows at user-specified frequencies. |
|
Summarize station-level changes after an EMAP-style filter. |
|
Container returned by confidence-gated EMAP filtering. |
|
Apply a fixed-length EMAP moving average along a profile. |
|
Remove frequency-domain outliers with a sliding Hampel filter. |
|
Mask frequencies that fail the requested cross-station SNR vote. |
|
Suppress mains-frequency harmonics in impedance and tipper data. |
|
Plot denoising changes in off-diagonal impedance as a pseudosection. |
|
Plot harmonic-noise reduction by station and mains harmonic. |
|
Plot the station-by-station SNR gain produced by denoising. |
|
Compare raw and denoised off-diagonal curves for one station. |
|
Plot a before/after EMAP filter station profile. |
|
Plot before/after/delta pseudo-sections for an EMAP filter. |
|
Smooth apparent resistivity and phase trends, then rebuild |
|
Apply a trimmed EMAP moving average along a profile. |
|
Resolve style to a |
|
Visual style bundle shared by all pycsamt rose diagram functions. |
|
Normalised array factor AF_n for an N-element linear PAS (eq. |
|
Inter-element phase shift β [rad] to steer the main lobe to θ_m (eq. |
|
Total normalised far-field pattern of an N-element PAS. |
|
Plot one or more radiation patterns in polar or Cartesian format. |
|
2-D horizontal-plane directivity D₀ = 2π U_max / ∫ U(θ) dθ (eq. |
|
Far-field element pattern for a single finite-length SDAS (eq. |
|
SNR improvement of an N-element PAS relative to a single SDAS [dB]. |
|
All main-lobe broadside angles [degrees] for the given PAS configuration. |
|
Effective real wavenumber k [m⁻¹] for CSAMT or free-space propagation. |
|
Correct impedance tensor for CSAMT near-field contamination. |
|
Per-frequency source overprint β index for a set of CSAMT sites. |
|
Normalized apparent resistivity and subtracted phase (Wang & Lin 2023). |
|
Ground-wave / surface-wave amplitude ratio β_Ey (%). |
|
Pseudosection of normalized ρ_a and subtracted phase (Wang & Lin 2023). |
|
Plot source overprint β pseudo-section (station × frequency). |
|
Per-station summary of source overprint metrics. |
|
Return a new |
|
Compute the inter-channel coherence matrix. |
|
Inter-channel squared coherence as a tidy DataFrame. |
|
Boolean mask of frequencies with sufficient coherence. |
|
Plot squared coherence for selected channel pairs. |
|
Pseudo-section of coherence across stations (station × period). |
|
Plot the power spectral density per channel. |
|
Pseudo-section of PSD across stations (station × period). |
|
Visualise the full cross-spectral density matrix at one frequency. |
|
Plot the induction tipper magnitude and phase from spectra. |
|
Plot apparent resistivity and phase recovered from spectra. |
|
Power spectral density per channel as a tidy DataFrame. |
|
Signal-to-noise ratio estimated from squared coherence. |
|
Compact per-frequency summary table. |
|
Apply pre-computed static-shift correction factors to sites. |
|
Correct static shift by the AMA method. |
|
Detect and classify near-surface distortion in CSAMT/MT apparent resistivity curves. |
|
Estimate AMA static-shift correction factors. |
|
Estimate static-shift factors via bilateral filtering. |
|
Estimate static-shift factors via locally-weighted regression (LOESS). |
|
Estimate static-shift factors via reference-median method. |
|
Bar chart of the NS index per station, colored by distortion type. |
|
Per-station 1-D apparent-resistivity curves: before and after correction. |
|
Two- or three-panel pseudo-section comparison for static-shift correction. |
|
Plot per-station static-shift correction amplitudes as a bar chart. |
|
Plot pseudosection of static-shift change (corrected minus original). |
|
Plot apparent resistivity against period on a polar grid. |
|
Plot before-and-after apparent-resistivity curves for a single station. |
|
Four-panel summary figure for static-shift correction. |
|
Correct sites for static shift and plot a comparison pseudo-section. |
|
Estimate correction and plot per-station shift profile. |
|
Estimate static-shift correction and plot delta pseudosection. |
|
Estimate correction and plot before/after curves for one station. |
|
Three-panel rose diagram: Strike (Z), PT Azimuth, and Tipper Strike. |
|
Publication-quality rose diagram of geoelectric strike direction. |
|
Publication-quality phase-tensor map at a single period. |
|
Phase-tensor ellipse pseudo-section (Caldwell et al. 2004 style). |
|
Publication-quality phase-tensor θ rose diagram. |
|
Single-station phase-tensor ellipse strip vs period. |
|
Phase-tensor ellipse strips for several stations, grouped by profile. |
|
Geoelectric-strike director field over station and period. |
|
Phase-tensor θ rose grid — one pycsamt-styled rose per frequency decade. |
|
2×2 panel: Parkinson/Wiese × Real/Imaginary conventions. |
|
Map-view induction arrows at one period. |
|
Map-view induction arrows from |
|
Stacked multi-period induction vector map. |
|
Rose diagram of induction arrow azimuths (all stations & periods). |
|
Rose diagram of induction arrow directions from Spectra objects. |
|
Period × station pseudo-section coloured by |T| magnitude. |
|
Polar view: tipper azimuth (angle) and magnitude (radius) vs period. |
|
Polar tipper from a |
|
General ZError. |
|
Numpy container for a batch of (features, targets) EM samples. |
|
Generate a batch of synthetic (data, model) pairs for ML training. |
|
Generate a pseudo-3D synthetic dataset for |
|
Numpy container for a pseudo-3D multi-station survey dataset. |
|
Collect settings that define a 1-D forward modelling / dataset run. |
|
Collect settings for a 2-D MT finite-difference forward run. |
|
Collect settings for a quasi-3D MT forward modelling run. |
|
1-D controlled-source AMT forward solver. |
|
Container for the output of a 1-D forward solver. |
|
1-D magnetotelluric forward solver (plane-wave, isotropic earth). |
|
1-D central-loop TEM forward solver (step-off waveform). |
|
Output of the 2-D MT forward solver. |
|
2-D magnetotelluric finite-difference forward solver. |
|
Full (approximate) impedance tensor from the 3-D MT forward solver. |
|
Quasi-3D magnetotelluric forward solver. |
|
Non-uniform 2-D finite-difference grid for MT forward modelling. |
|
Return cell widths for one padding strip. |
|
Non-uniform 3-D finite-difference grid for MT forward modelling. |
|
Convenience wrapper: add Gaussian noise at a given relative level. |
|
Apply a named or pre-built noise model to a forward response. |
|
Frequency-dependent noise model for MT/CSAMT training data. |
|
Add relative Gaussian noise to an EM forward response. |
|
Log-space (multiplicative) Gaussian noise. |
|
Plot one or more 1-D layered earth models as resistivity-depth profiles. |
|
Plot the 2-D resistivity model on a colour map. |
|
Three orthogonal slice panels for a 3-D resistivity model. |
|
Plot a 2-D MT pseudo-section (period × station distance). |
|
Plot 1-D MT/CSAMT apparent resistivity and phase vs period (or frequency). |
|
3-panel figure combining model depth profile, ρ_a, and phase. |
|
Map-view scatter of ρ_a or phase at one frequency. |
|
Plot ρ_a (or phase) vs station distance at selected frequencies. |
|
Period × station pseudo-section for one 3-D response component. |
|
2 × 2 map panel showing all four impedance tensor components. |
|
1-D layered earth model. |
|
Borehole / well log with depth-interval data. |
|
A single depth interval in a borehole log. |
|
Constrain a 2-D EM resistivity model with borehole TRES values. |
|
Calibrate petrophysical parameters to match hydrogeological field data. |
|
Electrical conductivity of formation water (e.g., from an EC log or sample). |
|
Transmissivity (and optionally storativity) from a pumping test. |
|
Hydraulic conductivity K from a slug test or bail test. |
|
Piezometer or well water-level measurement. |
|
Metadata about a completed fusion operation. |
|
Fuse two EM resistivity models onto a single depth grid. |
|
Contiguous aquifer-favourable interval at one station/profile column. |
|
Hydrogeological interpretation product for one resistivity model. |
|
Rule-based hydrogeophysical interpreter for EM resistivity sections. |
|
One classified hydrogeophysical cell. |
|
Quantitative hydrogeological model from an EM resistivity section. |
|
Quantitative hydrogeological output of one EM resistivity section. |
|
All petrophysical and hydraulic parameters needed by |
|
One geological unit in a pseudo-stratigraphic log. |
|
Extensible rock physics database for EM resistivity interpretation. |
|
A single entry in the rock physics database. |
|
Per-station pseudo-stratigraphic depth profile. |
|
Unified 2-D resistivity model container. |
|
Raise |
|
Time-lapse EM analysis for hydrogeological change detection. |
|
Monte Carlo uncertainty propagation for a quantitative EM hydro model. |
|
Prior distribution specification for Monte Carlo sampling. |
|
Ensemble statistics from a |
|
Return registered backend names. |
|
Return the backend class for name using lazy imports. |
|
Source-of-truth configuration for |
|
Normalized EM observation container. |
|
Build a 1-D TensorMesh-like object and positive-downward centres. |
|
Build a 3-D TensorMesh-like object around station coordinates. |
|
Build the finite-difference 2-D grid used by built-in inversion. |
|
Expand a layered starting model into a 2-D core resistivity grid. |
|
Return geometrically growing positive depth cell widths. |
|
Lightweight mesh/grid descriptor. |
|
Starting or recovered layered-earth model. |
|
Built-in 1-D MT inversion workflow. |
|
Built-in stitched 2-D MT inversion workflow. |
|
ModEM 3-D MT inversion workflow. |
|
SimPEG 3-D MT inversion workflow. |
|
Return errors for one data component using config settings. |
|
Return a boolean mask for one component using config mask settings. |
|
Build an |
|
Component-aware data-error settings for inversion backends. |
|
Return the pyGIMLi lambda value using shared option names. |
|
Backend-neutral regularization settings. |
|
Build backend-neutral controls from a config object. |
|
Return unweighted residual terms for smooth/damped/blocky penalties. |
|
Return the scalar penalty weight for least-squares backends. |
|
Common convergence-history container. |
|
Backend-neutral post-inversion result. |
|
Backend-neutral uncertainty and sensitivity diagnostics. |
|
Execute a configured EM inversion backend. |
|
Run an inversion in one call. |
|
Container of un‐modifiable I/O settings and lookup tables. |
|
Read a table‐like file into a pandas object using the Config parser map. |
|
Write a pandas‐like object to disk using Config writers. |
|
Assemble an in-memory |
|
Seed a |
|
Return an EDI-survey summary as a pyCSAMT table. |
|
Route IoT-acquired impedance through |
|
Seed a |
|
Build per-station EDIs from a session plus impedance estimates. |
|
Build a |
|
Read an EDI survey into per-station summary records. |
|
Write an impedance tensor to a |
|
Return an EDI-backed |
|
Return one row per device describing declared IoT capabilities. |
|
Survey-level IoT deployment metadata. |
|
Configuration for one field IoT node or recorder gateway. |
|
Role of an IoT device in a field deployment. |
|
IoT capability flags used in deployment reports. |
|
Telemetry packet categories used by pyCSAMT IoT workflows. |
|
A timestamped message emitted by an IoT-enabled field node. |
|
Return one row per channel from edge-processing results. |
|
Quality-control summary for one edge data channel. |
|
Acceptance state assigned by edge-side quality control. |
|
Configuration for lightweight field-side processing. |
|
Summary returned by |
|
Small edge-processing block for telemetry payload reduction. |
|
Run the core AMT edge diagnostics on one channel and collate them. |
|
Flatten one or more |
|
Assess the stability of per-window impedance estimates. |
|
Detect ADC clipping / saturation in a channel. |
|
Proxy assessment of electrode contact quality. |
|
Return |
|
Detect mains-frequency harmonics in a time series. |
|
Detect NaN gaps and stuck-value (flatline) runs in a channel. |
|
Estimate channel SNR in decibels. |
|
Estimate the resolvable frequency band of a recording. |
|
Flag a static shift between the two apparent-resistivity modes. |
|
Result of |
|
Contamination measured at one powerline harmonic. |
|
Result of |
|
Result of |
|
Result of |
|
Assess transmitter current (and optional voltage) steadiness. |
|
Classify each frequency as near, transition, or far field. |
|
Run the core CSAMT edge diagnostics on one channel and collate them. |
|
Flatten one or more |
|
Check that recorded energy is present at each transmitted frequency. |
|
Wave-propagation regime of a CSAMT measurement at one frequency. |
|
Result of |
|
Electromagnetic skin depth in metres. |
|
Detection result for one expected transmitter frequency. |
|
Result of |
|
Result of |
|
Run the CSEM offset-domain diagnostics for one frequency. |
|
Flatten one or more |
|
Build a magnitude/phase-versus-offset curve and QC it. |
|
Result of |
|
Return the |
|
Canonical acquisition characteristics for one EM method. |
|
Return per-decade sub-bands spanning a method's frequency band. |
|
Convenience wrapper around |
|
Electromagnetic survey methods recognised by IoT monitoring. |
|
Return monitoring statuses as a pyCSAMT table. |
|
Thresholds used to monitor AMT/MT/CSAMT telemetry streams. |
|
Overall status level for a monitored telemetry stream. |
|
Status returned by |
|
Return telemetry packets as a pyCSAMT table. |
|
Summarise telemetry packet counts by device and topic. |
|
Monitor field telemetry from AMT, MT, CSAMT, and related surveys. |
|
Plot edge quality-control decisions and channel metrics. |
|
Plot a compact IoT acquisition dashboard. |
|
Plot IoT energy budget, runtime, and power-state summaries. |
|
Plot clock offset, drift, jitter, GPS lock, and quality grades. |
|
Named power profile for a field node or recorder. |
|
Power-budget inputs for a field IoT device. |
|
Estimated runtime and power draw. |
|
Estimate and tabulate energy budgets for multiple devices. |
|
Estimate runtime from battery, duty cycle, and optional solar input. |
|
Return energy estimates as a pyCSAMT table. |
|
Energy status for an IoT field device. |
|
Common behaviour for telemetry transports. |
|
Supported telemetry protocol identifiers. |
|
Acknowledgement returned by a telemetry client. |
|
Generic recorder used for dry-run simulation and unmapped protocols. |
|
Raised when a telemetry transport operation fails. |
|
Construct a telemetry client for protocol. |
|
Append/replay telemetry packets to a JSON-lines file. |
|
POST telemetry packets to an HTTP(S) endpoint. |
|
Publish/subscribe telemetry over MQTT. |
|
Send/receive telemetry over a serial port. |
|
Wrap a telemetry client with a persistent offline send buffer. |
|
Send/receive telemetry over a WebSocket connection. |
|
Reproducible manifest describing one IoT acquisition session. |
|
Assemble an |
|
Build an acquisition manifest and write it to path. |
|
Write a manifest and per-station audits into out_dir. |
|
Write a single-station provenance audit to path (JSON). |
|
Return the hex digest of data using algo. |
|
Return a tamper-evident hash chain over entries. |
|
Return a stable hash of mapping (key-sorted JSON, UTF-8). |
|
Hash a raw acquisition file and return its integrity record. |
|
Return a normalised QC-decision record for the audit trail. |
|
Per-station occupation provenance for one field session. |
|
Return an HMAC signature over the canonical JSON of mapping. |
|
Return whether a |
|
Verify a signed manifest produced by |
|
Return whether signature is a valid HMAC of mapping under key. |
|
Metadata describing one raw acquisition record/window. |
|
Discrete field event (state change, alarm, operator note). |
|
Severity levels for event telemetry. |
|
Device-health telemetry (battery, temperature, link quality). |
|
Parse payload into the schema registered for kind. |
|
Energy-budget telemetry for a field node. |
|
Edge quality-control telemetry for one acquisition window. |
|
Return the payload schema registered for kind. |
|
Transmitter telemetry for a controlled-source (CSAMT/TDEM) survey. |
|
Clock-synchronisation telemetry for a field node. |
|
Base class for canonical telemetry payloads. |
|
Return a canonicalised payload dictionary for kind. |
|
Supported authentication schemes. |
|
Authentication credential with secret redaction. |
|
Return a redaction placeholder when value is a non-empty secret. |
|
Combined TLS + credential policy for telemetry transports. |
|
Transport-layer security material for a telemetry client. |
|
Stateful container for one IoT-enabled field acquisition session. |
|
Simulate one AMT channel: band-limited signal + noise + artefacts. |
|
Simulate a full AMT station: config, channel data, and packets. |
|
Simulate a monotonic-ish battery discharge curve with noise. |
|
Simulate paired reference/local clocks with drift, jitter, dropout. |
|
Simulate a network of AMT stations across one or more profiles. |
|
Return packets with a fraction randomly dropped. |
|
Return a powerline-noise time series (fundamental + harmonics). |
|
Return one row per station describing its acquisition metadata. |
|
Geospatial and acquisition metadata for one field station. |
|
Grade synchronisation from offset, drift, jitter, and GPS lock. |
|
Assess many devices at once and return a status table. |
|
Evaluate device clock status against a reference. |
|
Summarise GPS-lock dropouts across a sample sequence. |
|
Estimate clock drift in parts-per-million. |
|
Estimate timing jitter as the std of drift-corrected offsets (ms). |
|
Estimate median local-reference clock offset in milliseconds. |
|
Return one row per device from sync-status objects. |
|
Clock-synchronisation tolerances. |
|
Overall synchronisation grade for a device. |
|
Clock-synchronisation status for one device. |
|
Abstract base for J-format data blocks. |
|
Container for a sequence of parsed J data blocks. |
|
Resistivity/phase (R/S) block implementation. |
|
One parsed resistivity/phase row of a J R/S block. |
|
Transfer-function (Z/Q/C/T) block implementation. |
|
One parsed transfer-function row of a J Z/Q/C/T block. |
|
Minimal stateful base for collections of J files. |
|
Core scanner for J files that extracts light metadata. |
|
Lightweight helpers for scanning Jones J-format text. |
|
High-level collection of Jones J-format files. |
|
Mixin that provides folder/glob expansion and robust parsing orchestration for Jones J-format collections. |
|
Lightweight facade to manage Jones (J-format) components on a host object. |
|
Parse and serialize the top provenance comment line. |
|
Parse and serialize a single J-format head triple. |
|
Mixin that provides a |
|
Minimal container for one |
|
Parse and serialize the J-format information block. |
|
Mixin that provides an |
|
High-level J dispatcher for MT/SEG archives. |
|
Tolerant BLOCK parser and TF/R/Tipper builder. |
|
Lightweight helpers shared by J-format readers. |
|
Container for site properties parsed from J-format info. |
|
Yield lines from a path, file‑like, or a sequence of strings. |
|
Parse a data‑type line like |
|
Convenience wrapper around |
|
Abstract base for A.G. |
|
Return a parsed impedance component specification. |
|
Parsed impedance component request. |
|
Options used by figure export helpers. |
|
Options for pseudosection and profile-view maps. |
|
Options for 2-D station maps. |
|
Options for 3-D fence, block, and depth-slice maps. |
|
Return normalized map data. |
|
Export fig according to options. |
|
Return a serializable figure dictionary. |
|
Save a Matplotlib-like or Plotly-like figure as PNG. |
|
Write a figure dictionary as JSON text. |
|
Write a Plotly-like figure to HTML. |
|
Write a Plotly-like image. |
|
Write a Plotly-like figure specification as JSON. |
|
Nearest-frequency selection metadata. |
|
Station value and selected-frequency metadata. |
|
Group ModEM station names into survey lines. |
|
Load a ModEM 3-D inversion result folder as a multi-line MapData. |
|
Launch the interactive map-view app. |
|
Alias for |
|
Build one combined |
|
Return a |
|
Normalized survey data shared by map renderers. |
|
Return the canonical map component name. |
|
Loosely-normalized station id for fuzzy matching. |
|
Backward-compatible alias for |
|
Resolve a style name into a (base style, raster layers) pair. |
|
Plotly geographic map layout settings. |
|
Return layout settings for geographic station maps. |
|
Build an interpolated map contour overlay. |
|
Render a Surfer-style filled-contour PNG for a basemap image layer. |
|
Build a reusable profile-line overlay trace. |
|
Build a reusable station-label overlay trace. |
|
Build a Plotly 3-D terrain mesh or surface. |
|
Coordinate transform settings. |
|
Interpolate scattered values to a regular grid. |
|
Return an EPSG authority string. |
|
Reproject x, y from epsg to WGS84 lon/lat. |
|
Return a human-readable CRS description. |
|
Transform coordinates between two CRS definitions. |
|
Build the concrete profile-view figure. |
|
Build the concrete pseudosection figure. |
|
Build a profile-view map. |
|
Build a resistivity or phase pseudosection. |
|
Builder object for profile maps. |
|
A named sequence of stations in one profile. |
|
Select the closest finite positive frequency. |
|
Build a Plotly 2-D station map. |
|
Build a 2-D station map. |
|
Builder object for station-map figures. |
|
A normalized station row used by map renderers. |
|
Return a copy of data with station elevations overridden. |
|
Export station id/elevation/coordinates to CSV or HDF5. |
|
Fetch station elevations online from their coordinates. |
|
Parse an uploaded elevation file into |
|
Return values with selected-frequency metadata. |
|
A code-first session bound to one (multi-line) survey. |
|
Build the concrete 3-D figure. |
|
Builder object for 3-D survey maps. |
|
Build a 3-D map. |
|
Build a 3-D volume map. |
|
Copyright and usage conditions. |
|
Return all bands in the registry that contain f Hz. |
|
Return the skin-depth DOI estimate in metres at frequency f. |
|
Return |
|
Specification of an EM geophysical frequency band. |
|
Add or replace a |
|
A named geological scenario for layered-Earth modelling. |
|
Return a |
|
Registry of geological formations for layered-Earth modelling. |
|
Structured descriptor for an EM acquisition system. |
|
Shortcut for |
|
Return sorted list of available preset keys. |
|
Specification for a single sensor (magnetic or electric). |
|
Person contact information. |
|
Compute |
|
Quality metrics for a single impedance component. |
|
Data-quality summary for a single MT station. |
|
Return a |
|
Data-quality classification for one component or a whole station. |
|
Bibliographic reference information. |
|
Access and query geological rock metadata: |
|
Software metadata. |
|
Geographic bounding box in decimal degrees (WGS-84 default). |
|
Campaign-level descriptor for an MT/AMT/CSAMT/TEM survey. |
|
Return a sorted list of distinct step categories. |
|
Return the |
|
Return all available |
|
Return all registered |
|
Parse a JSON pipeline config file and return the raw dict. |
|
Import a Python config file and return its |
|
Parse a YAML pipeline config file and return the raw dict. |
|
Return the |
|
An ordered, configurable MT processing pipeline. |
|
Base class for pyCSAMT pipeline objects. |
|
Return value of |
|
Create a compact dashboard for a completed pipeline run. |
|
Plot per-step success status for a pipeline run. |
|
Plot elapsed time per pipeline step. |
|
Plot station counts entering and leaving each pipeline step. |
|
A named, ordered collection of pipeline steps. |
|
Return a formatted catalogue of all presets. |
|
A configured pipeline step. |
|
Return a sorted list of all step codes. |
|
Return a sorted list of all step names. |
|
Immutable record produced after one pipeline step runs. |
|
Immutable descriptor for one pipeline step. |
|
Return the |
|
Return all |
|
Execute a named Stratagem preset in one call (convenience wrapper). |
|
Return a formatted catalogue of all Stratagem presets. |
|
A |
|
Named configuration bundle for |
|
|
|
High–level EDI dispatcher for SEG/EMAP/CSAMT archives. |
|
Lightweight registry and helpers used by EDI readers. |
|
Tolerant |
|
Reader/writer for generic |
|
Header container for |
|
Container for |
|
Read and write |
|
Minimal container for the |
|
Profile helper for one or many |
|
Lightweight table view for station metadata derived from |
|
Elevation profile helper. |
|
|
Container for |
Minimal container for the |
|
Reader and writer for |
|
Abstract base for SEG-EDI validation helpers. |
|
Build a multi-site xarray Dataset from an iterable of EDIFile. |
|
An xarray accessor for convenient interaction with EDI datasets. |
|
A mixin that adds convenient xarray exports to collection classes. |
|
Normalize heterogeneous EM sources into a common form. |
|
Create and return a |
|
Context-managed capture of key transformation outputs. |
|
Create and return a |
|
High-level wrapper for a single MT/CSAMT site backed by an |
|
Lightweight wrapper exposing station-centric accessors and utilities for a single |
|
Container for multiple |
|
Unwrap site-like inputs to raw EDI objects. |
|
Estimate phase slopes within a frequency band. |
|
Evaluate apparent resistivity at a target frequency. |
|
Estimate a strike angle from impedance tensors. |
|
Summarize or tabulate tipper magnitudes. |
|
Replace missing or non-finite values in Z and/or tipper arrays with zeros or NaNs. |
|
Recompute apparent resistivity and phase from the impedance tensor Z for a single site. |
|
Rename a station using an explicit name or a policy function. |
|
Batch rename a collection of sites. |
|
Rotate impedance tensor Z (and tipper T, if present) by an azimuthal angle in degrees. |
|
Rotate every site in a collection by an azimuthal angle in degrees. |
|
Subset the dataset along frequency by range or explicit indices, keeping all affected arrays aligned. |
|
Subset all sites in a collection along frequency, keeping arrays aligned. |
|
Set geographic coordinates on the EDI header. |
|
Batch set coordinates for a collection of sites. |
|
Project (easting, northing) to lon/lat and set a site's coords. |
|
Set site coordinates for many EDI files from a table. |
|
Pack a set of sites into a zip archive using a filename template. |
|
Write a single site (EDI) to a target path. |
|
Write a collection of sites to a directory using a filename template. |
|
Recompute and rewrite EDI files using pyCSAMT conventions. |
|
Per-station outcome for an EDI recomputation workflow. |
|
Result returned by |
|
Recompute one EDI object. |
|
Convenience function for |
|
Statistics and display for a single |
|
Statistics and display for a |
|
Select sites that fall inside an axis-aligned geographic box. |
|
Select sites whose stored chainage falls within a closed interval. |
|
Select sites that contain at least one data row with frequency inside a closed interval. |
|
Select sites by zero-based numeric indices, supporting negative indices. |
|
Select sites by matching station names against one or more patterns. |
|
Select sites using a user-supplied predicate function. |
|
Drop sites that are effectively empty. |
|
Keep sites that contain at least one finite impedance value. |
|
Filter out sites whose maximum phase-error exceeds a threshold. |
|
Return |
|
Processed content of one Zonge TEMAVG |
|
One processed TEMAVG gate value. |
|
Read a TEM profile/point coordinate table. |
|
Coordinate metadata for one TEM station point. |
|
Collection of TEM station coordinates. |
|
Return |
|
Parsed TEMAVG processing log. |
|
One acquisition-summary row from a TEMAVG log. |
|
Plot TEM decay curves. |
|
Plot station elevation along TEM survey profiles. |
|
Plot selected TEMAVG gate profiles. |
|
Plot station coordinates from a TEM survey. |
|
Plot a TEM survey map with an elevation-profile panel. |
|
Plot a compact TDEM dashboard. |
|
Plot a TEMAVG |
|
Plot a TEMAVG pseudo-section. |
|
Plot transformed apparent resistivity and phase. |
|
Plot one or more TEM decay curves on log-log axes. |
|
Plot TEM station elevation along one or more survey profiles. |
|
Plot selected TEMAVG windows as profiles along stations. |
|
Plot TEM station coordinates from a survey or coordinate table. |
|
Plot a TEM survey map with a matched elevation profile panel. |
|
Plot a TEMAVG pseudo-section from station-gate records. |
|
Create a compact multi-panel TDEM real-data dashboard. |
|
Plot a ZPLOT |
|
Plot transformed apparent resistivity and optional phase. |
|
Station-axis tick configuration for TDEM plots. |
|
Shared style values for TDEM figures. |
|
Unified TEM file reader with format auto-detection. |
|
Read a directory of Zonge TEMAVG processed files. |
|
Collection of processed TEM files from one survey folder. |
|
Container for a single time-domain EM (TEM) sounding. |
|
Rigorous TDEM → MT impedance via numerical Fourier cosine transform and Kramers-Kronig reconstruction (Meju 1996; Christensen 1990). |
|
Convert TEM soundings to frequency-domain apparent impedance using the late-time apparent-resistivity approximation. |
|
Convert one or more TEM soundings to a |
|
User-defined waveform supplied as paired time/current arrays. |
|
Half-sine transmitter current (used by some CSEM / airborne systems). |
|
Transmitter current with a finite linear ramp on switch-off. |
|
Ideal square-wave transmitter current (zero ramp time). |
|
Read a TEMAVG folder and return station soundings. |
|
Result bundle returned by TEMAVG workflow helpers. |
|
Run a complete TEMAVG-to-frequency workflow. |
|
Return |
|
Parsed content of one TEMAVG contour |
|
One row from a TEMAVG contour |
|
Configure the global |
|
Reset |
|
Package-wide topography rendering policy for 2-D section plots. |
|
Convert a Zonge |
|
Convert a Jones |
|
Transform SEG spectra-EDI files to MT-impedance EDI files. |
|
Outcome of a batch spectra→impedance conversion. |
|
Template utilities for AVG/J -> EDI transformations. |
|
Transform raw MT field time series to impedance EDI files. |
|
Align a tensor component to a reference frequency grid. |
|
Validate a collection of EM objects and return their common kind. |
|
Assess data quality across a collection of EDI/Z objects. |
|
Export new EDI files from a batch of EDI objects and Z tensors. |
|
Return a list of |
|
Return the reference (clean) frequency grid for a collection. |
|
Parse and validate a tensor request, returning name and component. |
|
Plot confidence diagnostics from tensor errors for EM data. |
|
Plot tensors for one station: resistivity/phase or Z real/imag. |
|
Plot strike angles from invariants and phase tensor as rose/polar diagrams. |
|
Plot tensors for one station (compat wrapper). |
|
Build a 2-D matrix (freq × station) from a tensor collection. |
|
Wrap phase values to a target range with a given periodic base. |
|
Resistivity/phase container backed by complex Z. |
|
High-level impedance tensor container built on |
|
Extends AVG with tensor components and analytical methods. |
|
High-level façade for a Zonge AVG/AMTAVG dataset. |
|
Base class for AVG data handling and file writing. |
|
Abstract base class for a single AVG data component. |
|
A container for a tidy AVG table and its metadata. |
|
A structured, format-agnostic representation of a single row. |
|
Dynamically provides all known aliases for canonical names. |
|
A foundational base class for Zonge data objects. |
|
High-level aggregator for a complete Zonge AVG dataset. |
|
Transmitter current amplitude container (unit: A). |
|
Enumeration/validator for classical CSAMT component labels. |
|
Frequency axis manager (Hz) for AVG tables. |
|
Apply an Adaptive Moving Average (AMA) filter. |
|
Apply a Fixed-Length Moving Average (FLMA) filter. |
|
Determine a suitable reference frequency for static shift. |
|
Calculate Swift's skew for the impedance tensor. |
|
Calculate the geoelectric strike angle. |
|
Interpolate AVG data onto a regular log-spaced grid. |
|
Smooth apparent resistivity using the Hilbert transform. |
|
Apply a Trimmed Moving Average (TMA) filter. |
|
A class for advanced processing of Zonge AVG data. |
|
Minimal provenance captured from banner / comment lines. |
|
Receiver electrode / coil metadata ( |
|
Encapsulate Zonge skip-flag quality codes. |
|
Project-level annotation block ( |
|
Survey-level configuration taken from AVG headers. |
|
Transmitter loop / bipole metadata ( |
|
Impedance phase (\(\varphi\)) per component. |
|
Apparent resistivity (\(\rho_a\)) per component. |
|
Fetch all known aliases for a canonical column name. |
|
One-dimensional survey-line geometry container. |
|
Adds impedance-like tensor helpers to a component. |
|
Geomagnetic transfer function (Tipper) component. |
|
Read a Zonge AVG file and return a tidy DataFrame and metadata. |
|
Serialize a DataFrame to a Zonge kind-2 AVG file. |