Skip to content

main_single_run_sim API Reference

geoloop.bin.SingleRunSim.main_single_run_sim 

main_single_run_sim(config_file_path: Path | str) -> None

Execute a complete SingleRun borehole heat exchanger (BHE) simulation, including optional optimization, result saving, and visualization.

Parameters:

Name Type Description Default
config_file_path Path | str

The path to the .json configuration file.

 required
Workflow
  1. Parse and load the configuration file.
  2. Apply optional lithology-to-conductivity preprocessing.
  3. Optionally perform flow-rate or parameter optimization.
  4. Initialize a SingleRun simulation from the config.
  5. Execute the simulation.
  6. Save results into structured output directories.
  7. Generate visualizations:
    • Pipe cross-section
    • Borefield layout (for PYGFIELD)
    • Optional T-field (for FINVOL)

Returns:

Type Description
None

The function writes outputs to disk and prints status information.