Welcome to honeybee-ph’s documentation!

Passive House extension for honeybee

Honeybee-ph adds Passive House (PHIUS / PHI) functionalities to honeybee for energy modeling and certification.

Installation

pip install -U honeybee-ph

To check if the installation was successful use python -c "import honeybee_ph; print(honeybee_ph)"

honeybee_ph

• honeybee_ph package
  • Subpackages
    • honeybee_ph.properties package
      • Submodules
      • Module contents
  • Submodules
    • honeybee_ph.bldg_segment module
      • BldgSegment
      • PhVentilationSummerBypassMode
      • PhWindExposureType
      • SetPoints
    • honeybee_ph.foundations module
      • PhFoundation
      • PhFoundationFactory
      • PhFoundationType
      • PhHeatedBasement
      • PhSlabEdgeInsulationPosition
      • PhSlabOnGrade
      • PhUnheatedBasement
      • PhVentedCrawlspace
    • honeybee_ph.phi module
      • EnumProperty
      • PHPPSettings10
      • PHPPSettings9
      • PhiCertification
    • honeybee_ph.phius module
      • PhiusBuildingCategoryType
      • PhiusBuildingCertificationProgram
      • PhiusBuildingStatus
      • PhiusBuildingType
      • PhiusBuildingUseType
      • PhiusCertification
    • honeybee_ph.site module
      • Climate
      • Climate_Ground
      • Climate_MonthlyRadiationCollection
      • Climate_MonthlyTempCollection
      • Climate_MonthlyValueSet
      • Climate_PeakLoadCollection
      • Climate_PeakLoadValueSet
      • Location
      • PHPPCodes
      • Site
    • honeybee_ph.space module
      • Space
      • SpaceFloor
      • SpaceFloorSegment
      • SpaceVolume
    • honeybee_ph.team module
      • ProjectTeam
      • ProjectTeamMember
  • Module contents

honeybee_energy_ph

• honeybee_energy_ph package
  • Subpackages
    • honeybee_energy_ph.construction package
      • Submodules
      • Module contents
    • honeybee_energy_ph.hvac package
      • Submodules
      • Module contents
    • honeybee_energy_ph.library package
      • Submodules
      • Module contents
    • honeybee_energy_ph.load package
      • Submodules
      • Module contents
    • honeybee_energy_ph.properties package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • honeybee_energy_ph.boundarycondition module
      • PhAdditionalZone
  • Module contents

honeybee_phhvac

• honeybee_phhvac package
  • Subpackages
    • honeybee_phhvac.properties package
      • Submodules
      • Module contents
  • Submodules
    • honeybee_phhvac.ducting module
      • PhDuctElement
      • PhDuctSegment
    • honeybee_phhvac.fuels module
    • honeybee_phhvac.heat_pumps module
      • UnknownPhHeatPumpTypeError
      • PhHeatPumpAnnual
      • PhHeatPumpCombined
      • PhHeatPumpCoolingParams
      • PhHeatPumpCoolingParams_Base
      • PhHeatPumpCoolingParams_Dehumidification
      • PhHeatPumpCoolingParams_Panel
      • PhHeatPumpCoolingParams_Recirculation
      • PhHeatPumpCoolingParams_Ventilation
      • PhHeatPumpRatedMonthly
      • PhHeatPumpSystem
      • PhHeatPumpSystemBuilder
    • honeybee_phhvac.heating module
      • UnknownPhHeatingTypeError
      • PhHeatingDirectElectric
      • PhHeatingDistrict
      • PhHeatingFossilBoiler
      • PhHeatingSystem
      • PhHeatingSystemBuilder
      • PhHeatingWoodBoiler
    • honeybee_phhvac.hot_water_devices module
      • UnknownPhHvacHotWaterHeaterTypeError
      • PhHvacHotWaterHeater
      • PhHvacHotWaterHeaterBoiler
      • PhHvacHotWaterHeaterBoilerWood
      • PhHvacHotWaterHeaterBuilder
      • PhHvacHotWaterHeaterDistrict
      • PhHvacHotWaterHeaterElectric
      • PhHvacHotWaterHeaterHeatPump_Annual
      • PhHvacHotWaterHeaterHeatPump_Inside
      • PhHvacHotWaterHeaterHeatPump_Monthly
      • PhHvacHotWaterTank
      • PhHvacHotWaterTankType
    • honeybee_phhvac.hot_water_piping module
      • PhHvacPipeBranch
      • PhHvacPipeElement
      • PhHvacPipeMaterial
      • PhHvacPipeSegment
      • PhHvacPipeTrunk
    • honeybee_phhvac.hot_water_system module
      • PhHotWaterSystem_FromDictError
      • PhHotWaterSystem
    • honeybee_phhvac.renewable_devices module
      • UnknownPhRenewableEnergyTypeError
      • PhPhotovoltaicDevice
      • PhRenewableEnergyDevice
      • PhRenewableEnergyDeviceBuilder
    • honeybee_phhvac.supportive_device module
      • PhSupportiveDevice
    • honeybee_phhvac.ventilation module
      • UnknownPhExhaustVentTypeError
      • ExhaustVentDryer
      • ExhaustVentKitchenHood
      • ExhaustVentUserDefined
      • PhExhaustDeviceBuilder
      • PhVentilationSystem
      • Ventilator
  • Module contents

honeybee_ph_utils

• honeybee_ph_utils package
  • Submodules
    • honeybee_ph_utils.aisi_s250_21 module
      • StudSpacingInches
      • StudThicknessMil
      • calculate_stud_cavity_effective_u_value()
      • framing_factor()
      • overall_thermal_zone()
      • overall_thermal_zone_framing_factor()
      • r_value_series_cavity_path()
      • r_value_series_stud_path()
      • stud_web_r_value()
      • u_value_at_stud()
      • u_value_total()
    • honeybee_ph_utils.color module
      • PhColor
    • honeybee_ph_utils.enumerables module
      • ValueNotAllowedError
      • CustomEnum
    • honeybee_ph_utils.face_tools module
      • find_connected_HB_Faces()
      • group_hb_faces()
      • hb_faces_are_touching()
      • points_are_coincident()
      • sort_hb_faces_by_co_planar()
      • sort_hb_faces_by_type()
    • honeybee_ph_utils.histogram module
      • generate_histogram()
    • honeybee_ph_utils.input_tools module
      • clean_get()
      • clean_tree_get()
      • cleaner_get()
      • input_to_int()
      • memoize()
    • honeybee_ph_utils.iso_10077_1 module
      • ISO100771Data
      • build_standard_window()
      • calculate_hb_aperture_uw()
      • calculate_lbt_Face3D_uw()
      • calculate_standard_window_uw()
      • calculate_window_frame_factor()
      • calculate_window_uw()
      • get_honeybee_aperture_width_and_height()
      • get_ladybug_Face3D_width_and_height()
    • honeybee_ph_utils.occupancy module
      • hb_room_annual_avg_occupancy()
      • hb_room_peak_occupancy()
      • hb_room_ppl_per_area()
    • honeybee_ph_utils.polygon2d_tools module
      • counterclockwise_angle_between_2_Planes()
      • get_lbt_Face3D_planes()
      • get_lbt_Face3D_polygon2Ds()
      • merge_lbt_face_polygons()
      • merge_polygon_2ds()
      • move_vector_between_two_points()
      • translate_polygon2D()
    • honeybee_ph_utils.preview module
      • object_preview()
    • honeybee_ph_utils.schedules module
      • FourPartSched
      • SchedItem
      • calc_four_part_vent_sched_values_from_hb_room()
    • honeybee_ph_utils.sky_matrix module
    • honeybee_ph_utils.vector3d_tools module
      • angle_between_2D_vectors()
      • cross_product()
      • dot_product()
      • magnitude()
      • normalize()
      • vector_equal()
    • honeybee_ph_utils.ventilation module
      • hb_room_peak_ventilation_airflow_by_occupancy()
      • hb_room_peak_ventilation_airflow_by_zone()
      • hb_room_peak_ventilation_airflow_total()
      • hb_room_vent_flowrates()
  • Module contents

honeybee_ph_standards

• honeybee_ph_standards package
  • Subpackages
    • honeybee_ph_standards.programtypes package
      • Submodules
      • Module contents
    • honeybee_ph_standards.schedules package
      • Module contents
    • honeybee_ph_standards.sourcefactors package
      • Submodules
      • Module contents
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page