User Guide#

The user guide is the practical companion to the pyCSAMT science API, applications, and command-line tools. It explains how users load survey data, inspect quality, apply processing workflows, build maps, prepare inversions, run AI-assisted tools, and move from station-level data to reproducible project outputs.

This section is organized as an operational workspace. Start with the core workflow pages when you want a guided path through common tasks. Open the domain guides when you need deeper package-specific documentation for emtools, site containers, forward modelling, external model integrations, pipelines, agents, or maps.

Reading Paths#

Different users usually arrive here with different goals:

Core Workflow Guides#

Data loading

Load EDI directories, explicit station files, API survey views, and existing EDI-like objects into the canonical Sites container.

Data Loading
Processing

Move from loaded data to QC tables, cleaning, correction, static shift, tensor checks, and reproducible processing outputs.

Data processing
Mapping

Build station maps, survey-line views, pseudosections, and visual checks that make field data easier to inspect.

Map Tools
Inversion

Prepare data, model settings, exports, and review steps for 1-D, 2-D, and external-engine inversion workflows.

Inversion
Interpretation

Connect processed responses, plots, inversion products, and geologic reasoning into reviewable interpretation workflows.

Interpretation
IoT workflows

Work with sensor-oriented or streaming workflows when survey data arrive from connected acquisition and monitoring contexts.

IoT-Enabled Field Acquisition

Domain And Package Guides#

EM tools

Detailed narrative pages for pycsamt.emtools modules, including QC, static shift, tensor, strike, frequency, and plotting tools.

EM Tools Guide
Site tools

Understand station wrappers, Sites containers, selection, editing, coordinates, exports, reports, and recomputation helpers.

Site Tools
Forward modeling

Predict synthetic responses, configure solvers and grids, and connect forward experiments to inversion design.

Forward Modelling
Pipeline system

Run preset and configured processing chains, compare outputs, preserve manifests, and move between Python and CLI execution.

Pipeline System
Map tools

Work directly with the Python mapping layer for stations, profiles, overlays, 3-D quick looks, exports, and map APIs.

Map Tools

Reference And Next Steps#

Tutorials

Follow longer task-oriented walkthroughs after choosing the relevant user-guide path.

Tutorials
Getting started

Install pyCSAMT, verify the environment, and complete the first practical survey run before diving into advanced workflows.

Getting Started

Section Contents#