6.2. Classical model integrations

The pycsamt.models package connects pyCSAMT to three established electromagnetic modelling and inversion ecosystems: Occam2D, ModEM, and MARE2DEM. These integrations keep native files and external executables visible while providing Python tools to build inputs, validate projects, run solvers when explicitly requested, load results, and create review figures.

This section is the classical engine layer of the Inversion guide. It is separate from Forward Modelling, which focuses on predicting synthetic responses, and from AI inversion, which covers learned inversion methods.

External solvers

pyCSAMT provides integration code and project tooling. Availability of an external solver, its executable license, compilation requirements, and computational resources remain the user’s responsibility. External execution is explicit rather than automatic.

• 6.2.1. Overview
  • 6.2.1.1. At a glance
  • 6.2.1.2. Shared workflow
  • 6.2.1.3. What the inversion is minimizing
  • 6.2.1.4. Model integrations versus the common inversion API
  • 6.2.1.5. Engine assumptions in plain terms
  • 6.2.1.6. Run-directory principles
  • 6.2.1.7. Minimum review evidence
  • 6.2.1.8. Related reading
• 6.2.2. Choosing A Model Backend
  • 6.2.2.1. Two Different Choices
  • 6.2.2.2. Quick Recommendation
  • 6.2.2.3. Backend Matrix
  • 6.2.2.4. Decision Axis 1: Dimensionality
  • 6.2.2.5. Decision Axis 2: Data Type
  • 6.2.2.6. Decision Axis 3: Operational Control
  • 6.2.2.7. Typical File Responsibility
  • 6.2.2.8. External Executables
  • 6.2.2.9. Workflow Map
  • 6.2.2.10. Connection To InversionConfig
  • 6.2.2.11. Direct Model Integration Example
  • 6.2.2.12. Risk Checklist
  • 6.2.2.13. Common Mistakes
  • 6.2.2.14. Recommended Path By Deliverable
  • 6.2.2.15. Next Steps
• 6.2.3. Configuration And File I/O
  • 6.2.3.1. The Three-Layer Record
  • 6.2.3.2. Configuration Template Formats
  • 6.2.3.3. Strict Loading
  • 6.2.3.4. Backend-Neutral Versus Native Configuration
  • 6.2.3.5. Native Files By Engine
  • 6.2.3.6. Recommended Directory Layouts
  • 6.2.3.7. Builder, Runner, Loader Contract
  • 6.2.3.8. Validation Before A Run
  • 6.2.3.9. Provenance To Keep With Every Run
  • 6.2.3.10. Archiving Results
  • 6.2.3.11. Common Mistakes
  • 6.2.3.12. Pre-Run Checklist
  • 6.2.3.13. Post-Run Checklist
  • 6.2.3.14. Next Steps
• 6.2.4. Compiling the External Solvers
  • 6.2.4.1. Quick Start
  • 6.2.4.2. Auto-Install Behavior
  • 6.2.4.3. ModEM
    • ModEM 3-D
    • ModEM 2-D
    • MPI and Intel builds
  • 6.2.4.4. Occam2D
  • 6.2.4.5. MARE2DEM
    • Setting up the toolchain
    • Real status, real build
    • A real physics check, not just a compile check
    • A real toolchain bug, found and fixed
  • 6.2.4.6. Self-Contained Windows Binaries
  • 6.2.4.7. Troubleshooting
  • 6.2.4.8. Related Reading
• 6.2.5. Occam2D
  • 6.2.5.1. When To Use Occam2D
  • 6.2.5.2. Package Map
  • 6.2.5.3. Configuration
  • 6.2.5.4. Native Files
  • 6.2.5.5. Build Input Files
  • 6.2.5.6. Data Rows And Type Codes
  • 6.2.5.7. Mesh And Model Review
  • 6.2.5.8. Run Occam2D
  • 6.2.5.9. Backend-Neutral Occam2D Runs
  • 6.2.5.10. Load Results
  • 6.2.5.11. Response And Misfit Diagnostics
  • 6.2.5.12. Log And Convergence
  • 6.2.5.13. Plotting And QC
  • 6.2.5.14. Recommended Run Layout
  • 6.2.5.15. Pre-Run Checklist
  • 6.2.5.16. Post-Run Checklist
  • 6.2.5.17. Common Mistakes
  • 6.2.5.18. Next Steps
• 6.2.6. Occam1D inversion
  • 6.2.6.1. When To Use Occam1D
  • 6.2.6.2. Package Map
  • 6.2.6.3. Configuration
  • 6.2.6.4. Build Input Files
  • 6.2.6.5. Running The Inversion
  • 6.2.6.6. Batch inversion
  • 6.2.6.7. Text and image products
  • 6.2.6.8. Common Mistakes
  • 6.2.6.9. Next Steps
• 6.2.7. ModEM
  • 6.2.7.1. When To Use ModEM
  • 6.2.7.2. Dimensionality
  • 6.2.7.3. Package Map
  • 6.2.7.4. Configuration
  • 6.2.7.5. Native Files
  • 6.2.7.6. Data Files And Components
  • 6.2.7.7. Build A 3-D Input Set
  • 6.2.7.8. Build A 2-D Input Set
  • 6.2.7.9. Build From Existing Data
  • 6.2.7.10. Models
  • 6.2.7.11. Covariance
  • 6.2.7.12. Control Files
  • 6.2.7.13. Run ModEM
  • 6.2.7.14. Load Results
  • 6.2.7.15. Log Diagnostics
  • 6.2.7.16. Plotting
  • 6.2.7.17. A Vertical Section Through The 3-D Model
  • 6.2.7.18. Conversion And Utility Tools
  • 6.2.7.19. Backend-Neutral Workflows
  • 6.2.7.20. Recommended Run Layout
  • 6.2.7.21. Pre-Run Checklist
  • 6.2.7.22. Post-Run Checklist
  • 6.2.7.23. Common Mistakes
  • 6.2.7.24. Next Steps
• 6.2.8. MARE2DEM
  • 6.2.8.1. When To Use MARE2DEM
  • 6.2.8.2. Package Map
  • 6.2.8.3. Configuration
  • 6.2.8.4. Source And Binary Management
  • 6.2.8.5. Binary Resolution
  • 6.2.8.6. Native Files
  • 6.2.8.7. Build A Run Directory
  • 6.2.8.8. Create MT Data
  • 6.2.8.9. Create CSEM Data
  • 6.2.8.10. Merge And Noise Utilities
  • 6.2.8.11. Geometry And Topography
  • 6.2.8.12. Grid And Mesh Utilities
  • 6.2.8.13. Run MARE2DEM
  • 6.2.8.14. Inspect Results
  • 6.2.8.15. Plotting And QC
  • 6.2.8.16. Model Comparison
  • 6.2.8.17. Recommended Run Layout
  • 6.2.8.18. Pre-Run Checklist
  • 6.2.8.19. Post-Run Checklist
  • 6.2.8.20. Common Mistakes
  • 6.2.8.21. Next Steps
• 6.2.9. PCSF — Common Subsurface Format
  • 6.2.9.1. Four geometry kinds
  • 6.2.9.2. PCSF on disk
  • 6.2.9.3. Converting an Occam2D result
  • 6.2.9.4. Converting a ModEM 3-D result
  • 6.2.9.5. Converting a MARE2DEM result
  • 6.2.9.6. Stacking lines into a fence
  • 6.2.9.7. Topography
  • 6.2.9.8. A terrain-draped Occam2D section
  • 6.2.9.9. One point cloud, every geometry kind
  • 6.2.9.10. Consumers
  • 6.2.9.11. Associating observed boreholes
  • 6.2.9.12. PCSM: the browsable ASCII projection
    • Converting between the encodings
    • Real complete files
  • 6.2.9.13. Versioning and conformance