CLI

The pyCSAMT command-line interface is the shell entry point for the same survey workflows exposed by the Python API: data inspection, format conversion, site inventory, processing pipelines, forward modelling, inversion preparation, interpretation, mapping, and TDEM utilities.

Use the CLI when you need repeatable commands for a field dataset, batch-friendly outputs for automation, or a quick way to validate that a survey directory can be loaded before writing Python code.

pycsamt --help
pycsamt edi validate data/edis/
pycsamt site info data/edis/
pycsamt map stations data/edis/

• 1. CLI Overview
  • 1.1. Top-Level Command
  • 1.2. Global Options
  • 1.3. Configuration Loading
  • 1.4. Command Families
  • 1.5. Active Survey Context
  • 1.6. Survey Cache
  • 1.7. Input Paths
  • 1.8. Output Formats
  • 1.9. Dry Runs
  • 1.10. Typical Workflows
  • 1.11. Choosing Commands
  • 1.12. Scripting Guidelines
  • 1.13. Troubleshooting
  • 1.14. Getting Help
  • 1.15. Relationship To The Python API
• 2. Configuration Commands
  • 2.1. When to use config
  • 2.2. How values are resolved
  • 2.3. The config file
  • 2.4. Key syntax
  • 2.5. Value types
  • 2.6. Sections
  • 2.7. Inspecting configuration
  • 2.8. Editing configuration
  • 2.9. Style presets
  • 2.10. Interpretation presets
  • 2.11. Environment variables
  • 2.12. Agent configuration
  • 2.13. Common recipes
  • 2.14. Troubleshooting
• 3. Survey Commands
  • 3.1. What The Survey Context Stores
  • 3.2. Command Map
  • 3.3. Resolution Rules
  • 3.4. Cache Validity
  • 3.5. Set A Survey
  • 3.6. Show The Active Survey
  • 3.7. Clear The Active Survey
  • 3.8. Rebuild The Active Cache
  • 3.9. List Cached Surveys
  • 3.10. Purge Cache Entries
  • 3.11. How Other Commands Use Survey Context
  • 3.12. Typical Workflow
  • 3.13. Troubleshooting
  • 3.14. Safety Notes
  • 3.15. Python Equivalent
• 4. EDI Commands
  • 4.1. EDI versus site commands
  • 4.2. Recommended workflow
  • 4.3. Command overview
  • 4.4. Validate EDI structure
  • 4.5. Inspect files with info
  • 4.6. Station coordinate tables
  • 4.7. Profile geometry
  • 4.8. Rotate impedance and tipper tensors
  • 4.9. Select and export subsets
  • 4.10. Quality-control patterns
  • 4.11. Move to Sites
  • 4.12. Troubleshooting
• 5. AVG Commands
  • 5.1. What AVG commands are for
  • 5.2. Supported AVG formats
  • 5.3. Recommended workflow
  • 5.4. Inspect metadata with info
  • 5.5. Validate quality with validate
    • 5.5.1. Component filtering
    • 5.5.2. Worst-station review
  • 5.6. Inspect stations with stations
  • 5.7. Correct data with correct
    • 5.7.1. Choosing a static-shift filter
    • 5.7.2. Reference frequency
    • 5.7.3. Window size
    • 5.7.4. Machine-readable correction summary
  • 5.8. Export with export
  • 5.9. End-to-end examples
    • 5.9.1. Quick inventory
    • 5.9.2. QC-first correction
    • 5.9.3. Correction plus normalized export
  • 5.10. Troubleshooting
• 6. Jones Commands
  • 6.1. Command Map
  • 6.2. Global Conventions
  • 6.3. J-Format Model
  • 6.4. jones info
    • 6.4.1. Single-File Output
    • 6.4.2. Directory Output
    • 6.4.3. Options
  • 6.5. jones validate
    • 6.5.1. Validation Targets
    • 6.5.2. Validation Modes
    • 6.5.3. Exit Codes
    • 6.5.4. Options
  • 6.6. jones stations
    • 6.6.1. Options
  • 6.7. jones blocks
    • 6.7.1. Block Summary
    • 6.7.2. QA Mode
    • 6.7.3. Filtering
    • 6.7.4. Options
  • 6.8. jones select
    • 6.8.1. Filters
    • 6.8.2. Dry Run
    • 6.8.3. Export Mode
    • 6.8.4. Options
  • 6.9. Typical Workflows
  • 6.10. Troubleshooting
  • 6.11. API Equivalents
• 7. Site Commands
  • 7.1. Command map
  • 7.2. Mental model
  • 7.3. Shared options
  • 7.4. Input resolution
  • 7.5. Inspect sites
  • 7.6. Select stations
  • 7.7. Edit sites
  • 7.8. Export sites
  • 7.9. Recompute EDIs
  • 7.10. Compute quantities
  • 7.11. Machine-readable formats
  • 7.12. Typical workflow
  • 7.13. Troubleshooting
  • 7.14. Safety notes
  • 7.15. Python equivalent
• 8. Transform Commands
  • 8.1. Command Map
  • 8.2. Mental Model
  • 8.3. Shared Options
  • 8.4. Spectra EDI Conversion
  • 8.5. Zonge AVG Conversion
  • 8.6. Jones J-File Conversion
  • 8.7. Dry Runs
  • 8.8. Output Files
  • 8.9. Recommended Workflows
  • 8.10. Troubleshooting
  • 8.11. Safety Notes
  • 8.12. Python Equivalent
• 9. Forward Commands
  • 9.1. Command Map
  • 9.2. Global Conventions
  • 9.3. forward model geology
    • 9.3.1. Options
  • 9.4. forward run
    • 9.4.1. Explicit Models
    • 9.4.2. Geology-Sampled Models
    • 9.4.3. Solvers
    • 9.4.4. Options
    • 9.4.5. Validation Rules
  • 9.5. forward generate
    • 9.5.1. Solvers and Noise
    • 9.5.2. Layer Counts
    • 9.5.3. Options
  • 9.6. Dataset Files
  • 9.7. Typical Workflows
  • 9.8. Troubleshooting
  • 9.9. API Equivalents
• 10. Inversion Commands
  • 10.1. Command Map
  • 10.2. Mental Model
  • 10.3. Basic Workflow
  • 10.4. Input Resolution
  • 10.5. Solver Detection
  • 10.6. Build
  • 10.7. Run
  • 10.8. Status
  • 10.9. Results
  • 10.10. Plot Overview
  • 10.11. Plot Model
  • 10.12. Plot Misfit
  • 10.13. Plot Response
  • 10.14. Plot Pseudo
  • 10.15. Plot Section
  • 10.16. Plot 1d
  • 10.17. Plot Per-Site
  • 10.18. Plot Grid
  • 10.19. Choosing Plots
  • 10.20. Batch Figure Export
  • 10.21. Text Versus JSON Output
  • 10.22. Common Failures
  • 10.23. Practical Notes
  • 10.24. Python Equivalents
• 11. Format Commands
  • 11.1. Command Map
  • 11.2. Source Detection
    • 11.2.1. AI array bundles
  • 11.3. Detect
  • 11.4. Convert
    • 11.4.1. Examples
  • 11.5. Info
  • 11.6. Validate
  • 11.7. Common Failures
  • 11.8. Python Equivalents
• 12. Map Commands
  • 12.1. Command Map
  • 12.2. Mental Model
  • 12.3. Input Resolution
  • 12.4. Station Coordinates
  • 12.5. Options
  • 12.6. Text Output
  • 12.7. JSON Output
  • 12.8. CSV Output
  • 12.9. Filtering Rows
  • 12.10. Static Station Plot
  • 12.11. Options
  • 12.12. Output Formats
  • 12.13. Current Scope And Limitations
  • 12.14. Workflow Recipes
  • 12.15. Common Failures
  • 12.16. Practical Notes
• 13. Interpretation Commands
  • 13.1. Command Map
  • 13.2. Global Conventions
  • 13.3. interp rocks
    • 13.3.1. Catalog Output
    • 13.3.2. Single-Value Output
    • 13.3.3. Classification Methods
    • 13.3.4. Options
  • 13.4. interp classify
    • 13.4.1. Workflow
    • 13.4.2. Layer Table
    • 13.4.3. Interpretation Controls
    • 13.4.4. Options
    • 13.4.5. Important Boundaries
  • 13.5. interp export
    • 13.5.1. Formats
    • 13.5.2. Export Pipeline
    • 13.5.3. Options
    • 13.5.4. Overwrite Rules
  • 13.6. Typical Workflows
  • 13.7. Troubleshooting
  • 13.8. API Equivalents
• 14. Pipeline Commands
  • 14.1. Command map
  • 14.2. Core model
  • 14.3. Input resolution
  • 14.4. Explore steps
  • 14.5. Explore presets
  • 14.6. Plugins and the opt-in AI step
  • 14.7. Create a config
  • 14.8. Config schema
  • 14.9. Show a config or preset
  • 14.10. Run a pipeline
  • 14.11. Cache, live progress, history, and the dashboard
  • 14.12. Output directory
  • 14.13. Output formats
  • 14.14. Exit status and troubleshooting
  • 14.15. Recommended workflow
  • 14.16. Python equivalent
  • 14.17. Related pages
• 15. TDEM Commands
  • 15.1. Command Map
  • 15.2. Survey Folder Model
  • 15.3. Shared Options
  • 15.4. Inspect A TEMAVG Survey
  • 15.5. Convert TEMAVG To EDI
  • 15.6. Plot TDEM Data
  • 15.7. Recommended Workflows
  • 15.8. Troubleshooting
  • 15.9. Safety Notes
  • 15.10. Python Equivalent