honeybee_ph.properties.space module

class honeybee_ph.properties.space.SpacePhProperties(_host: SpaceProperties | None)[source]

Bases: object

ToString()[source]
duplicate(new_host: Any | None = None) → SpacePhProperties[source]
classmethod from_dict(data: dict, host: Any) → SpacePhProperties[source]
to_dict(abridged: bool = False) → dict[str, dict][source]
property has_ventilation_flow_rates: bool

Return True if any of the Passive House ventilation flow rate overrides (sup, eta, trans) are set.

property honeybee_flow_rate: float | None

Return the maximum of the Passive House ventilation flow rate overrides (sup, eta, trans), or None if none are set.

property host: SpaceProperties | None
property host_name: str
class honeybee_ph.properties.space.SpaceProperties(host: space.Space | None)[source]

Bases: _Properties

Honeybee-PH Space Properties.

Space properties. This class will be extended by extensions.

Usage:

space = Space()
space.properties -> SpaceProperties
space.properties.ph -> SpacePhProperties
space.properties.energy -> SpaceEnergyProperties
ToString()

Overwrite .NET ToString method.

add_prefix(prefix)[source]

Change the identifier extension attributes unique to this object by adding a prefix.

Notably, this method only adds the prefix to extension attributes that must be unique to the Space (eg. single-room HVAC systems) and does not add the prefix to attributes that are shared across several Spaces (eg. ConstructionSets).

Parameters:

prefix – Text that will be inserted at the start of extension attribute identifiers.

classmethod from_dict(_dict: Dict = {}, _host: Any | None = None) → SpaceProperties[source]
is_equivalent(other_properties)

Get a dictionary noting the equivalency of these properties to other ones.

The keys of this dictionary will note the name of each extension (eg. energy, radiance) and the values will be a boolean for whether the extension properties are equivalent or not.

Parameters:

other_properties – Properties of another object for which equivalency will be tested.

move(moving_vec)

Apply a move transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be moved alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be moved if the host aperture is moved.

Parameters:

moving_vec – A ladybug_geometry Vector3D with the direction and distance to move the face.

reflect(plane)

Apply a reflection transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be reflected alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be reflected if the host aperture is reflected.

Parameters:

plane – A ladybug_geometry Plane across which the object will be reflected.

reset_to_default()[source]

Reset the extension properties assigned at the level of this Room to default.

This typically means erasing any ConstructionSets or ModifierSets assigned to this Space among other properties.

rotate(axis, angle, origin)

Apply a rotation transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be rotated alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be rotated if the host aperture is rotated.

Parameters:

  • axis – A ladybug_geometry Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

  • origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

rotate_xy(angle, origin)

Apply a rotation in the XY plane to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be rotated alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be rotated if the host aperture is rotated.

Parameters:

  • angle – An angle in degrees.

  • origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

scale(factor: float, origin: Point3D | None = None) → None[source]

Apply a scale transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be scaled alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be scaled if the host aperture is scaled.

Arguments:

  • factor (float): The scale factor

  • origin (Optional[geometry3d.Point3D]): default=None, A ladybug_geometry

    Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

Returns:

  • None

to_dict(abridged=False, include=None)[source]

Convert properties to dictionary.

Parameters:

  • abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.

  • include – A list of keys to be included in dictionary. If None all the available keys will be included.

property energy
property host: space.Space | None

Get the object hosting these properties.

property host_name: str
property ph
honeybee_ph.properties.space.get_ph_prop_from_space(_space: space.Space) → SpacePhProperties[source]

Get the space’s PH-Properties.