honeybee_energy.load.process module

Load object used to represent various types of specific processes.

class honeybee_energy.load.process.Process(*args, **kwargs)[source]

Bases: honeybee_energy.load._base._LoadBase

Load object used to represent various types of specific processes.

Examples include kilns, manufacturing equipment, and various industrial processes. They can also be used to represent wood burning fireplaces or certain pieces of equipment to be separated from the other end uses.

Parameters
  • identifier – Text string for a unique Process ID. Must be < 100 characters and not contain any EnergyPlus special characters. This will be used to identify the object across a model and in the exported IDF.

  • watts – A numerical value for the process load power in Watts.

  • schedule – A ScheduleRuleset or ScheduleFixedInterval for the use of process over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts to yield a complete process load profile.

  • fuel_type

    Text to denote the type of fuel consumed by the process. Using the “None” type indicates that no end uses will be associated with the process, only the zone gains. Choose from the following.

    • Electricity

    • NaturalGas

    • Propane

    • FuelOilNo1

    • FuelOilNo2

    • Diesel

    • Gasoline

    • Coal

    • Steam

    • DistrictHeating

    • DistrictCooling

    • OtherFuel1

    • OtherFuel2

    • None

  • end_use_category – Text to indicate the end-use subcategory, which will identify the process load in the output end use table. Examples include “Cooking”, “Clothes Drying”, etc. Setting this to “General” will result in the process load being reported as part of the other Interior Equipment. (Default: Process).

  • radiant_fraction – A number between 0 and 1 for the fraction of the total load given off as long wave radiant heat. (Default: 0).

  • latent_fraction – A number between 0 and 1 for the fraction of the total load that is latent (as opposed to sensible). (Default: 0).

  • lost_fraction – A number between 0 and 1 for the fraction of the total load that is lost outside of the zone and the HVAC system. Typically, this is used to represent heat that is exhausted directly out of a zone (as you would for a stove). (Default: 0).

Properties:
  • identifier

  • display_name

  • watts

  • schedule

  • fuel_type

  • end_use_category

  • radiant_fraction

  • latent_fraction

  • lost_fraction

  • convected_fraction

  • user_data

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Create a Process object from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – A Process dictionary in following the format below.

{
"type": 'Process',
"identifier": 'Wood_Burning_Fireplace_500_03',
"display_name": 'Hearth',
"watts": 500, # watts consumed by the process
"schedule": {}, # ScheduleRuleset/ScheduleFixedInterval dictionary
"fuel_type": 'OtherFuel1',  # Text for the fuel type
"end_use_category": "Fireplaces",  # Text for the end use category
"radiant_fraction": 0.4, # fraction of heat that is long wave radiant
"latent_fraction": 0, # fraction of heat that is latent
"lost_fraction": 0.5 # fraction of heat that is lost
}
classmethod from_dict_abridged(data, schedule_dict)[source]

Create a Process object from an abridged dictionary.

Parameters
  • data – A ProcessAbridged dictionary in following the format below.

  • schedule_dict – A dictionary with schedule identifiers as keys and honeybee schedule objects as values (either ScheduleRuleset or ScheduleFixedInterval). These will be used to assign the schedules to the equipment object.

{
"type": 'ProcessAbridged',
"identifier": 'Wood_Burning_Fireplace_500_03',
"display_name": 'Hearth',
"watts": 500, # watts consumed by the process
"schedule": "Fireplace Usage Schedule", # Schedule identifier
"fuel_type": 'OtherFuel1',  # Text for the fuel type
"end_use_category": "Fireplaces",  # Text for the end use category
"radiant_fraction": 0.4, # fraction of heat that is long wave radiant
"latent_fraction": 0, # fraction of heat that is latent
"lost_fraction": 0.5 # fraction of heat that is lost
}
classmethod from_idf(idf_string, schedule_dict)[source]

Create a Process object from an EnergyPlus OtherEquipment IDF text string.

Note that the OtherEquipment idf_string must use the ‘equipment level’ method in order to be successfully imported.

Parameters
  • idf_string – A text string fully describing an EnergyPlus OtherEquipment definition.

  • schedule_dict – A dictionary with schedule identifiers as keys and honeybee schedule objects as values (either ScheduleRuleset or ScheduleFixedInterval). These will be used to assign the schedules to the OtherEquipment object.

Returns

A tuple with two elements

  • process: An Process object loaded from the idf_string.

  • zone_identifier: The identifier of the zone to which the Process object should be assigned.

lock()
to_dict(abridged=False)[source]

Process dictionary representation.

Parameters

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True), which only specifies the identifiers of schedules. (Default: False).

to_idf(zone_identifier)[source]

IDF string representation of Process object.

Note that this method only outputs a single string for the Process object and, to write everything needed to describe the object into an IDF, this object’s schedule must also be written.

Parameters

zone_identifier – Text for the zone identifier that the Process object is assigned to.

unlock()
FUEL_TYPES = ('Electricity', 'NaturalGas', 'Propane', 'FuelOilNo1', 'FuelOilNo2', 'Diesel', 'Gasoline', 'Coal', 'Steam', 'DistrictHeating', 'DistrictCooling', 'OtherFuel1', 'OtherFuel2', 'None')
property convected_fraction

Get the fraction of process heat that convects to the zone air.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property end_use_category

Get or set text to indicate the end-use subcategory.

property fuel_type

Get or set text to denote the type of fuel consumed by the process.

Choose from the following options.

  • Electricity

  • NaturalGas

  • Propane

  • FuelOilNo1

  • FuelOilNo2

  • Diesel

  • Gasoline

  • Coal

  • Steam

  • DistrictHeating

  • DistrictCooling

  • OtherFuel1

  • OtherFuel2

  • None

property identifier

Get or set the text string for object identifier.

property latent_fraction

Get or set the fraction of process heat that is latent.

property lost_fraction

Get or set the fraction of process heat that is lost out of the zone.

property properties

Get properties for extensions.

property radiant_fraction

Get or set the fraction of process heat given off as long wave radiation.

property schedule

Get or set a ScheduleRuleset or ScheduleFixedInterval for process usage.

property user_data

Get or set an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

property watts

Get or set the process total power in Watts.