API

Two entry points cover everything programmatic in pyCSAMT: the guide to pycsamt.api — the package front door of readers, tabular views, and the configure_* / reset_* runtime settings — and the auto-generated reference for every subpackage.

• 1. API Guide
  • 1.1. API configuration
    • 1.1.1. One Pattern Everywhere
    • 1.1.2. Configuration Families
    • 1.1.3. In This Section
  • 1.2. API Views
    • 1.2.1. Opt In Explicitly With api=True
    • 1.2.2. Common Table Functions
    • 1.2.3. Multi-Table Results
    • 1.2.4. Global Configuration
    • 1.2.5. Custom Wrappers
    • 1.2.6. Reading EDI Collections
    • 1.2.7. Practical Rule
    • 1.2.8. Next Steps
  • 1.3. Mesh Display
    • 1.3.1. Three Presets, Shared By Both Families
    • 1.3.2. Structured (Rectilinear) Meshes
    • 1.3.3. Triangular Meshes
    • 1.3.4. Configuring Mesh Styles
    • 1.3.5. Next Steps
  • 1.4. Plot Styles
    • 1.4.1. Named Presets
    • 1.4.2. MT Component Colours
    • 1.4.3. Multiline Gradient Colours
    • 1.4.4. Before/After Correction Pairs
    • 1.4.5. Raw Data Style
    • 1.4.6. Phase-Tensor Ellipse Style
    • 1.4.7. Rose Diagrams
    • 1.4.8. Contour And Station-Guide Overlays
    • 1.4.9. Configuring And Sharing Styles
    • 1.4.10. Next Steps
  • 1.5. Contour overlays
    • 1.5.1. Choose a preset
    • 1.5.2. Configure the live style
    • 1.5.3. Temporary overrides
    • 1.5.4. Per-call control
    • 1.5.5. Align stacked panels by station
    • 1.5.6. Labels and scientific interpretation
    • 1.5.7. Reset configuration
  • 1.6. Interpretation Plot Styles
    • 1.6.1. Section Vs. Profile Styles
    • 1.6.2. Named Presets
    • 1.6.3. Water-Table Profile Styling
    • 1.6.4. Configuring And Sharing Styles
    • 1.6.5. Next Steps
  • 1.7. Agent Configuration
    • 1.7.1. Next Steps
  • 1.8. Section Plot Layout
    • 1.8.1. Figure Sizing: Static Vs. Dynamic
    • 1.8.2. Named Presets In Practice
    • 1.8.3. Axis Direction And Topography Awareness
    • 1.8.4. Colorbar Controls
    • 1.8.5. Configuring And Sharing Styles
    • 1.8.6. Next Steps
  • 1.9. Station Rendering
    • 1.9.1. Adaptive Label Thinning
    • 1.9.2. Topography-Aware Marker Placement
    • 1.9.3. Configuring And Sharing Styles
    • 1.9.4. Next Steps
  • 1.10. View Controls
    • 1.10.1. Phase View Control
    • 1.10.2. Resistivity View Control
    • 1.10.3. Frequency Axis Control
    • 1.10.4. Configuring And Sharing Styles
    • 1.10.5. Next Steps
  • 1.11. Configuration
    • 1.11.1. The Dotted-Path Convention
    • 1.11.2. View Layer
    • 1.11.3. Pipeline Outputs
    • 1.11.4. Site Ordering
    • 1.11.5. CLI Defaults
    • 1.11.6. Plot Styles
    • 1.11.7. Contour Overlays
    • 1.11.8. Figure Output
    • 1.11.9. View Controls
    • 1.11.10. Section Layout
    • 1.11.11. Station Rendering
    • 1.11.12. Interpretation
    • 1.11.13. Topography
    • 1.11.14. Mesh Display
    • 1.11.15. Agents
    • 1.11.16. Environment Variables
    • 1.11.17. Recommended Setups
    • 1.11.18. Reset Everything
    • 1.11.19. Next Steps
• 2. API reference