API Reference › io_hot_water

io_hot_water

Controller Class for the PHPP “DHW+Distribution” worksheet.

Source: PHX/io_hot_water.py


RecircPiping

The Recirculation Piping Section Group

Attributes

AttributeTypeDescription
xl——
shape——

Properties

PropertyTypeDescription
header_row——

Methods

find_header_row(_row_start, _rows)

ArgTypeDescription
_row_start——
_rows——

BranchPiping

The Branch Piping Section Group

Attributes

AttributeTypeDescription
xl——
shape——

Properties

PropertyTypeDescription
header_row——

Methods

find_header_row(_row_start, _rows)

ArgTypeDescription
_row_start——
_rows——

DHWPiping

The DHW Piping Section Group

Attributes

AttributeTypeDescription
xl——
shape——
recirc_pipingRecircPiping—
branch_pipingBranchPiping—

Properties

PropertyTypeDescription
header_row——

Methods

find_header_row(_row_start, _row_end)

ArgTypeDescription
_row_start——
_row_end——

find_recirc_piping_start_row()

find_branch_piping_start_row()


TankData

Convenience Wrapper for Tank Data read in from the PHPP.

Methods

classmethod from_phpp_data(_d)

ArgTypeDescription
_d——

Tank

An individual tank entry item.

Attributes

AttributeTypeDescription
xl——
shape——

Properties

PropertyTypeDescription
entry_row_start—The row where the tank entry starts.

Methods

find_entry_row_start()

Find the row where the tank entry starts.

get_phpp_data(_tank_num)

Get the PHPP data for the specified tank number.

ArgTypeDescription
_tank_num——

Tanks

The Tanks (Storage Heat Loss) Section Group

Attributes

AttributeTypeDescription
xl——
shape——
tank_1Tank—
tank_2Tank—

Properties

PropertyTypeDescription
header_row—The row where the tank header starts.

Methods

find_header_row(_row_start, _row_end)

Find the row where the tank header starts.

ArgTypeDescription
_row_start——
_row_end——

get_all_tank_device_data()

Get all the tank data from the spreadsheet.


HotWater

IO Controller for the PHPP ‘DHW+Distribution’ PHPP worksheet.

Attributes

AttributeTypeDescription
xl——
shape——
tanksTanks—
dhw_pipingDHWPiping—

Methods

write_tanks(_phpp_hw_tanks)

Write the tank data to the spreadsheet.

ArgTypeDescription
_phpp_hw_tanks——

write_branch_piping(_phpp_branch_piping)

Write the branch piping data to the spreadsheet.

ArgTypeDescription
_phpp_branch_piping——

write_recirc_piping(_phpp_recirc_piping)

Write the recirc piping data to the spreadsheet.

ArgTypeDescription
_phpp_recirc_piping——

get_all_tank_device_data()

Get all the tank data from the PHPP worksheet.