ladybug.datatype.temperature module — ladybug documentation

class ladybug.datatype.temperature.AirTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.ClothingTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.CoreBodyTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.DewPointTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.DryBulbTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.GroundTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.HeatIndexTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.MeanRadiantTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.NeutralTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.OperativeTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.PhysiologicalEquivalentTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.PrevailingOutdoorTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.RadiantTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.SkinTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.SkyTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.StandardEffectiveTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.Temperature(name=None)[source]¶

Bases: DataTypeBase

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)[source]¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)[source]¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)[source]¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.UniversalThermalClimateIndex(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.WetBulbGlobeTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.WetBulbTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

class ladybug.datatype.temperature.WindChillTemperature(name=None)[source]¶

Bases: Temperature

ToString()¶: Overwrite .NET ToString.

duplicate()¶: Return a copy of the data type.

classmethod from_dict(data)¶

Create a data type from a dictionary.

Parameters:: data – A python dictionary in the following format

{
    "name": ""  # data type name of the data type as a string
    "data_type": ""  # the class name of the data type as a string
}

classmethod from_string(data_type_string)¶

Create a data type from a string.

Parameters:: data – A data type string.

is_in_range(values, unit=None, raise_exception=True)¶

Check if a list of values is within physically/mathematically possible range.

Parameters:

values – A list of values.
unit – The unit of the values. If not specified, the default metric unit will be assumed.
raise_exception – Set to True to raise an exception if not in range.

is_unit_acceptable(unit, raise_exception=True)¶

Check if a certain unit is acceptable for the data type.

Parameters:

unit – A text string representing the abbreviated unit.
raise_exception – Set to True to raise an exception if not acceptable.

to_dict()¶: Get data type as a dictionary.

to_ip(values, from_unit)¶: Return values in IP and the units to which the values have been converted.

to_si(values, from_unit)¶: Return values in SI and the units to which the values have been converted.

to_string()¶: Get data type as a string.

to_unit(values, unit, from_unit)¶: Return values converted to the unit given the input from_unit.

property abbreviation¶

An optional abbreviation for the data type as text.

(eg. ‘UTCI’ for Universal Thermal Climate Index). This can also be a letter that represents the data type in a formula. (eg. ‘A’ for Area; ‘P’ for Pressure)

property cumulative¶

Boolean to note if data type can be summed over time to yield meaningful data.

If False, this data type can only be averaged over time to be meaningful. Note that cumulative cannot be True when point_in_time is also True. (False Examples: Temperature, Irradiance, Illuminance) (True Examples: Energy, Radiation)

property ip_units¶: A tuple of acceptable ip_units for the data type.

property max¶

Number for the upper limit for the data type.

Values above this limit should be physically or mathematically impossible.

property min¶

Number for the lower limit for the data type.

Values below this limit should be physically or mathematically impossible.

property name¶: The full name of the data type as a string.

property normalized_type¶

A data type object representing the area-normalized version of this data type.

This will be None if the data type cannot be normalized per unit area to yield a meaningful data type.

property point_in_time¶

Boolean to note whether data type is for a single instant in time.

If False, the data type is meant to represent an average or accumulation over time whenever found in an array of time series data. (True Examples: Temperature, WindSpeed) (False Examples: Energy, Radiation, Illuminance)

property si_units¶: A tuple of acceptable si_units for the data type.

property time_aggregated_factor¶

A number to convert to the base unit of the type to the time aggregated unit.

The factor assumes that the data is aggregated over one hour. This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property time_aggregated_type¶

A data type object representing the time-aggregated version of this data type.

This will be None if the data type cannot be aggregated per unit time to yield a meaningful data type.

property unit_descr¶

A dictionary that matches numerical values to text categories.

This will be None if there are no text categories that the data type can be mapped to. (eg. -1 = Cold, 0 = Neutral, +1 = Hot) (eg. 0 = False, 1 = True).

property units¶

A tuple of all acceptable units of the data type as abbreviated text.

The first item of the list should be the standard SI unit. The second item of the list should be the standard IP unit (if it exists). The rest of the list can be any other acceptable units. (eg. [C, F, K])

ladybug.datatype.temperature module¶