GHEtool
stable
GHEtool
Welcome to GHEtool’s documentation!
Cite GHEtool
GHEtool in literature
GHEtool’s Changelog and future developments
Legal Notice
Code
Installation
Get started with GHEtool
Functionalities of GHEtool
Modules
Examples
Validation
Speed improvements
GHEtool
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
F
|
G
|
I
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
Y
_
_calculate_first_year_params() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
_calculate_last_year_params() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
_check_input() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
_GroundData (class in GHEtool.VariableClasses.GroundData._GroundData)
_LoadData (class in GHEtool.VariableClasses.LoadData._LoadData)
_PipeData (class in GHEtool.VariableClasses.PipeData._PipeData)
A
activate_logger() (GHEtool.main_class.Borefield static method)
add() (GHEtool.VariableClasses.GFunction.FIFO method)
add_dhw() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
addLoggingLevel() (in module GHEtool.logger.ghe_logger)
all_months_equal (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
B
BaseClass (class in GHEtool.VariableClasses.BaseClass)
baseload_cooling() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
baseload_cooling_power (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
baseload_cooling_power_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
baseload_cooling_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
baseload_heating() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
baseload_heating_power (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
baseload_heating_power_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
baseload_heating_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
Borefield (class in GHEtool.main_class)
borefield (GHEtool.main_class.Borefield property)
Borehole (class in GHEtool.VariableClasses.Borehole)
C
calculate() (GHEtool.VariableClasses.GFunction.GFunction method)
calculate_delta_H() (GHEtool.VariableClasses.GroundData._GroundData._GroundData method)
(GHEtool.VariableClasses.GroundData.GroundConstantTemperature.GroundConstantTemperature method)
(GHEtool.VariableClasses.GroundData.GroundFluxTemperature.GroundFluxTemperature method)
(GHEtool.VariableClasses.GroundData.GroundTemperatureGradient.GroundTemperatureGradient method)
calculate_gfunction() (GHEtool.VariableClasses.CustomGFunction.CustomGFunction method)
calculate_next_depth_deep_sizing() (GHEtool.main_class.Borefield method)
calculate_quadrant() (GHEtool.main_class.Borefield method)
calculate_Rb() (GHEtool.VariableClasses.Borehole.Borehole method)
calculate_resistances() (GHEtool.VariableClasses.PipeData._PipeData._PipeData method)
(GHEtool.VariableClasses.PipeData.CoaxialPipe.CoaxialPipe method)
(GHEtool.VariableClasses.PipeData.MultipleUTube.MultipleUTube method)
calculate_temperatures() (GHEtool.main_class.Borefield method)
calculate_Tg() (GHEtool.VariableClasses.GroundData._GroundData._GroundData method)
(GHEtool.VariableClasses.GroundData.GroundConstantTemperature.GroundConstantTemperature method)
(GHEtool.VariableClasses.GroundData.GroundFluxTemperature.GroundFluxTemperature method)
(GHEtool.VariableClasses.GroundData.GroundTemperatureGradient.GroundTemperatureGradient method)
calculation_setup() (GHEtool.main_class.Borefield method)
check_values() (GHEtool.VariableClasses.BaseClass.BaseClass method)
clear() (GHEtool.VariableClasses.GFunction.FIFO method)
CoaxialPipe (class in GHEtool.VariableClasses.PipeData.CoaxialPipe)
correct_for_start_month() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
create_circular_borefield() (GHEtool.main_class.Borefield method)
create_custom_dataset() (GHEtool.main_class.Borefield method)
(GHEtool.VariableClasses.CustomGFunction.CustomGFunction method)
create_rectangular_borefield() (GHEtool.main_class.Borefield method)
CustomFormatter (class in GHEtool.logger.ghe_logger)
CustomGFunction (class in GHEtool.VariableClasses.CustomGFunction)
D
deactivate_logger() (GHEtool.main_class.Borefield static method)
delete_custom_gfunction() (GHEtool.VariableClasses.CustomGFunction.CustomGFunction method)
dhw (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
dhw_power (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
DoubleUTube (class in GHEtool.VariableClasses.PipeData.DoubleUTube)
draw_borehole_internal() (GHEtool.VariableClasses.PipeData._PipeData._PipeData method)
(GHEtool.VariableClasses.PipeData.CoaxialPipe.CoaxialPipe method)
(GHEtool.VariableClasses.PipeData.MultipleUTube.MultipleUTube method)
dump_custom_dataset() (GHEtool.VariableClasses.CustomGFunction.CustomGFunction method)
F
FIFO (class in GHEtool.VariableClasses.GFunction)
fluid_data (GHEtool.VariableClasses.Borehole.Borehole property)
FluidData (class in GHEtool.VariableClasses.FluidData)
format() (GHEtool.logger.ghe_logger.CustomFormatter method)
from_dict() (GHEtool.VariableClasses.BaseClass.BaseClass method)
G
get_month_index() (GHEtool.VariableClasses.LoadData._LoadData._LoadData static method)
get_Rb() (GHEtool.VariableClasses.Borehole.Borehole method)
GFunction (class in GHEtool.VariableClasses.GFunction)
gfunction() (GHEtool.main_class.Borefield method)
GHEtool.logger.ghe_logger
module
GHEtool.main_class
module
GHEtool.VariableClasses.BaseClass
module
GHEtool.VariableClasses.Borehole
module
GHEtool.VariableClasses.CustomGFunction
module
GHEtool.VariableClasses.FluidData
module
GHEtool.VariableClasses.GeothermalLoad.HourlyGeothermalLoad
module
GHEtool.VariableClasses.GeothermalLoad.HourlyGeothermalLoadMultiYear
module
GHEtool.VariableClasses.GeothermalLoad.MonthlyGeothermalLoadAbsolute
module
GHEtool.VariableClasses.GFunction
module
GHEtool.VariableClasses.GroundData._GroundData
module
GHEtool.VariableClasses.GroundData.GroundConstantTemperature
module
GHEtool.VariableClasses.GroundData.GroundFluxTemperature
module
GHEtool.VariableClasses.GroundData.GroundTemperatureGradient
module
GHEtool.VariableClasses.LoadData._LoadData
module
GHEtool.VariableClasses.PipeData._PipeData
module
GHEtool.VariableClasses.PipeData.CoaxialPipe
module
GHEtool.VariableClasses.PipeData.DoubleUTube
module
GHEtool.VariableClasses.PipeData.MultipleUTube
module
GHEtool.VariableClasses.PipeData.SingleUTube
module
ground_data (GHEtool.main_class.Borefield property)
GroundConstantTemperature (class in GHEtool.VariableClasses.GroundData.GroundConstantTemperature)
GroundFluxTemperature (class in GHEtool.VariableClasses.GroundData.GroundFluxTemperature)
GroundTemperatureGradient (class in GHEtool.VariableClasses.GroundData.GroundTemperatureGradient)
I
imbalance (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
import_fluid_from_pygfunction() (GHEtool.VariableClasses.FluidData.FluidData method)
in_fifo_list() (GHEtool.VariableClasses.GFunction.FIFO method)
interpolate_gfunctions() (GHEtool.VariableClasses.GFunction.GFunction method)
investment_cost (GHEtool.main_class.Borefield property)
L
load (GHEtool.main_class.Borefield property)
load_custom_gfunction() (GHEtool.main_class.Borefield method)
(in module GHEtool.VariableClasses.CustomGFunction)
M
max_depth() (GHEtool.VariableClasses.GroundData._GroundData._GroundData method)
max_peak_cooling (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
max_peak_heating (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
MaximumNumberOfIterations
module
GHEtool.logger.ghe_logger
GHEtool.main_class
GHEtool.VariableClasses.BaseClass
GHEtool.VariableClasses.Borehole
GHEtool.VariableClasses.CustomGFunction
GHEtool.VariableClasses.FluidData
GHEtool.VariableClasses.GeothermalLoad.HourlyGeothermalLoad
GHEtool.VariableClasses.GeothermalLoad.HourlyGeothermalLoadMultiYear
GHEtool.VariableClasses.GeothermalLoad.MonthlyGeothermalLoadAbsolute
GHEtool.VariableClasses.GFunction
GHEtool.VariableClasses.GroundData._GroundData
GHEtool.VariableClasses.GroundData.GroundConstantTemperature
GHEtool.VariableClasses.GroundData.GroundFluxTemperature
GHEtool.VariableClasses.GroundData.GroundTemperatureGradient
GHEtool.VariableClasses.LoadData._LoadData
GHEtool.VariableClasses.PipeData._PipeData
GHEtool.VariableClasses.PipeData.CoaxialPipe
GHEtool.VariableClasses.PipeData.DoubleUTube
GHEtool.VariableClasses.PipeData.MultipleUTube
GHEtool.VariableClasses.PipeData.SingleUTube
monthly_average_load (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
monthly_average_load_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
MultipleUTube (class in GHEtool.VariableClasses.PipeData.MultipleUTube)
O
optimise_load_profile() (GHEtool.main_class.Borefield method)
P
peak_cooling() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
peak_cooling_duration (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
peak_cooling_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
peak_duration (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
peak_heating() (GHEtool.VariableClasses.LoadData._LoadData._LoadData method)
peak_heating_duration (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
peak_heating_simulation_period (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
pipe_data (GHEtool.VariableClasses.Borehole.Borehole property)
pipe_model() (GHEtool.VariableClasses.PipeData._PipeData._PipeData method)
(GHEtool.VariableClasses.PipeData.CoaxialPipe.CoaxialPipe method)
(GHEtool.VariableClasses.PipeData.MultipleUTube.MultipleUTube method)
plot_load_duration() (GHEtool.main_class.Borefield method)
print_temperature_profile() (GHEtool.main_class.Borefield method)
print_temperature_profile_fixed_depth() (GHEtool.main_class.Borefield method)
R
Rb (GHEtool.main_class.Borefield property)
(GHEtool.VariableClasses.Borehole.Borehole property)
Re (GHEtool.main_class.Borefield property)
(GHEtool.VariableClasses.Borehole.Borehole property)
Re() (GHEtool.VariableClasses.PipeData._PipeData._PipeData method)
(GHEtool.VariableClasses.PipeData.CoaxialPipe.CoaxialPipe method)
(GHEtool.VariableClasses.PipeData.MultipleUTube.MultipleUTube method)
remove_previous_data() (GHEtool.VariableClasses.GFunction.GFunction method)
S
set_borefield() (GHEtool.main_class.Borefield method)
set_fluid_parameters() (GHEtool.main_class.Borefield method)
set_ground_parameters() (GHEtool.main_class.Borefield method)
set_investment_cost() (GHEtool.main_class.Borefield method)
set_length_peak() (GHEtool.main_class.Borefield method)
set_load() (GHEtool.main_class.Borefield method)
set_mass_flow_rate() (GHEtool.VariableClasses.FluidData.FluidData method)
set_max_avg_fluid_temperature() (GHEtool.main_class.Borefield method)
set_min_avg_fluid_temperature() (GHEtool.main_class.Borefield method)
set_new_calculated_data() (GHEtool.VariableClasses.GFunction.GFunction method)
set_options_gfunction_calculation() (GHEtool.main_class.Borefield method)
(GHEtool.VariableClasses.CustomGFunction.CustomGFunction method)
(GHEtool.VariableClasses.GFunction.GFunction method)
set_pipe_parameters() (GHEtool.main_class.Borefield method)
set_Rb() (GHEtool.main_class.Borefield method)
simulation_period (GHEtool.main_class.Borefield property)
SingleUTube (class in GHEtool.VariableClasses.PipeData.SingleUTube)
size() (GHEtool.main_class.Borefield method)
size_L2() (GHEtool.main_class.Borefield method)
size_L3() (GHEtool.main_class.Borefield method)
size_L4() (GHEtool.main_class.Borefield method)
start_month (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
T
time_L3 (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
time_L4 (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
to_dict() (GHEtool.VariableClasses.BaseClass.BaseClass method)
ty (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
U
UnsolvableDueToTemperatureGradient
UPM (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
W
within_range() (GHEtool.VariableClasses.CustomGFunction.CustomGFunction method)
Y
yearly_cooling_load (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
yearly_heating_load (GHEtool.VariableClasses.LoadData._LoadData._LoadData property)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
On Read the Docs
Project Home
Builds