API Reference#
This section contains the complete API reference for PyHydroGeophysX.
- Data Processing Module
- model_output package
- model_input package
- petrophysics package
- Submodules
- PyHydroGeophysX.petrophysics.resistivity_models module
- PyHydroGeophysX.petrophysics.velocity_models module
- Pore-fluid properties
- Module contents
BaseVelocityModelBrieModelDEMModelHertzMindlinModelVRHModelVRH_model()WS_Model()batzle_wang_brine()bulk_cec_to_qv()ion_charge()pore_fluid_conductivity()resistivity_to_saturation()resistivity_to_water_content()run_petrophysics_monte_carlo()satK()velDEM()vel_porous()velocity_to_water_content()water_content_to_resistivity()water_content_to_velocity()waxman_smits_surface_conductivity()
- Forward Module
- Inversion Module
- Core Inversion Classes
ERROR_SOURCESERTInversionERTRunGEOMETRIC_FACTOR_POLICIESensure_geometric_factors()repair_geometric_factors()run_ert_manager_inversion()validate_geometric_factors()MAX_MESH_QUALITYMESH_SUFFIXESZONE_INTERFACE_MARKERbuild_inversion_mesh()load_inversion_mesh()mark_zone_interfaces()mesh_preview()SRTInversionbuild_srt_mesh()run_srt_manager_inversion()TimeLapseERTInversionTimeLapseSRTInversionWindowedTimeLapseERTInversion
- EM Inversion
- Joint and Multi-Method Inversion
- Cross-Constraint Utilities
- Base Classes
- Core Inversion Classes
- core package
- Agents Module
- Geophy_modular package
- Hydro_modular package
- solvers package
- analysis package
- assimilation package
- data_access package
- uncertainty package
- visualization package
- Submodules
- PyHydroGeophysX.visualization.axis_units module
- PyHydroGeophysX.visualization.plotting module
- PyHydroGeophysX.visualization.multi_method module
- PyHydroGeophysX.visualization.animation module
- PyHydroGeophysX.visualization.mt_plots module
- PyHydroGeophysX.visualization.vtk_export module
- Module contents
create_combined_timelapse_gif()create_difference_gif()create_timelapse_gif()create_timelapse_mp4()export_mesh_to_vtk()export_points_to_vtk()export_structured_vtk()export_structured_vtk_multi()export_timelapse_structured_vtk()export_timelapse_vtk()get_length_unit()length_unit()plot_apparent_resistivity_pseudosection()plot_apparent_resistivity_timelapse()plot_convergence()plot_coverage()plot_cross_section_with_wells()plot_depth_slices()plot_difference_map()plot_electrode_layout()plot_em_data_fit()plot_em_fit_and_residuals()plot_em_residuals()plot_hydro_vs_geophys()plot_layered_profiles()plot_model_section()plot_monitoring_timeseries()plot_mt_dimensionality()plot_mt_model_1d()plot_mt_pseudosection()plot_mt_section()plot_mt_sounding()plot_multi_method_panel()plot_petrophysical_scatter()plot_phase_tensor_pseudosection()plot_pseudosection_matrix()plot_signal_and_noise()plot_time_lapse_panel()plot_timelapse_snapshots()plot_topography()set_length_unit()
- PyHydroGeophysX.workflows package
- Submodules
- PyHydroGeophysX.workflows.bundle module
- PyHydroGeophysX.workflows.cli module
- PyHydroGeophysX.workflows.codegen module
- PyHydroGeophysX.workflows.domain module
run_em_inversion()run_em_line_inversion()run_ert3d_forward()run_ert_single()run_ert_timelapse()run_geo_hydrology()run_gravmag_forward_bodies()run_gravmag_inversion()run_gravmag_process()run_hydro_geophysics()run_joint()run_mesh3d()run_mt_invert_1d()run_mt_invert_profile()run_mt_process()run_seismic3d()run_srt_inversion()
- PyHydroGeophysX.workflows.em1d module
BackendUnavailablebackend_status()build_em_config()calibrate_to_reference()estimate_data_scale()example_catalog()fdem_forward()fdem_invert()gate_report()invert_line()is_temcompany_source()is_ttem_source()load_line_geometry()load_sounding()load_sounding_container()load_temcompany_sounding()load_ttem_sounding()model_arrays()model_depth_profile()preset_inversion()save_inversion()save_line_csv()save_sounding_container()survey_summary()tdem_forward()tdem_invert()tdem_joint_invert()
- PyHydroGeophysX.workflows.gravmag module
- PyHydroGeophysX.workflows.models module
- PyHydroGeophysX.workflows.mt module
- PyHydroGeophysX.workflows.objects module
- PyHydroGeophysX.workflows.recipe module
- PyHydroGeophysX.workflows.registry module
- PyHydroGeophysX.workflows.runner module
- PyHydroGeophysX.workflows.walkthrough module
- Module contents
ArtifactRefModuleDescriptorRunContextWorkflowDescriptorWorkflowRunResultWorkflowSpecWorkflowValidationErrorexport_workflow_bundle()generate_notebook()generate_python()generate_walkthrough()get_workflow()iter_artifact_refs()list_workflows()load_recipe()module_descriptor_for()navigation_key_for()register_workflow()result_key_for()run_workflow()save_recipe()teaching_paths()
- PyHydroGeophysX.llm package
- Submodules
- PyHydroGeophysX.llm.cli_models module
- PyHydroGeophysX.llm.cli_providers module
- PyHydroGeophysX.llm.cli_setup module
- PyHydroGeophysX.llm.providers module
AnthropicProviderDEFAULT_EFFORTDEFAULT_REQUEST_TIMEOUT_SIMAGE_PLACEHOLDERKEEPALIVE_SMODEL_PRICES_USD_PER_MTOKMODEL_TIERSOpenAICompatibleProviderOpenAIProviderPROVIDER_ALIASESProviderTEXT_ONLY_MODEL_HINTSTIER_CUSTOMTIER_ORDERas_blocks()cap_images()has_image()image_block()keepalive_http_client()make_provider()normalise_provider_id()prewarm()price_label()provider_has_tiers()supports_vision()text_block()tier_effort()tier_for_model()tier_label()tier_model()tier_of_model()to_anthropic_messages()to_anthropic_tools()to_openai_messages()to_openai_tools()to_responses_input()window_messages()
- PyHydroGeophysX.llm.runtime_options module
- Module contents