API Reference

This section contains the complete API reference for PyHydroGeophysX.

• Data Processing Module
  • ERT Data Agent
    • Overview
    • Data Structures
    • Functions
    • Workflow Example
    • Time-Lapse Surveys
    • See Also
    • Acknowledgments
• model_output package
  • Submodules
  • model_output.base module
    • HydroModelOutput
  • model_output.modflow_output module
    • MODFLOWPorosity
    • MODFLOWWaterContent
    • binaryread()
  • model_output.parflow_output module
    • ParflowOutput
    • ParflowPorosity
    • ParflowSaturation
    • read_pfb()
    • read_pfb_standalone()
  • model_output.water_content module
    • MODFLOWWaterContent
    • binaryread()
  • Module contents
    • HydroModelOutput
    • MODFLOWPorosity
    • MODFLOWWaterContent
    • ParflowPorosity
    • ParflowSaturation
    • binaryread()
• petrophysics package
  • Submodules
  • petrophysics.resistivity_models module
    • WS_Model()
    • resistivity_to_porosity()
    • resistivity_to_saturation()
    • resistivity_to_saturation2()
    • resistivity_to_water_content()
    • water_content_to_resistivity()
  • petrophysics.velocity_models module
    • BaseVelocityModel
    • BrieModel
    • DEMModel
    • HertzMindlinModel
    • VRHModel
    • VRH_model()
    • satK()
    • velDEM()
    • vel_porous()
    • water_content_to_velocity()
  • Module contents
• Forward Module
  • ERT and SRT Forward Modeling
    • ERTForwardModeling
    • ertforandjac()
    • ertforandjac2()
    • ertforward()
    • ertforward2()
    • SeismicForwardModeling
  • EM Forward Modeling
    • TDEMForwardModeling
    • TDEMSurveyConfig
    • create_tdem_survey()
    • hydro_to_tdem()
    • FDEMForwardModeling
    • FDEMSurveyConfig
• Inversion Module
  • Core Inversion Classes
    • ERTInversion
    • SRTInversion
    • TimeLapseERTInversion
    • TimeLapseSRTInversion
    • WindowedTimeLapseERTInversion
  • EM Inversion
    • TDEMInversion
    • TDEMInversionResult
    • run_tdem_inversion()
    • FDEMInversion
    • FDEMInversionResult
  • Joint and Multi-Method Inversion
    • JointERTSRTInversion
    • JointERTSRTResult
    • GeophysicalInversion
  • Cross-Constraint Utilities
    • PetrophysicalCoupling
    • StructuralConstraint
  • Base Classes
    • InversionBase
    • InversionResult
    • TimeLapseInversionResult
• core package
  • Submodules
  • core.interpolation module
    • ProfileInterpolator
    • create_surface_lines()
    • interpolate_structure_to_profile()
    • interpolate_to_mesh()
    • interpolate_to_profile()
    • prepare_2D_profile_data()
    • setup_profile_coordinates()
  • core.mesh_utils module
    • MeshCreator
    • add_velocity_interface()
    • createTriangles()
    • create_mesh_from_layers()
    • extract_velocity_interface()
    • fill_holes_2d()
  • Module contents
    • MeshCreator
    • ProfileInterpolator
    • add_velocity_interface()
    • create_mesh_from_layers()
    • create_surface_lines()
    • extract_velocity_interface()
    • interpolate_structure_to_profile()
    • interpolate_to_mesh()
    • interpolate_to_profile()
    • prepare_2D_profile_data()
    • setup_profile_coordinates()
• Agents Module
  • Base Classes
    • BaseAgent
  • Coordinator
    • AgentCoordinator
  • Input Agents
    • ContextInputAgent
    • ERTLoaderAgent
    • SeismicAgent
    • ClimateDataAgent
  • Processing Agents
    • ERTInversionAgent
    • InversionEvaluationAgent
    • TDEMAgent
    • GeophysicalInversionAgent
    • DataFusionAgent
    • StructureConstraintAgent
  • Conversion Agents
    • PetrophysicsAgent
    • WaterContentAgent
  • Output Agents
    • ReportAgent
    • CodeGenerationAgent