Skip to content
pyCaRM 0.1 documentation
⌘ K
pyCaRM 0.1 documentation

Contents:

  • About
  • Quickstart
  • Discretization
  • Fluid Properties
  • FLS Calculation Methods
  • Variable Grout Properties
  • Heat Flux Mode
  • Output
  • carm
    • carm package

pyCaRM documentation

pyCaRM is a Python library for borehole heat exchanger (BHE) simulation, supporting single and multi-borehole configurations with optional groundwater flow effects.

Contents:

  • About
    • Authors
    • Institution
    • Contact
    • Links
  • Quickstart
    • Imports
    • Fluid
    • Borehole
    • Ground
    • Environmental boundary conditions
    • Physical model
    • Simulation
    • Extracting the outlet temperature
  • Discretization
    • Overview
    • Upper layers
    • Ground domain
    • Borehole domain
    • Lower layers
    • Initial and boundary conditions
  • Fluid Properties
    • Using CoolProp
    • Example
  • FLS Calculation Methods
    • Overview
    • sqrt method (default)
    • continuous method
    • Method comparison
    • Choosing a method
  • Variable Grout Properties
    • SoilMoisture
    • When to use it
    • Field-level update
    • Example
  • Heat Flux Mode
    • Overview
    • Performance function
    • Picard iteration
    • Parallel vs. series
    • Usage
    • Output
    • References
  • Output
    • Simulation results
    • Offsets
    • Extracting results
    • Depth axis
  • carm
    • carm package

© 2026, Alessio Tollin, Angelo Zarrella Built with Sphinx 9.0.4