Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Construct location from latitude, lognitude, and time zone data.
name
A name for the location you are constructing. For example, "Steventon Island, Antarctica". (Default: "-")
latitude
Location latitude between -90 and 90 (Default: 0).
longitude
Location longitude between -180 (west) and 180 (east) (Default: 0).
time_zone
Time zone between -12 hours (west) and 12 hours (east). If None, the time zone will be an estimated integer value derived from the longitude in accordance with solar time (Default: None).
elevation
A number for elevation of the location in meters. (Default: 0).
location
Location data (use this output to construct the sun path).
-
Automatically download a .zip file from a URL where climate data resides, unzip the file, and open .epw, .stat, and ddy weather files.
weather_URL [Required]
Text representing the URL at which the climate data resides. To open the a map interface for all publicly availabe climate data, use the "LB EPWmap" component.
folder
An optional file path to a directory into which the weather file will be downloaded and unziped. If None, the weather files will be downloaded to the ladybug default weather data folder and placed in a sub-folder with the name of the weather file location.
epw_file
The file path of the downloaded epw file.
stat_file
The file path of the downloaded stat file.
ddy_file
The file path of the downloaded ddy file.
Import climate data from a standard .epw file.
epw_file [Required]
An .epw file path on your system as a string.
location
A Ladybug Location object describing the location data in the weather file.
dry_bulb_temperature
The houlry dry bulb temperature, in C. Note that this is a full numeric field (i.e. 23.6) and not an integer representation with tenths. Valid values range from 70 C to 70 C. Missing value for this field is 99.9.
dew_point_temperature
The hourly dew point temperature, in C. Note that this is a full numeric field (i.e. 23.6) and not an integer representation with tenths. Valid values range from 70 C to 70 C. Missing value for this field is 99.9.
relative_humidity
The hourly Relative Humidity in percent. Valid values range from 0% to 110%. Missing value for this field is 999.
wind_speed
The hourly wind speed in m/sec. Values can range from 0 to 40. Missing value is 999.
wind_direction
The hourly wind direction in degrees. The convention is North=0.0, East=90.0, South=180.0, West=270.0. If wind is calm for the given hour, the direction equals zero. Values can range from 0 to 360. Missing value is 999.
direct_normal_rad
The hourly Direct Normal Radiation in Wh/m2. Direc Normal Radiation is the amount of solar radiation in Wh/m2 received directly from the solar disk on a surface perpendicular to the sun's rays. Missing values are (9999).
diffuse_horizontal_rad
The hourly Diffuse Horizontal Radiation in Wh/m2. Diffuse Horizontal Radiation is the amount of solar radiation in Wh/m2 received from the sky (excluding the solar disk) on a horizontal surface. Missing values are (9999).
global_horizontal_rad
The hourly Global Horizontal Radiation in Wh/m2. Global Horizontal Radiation is the total amount of direct and diffuse solar radiation in Wh/m2 received on a horizontal surface. It is not currently used inbEnergyPlus calculations. It should have a minimum value of 0; missing value for this field is 9999.
horizontal_infrared_rad
The Horizontal Infrared Radiation Intensity in Wh/m2. If it is missing, EnergyPlus calculates it from the Opaque Sky Cover field. It should have a minimum value of 0; missing value is 9999.
direct_normal_ill
The hourly Direct Normal Illuminance in lux. Direct Normal Illuminance is the average amount of illuminance in lux received directly from the solar disk on a surface perpendicular to the sun's rays. It is not currently used in EnergyPlus calculations. It should have a minimum value of 0; missing value is 999999.
diffuse_horizontal_ill
The hourly Diffuse Horizontal Illuminance in lux. Diffuse Horizontal Illuminance is the average amount of illuminance in lux received from the sky (excluding the solar disk) on a horizontal surface. It is not currently used in EnergyPlus calculations. It should have a minimum value of 0; missing value is 999999.
global_horizontal_ill
The hourly Global Horizontal Illuminance in lux. Global Horizontal Illuminance is the average total amount of direct and diffuse illuminance in lux received on a horizontal surface. It is not currently used in EnergyPlus calculations. It should have a minimum value of 0; missing value is 999999.
total_sky_cover
The fraction for Total Sky Cover in tenths of coverage. (eg. 1 is 1/10 covered. 10 is total coverage). Total Sky Cover is the amount of the sky dome covered by clouds or obscuring phenomena. Minium value is 0; maximum value is 10; missing value is 99.
barometric_pressure
The hourly weather station pressure in Pa. Valid values range from 31,000 to 120,000. Missing value is 999999.
model_year
The year from which the hourly data has been extracted. EPW files are synthesized from real recorded data from different years in a given climate. This is done to ensure that, for each month, the selected data is statistically representative of the average monthly conditions over the 18+ years of recording the data. Different EPW files will be synthesized from different years depeding on whether they are TMY (Typical Meteorological Year), TMY2, TMY3, AMY (Actual Meteorological Year) or other.
ground_temperature
Monthly ground temperature data if it exists within the EPW file. Typically, each data collection in this list represents monthly temperatures at three different depths.
-
Deconstruct location into its component properties.
location [Required]
The output from the importEPW or constructLocation component.
name
Name of the location.
latitude
Latitude of the location.
longitude
Longitude of the location.
time_zone
Time zone of the location.
elevation
Elevation of the location.
Import data from a standard .ddy file.
ddy_file [Required]
A .ddy file path on your system as a string.
location
A Ladybug Location object describing the location data in the DDY file.
design_days
A list of DesignDay objects representing the design days contained within the ddy file.
Import data from a standard .stat file.
stat_file [Required]
A .stat file path on your system as a string.
location
A Ladybug Location object describing the location data in the STAT file.
ashrae_zone
The ASHRAE climate zone of the STAT file. Numbers in the zone denote average temperature (0 = Hottest; 8 = Coldest). Letters in the zone denote wetness (A = Humid; B = Dry; C = Marine)
koppen_zone
The Koppen climate zone of the STAT file. The Koppen climate system uses vegetation as in indicator fo climate and combines average monthly temperatures, precipitation, and the seasonality of precipitation.
clear_dir_norm_rad
The hourly "Clear Sky" Direct Normal Radiation in Wh/m2. Such clear sky radiation is typically used for sizing cooling systems. If monthly optical depths are found within the STAT file, these values will come from the Revised ASHARAE Clear Sky (Tau model). If no optical depths are found, they will come from the original ASHARE lear sky model.
clear_diff_horiz_rad
The hourly "Clear Sky" Diffuse Horizontal Radiation in Wh/m2. Such clear sky radiation is typically used for sizing cooling systems. If monthly optical depths are found within the STAT file, these values will come from the Revised ASHARAE Clear Sky (Tau model). If no optical depths are found, they will come from the original ASHARE lear sky model.
ann_heat_dday_996
A DesignDay object representing the annual 99.6% heating design day.
ann_heat_dday_990
A DesignDay object representing the annual 99.0% heating design day.
ann_cool_dday_004
A DesignDay object representing the annual 0.4% cooling design day.
ann_cool_dday_010
A DesignDay object representing the annual 1.0% cooling design day.
monthly_ddays_050
A list of 12 DesignDay objects representing monthly 5.0% cooling design days.
monthly_ddays_100
A list of 12 DesignDay objects representing monthly 10.0% cooling design days.
extreme_cold_week
A Ladybug AnalysisPeriod object representing the coldest week within the corresponding EPW.
extreme_hot_week
A Ladybug AnalysisPeriod object representing the hottest week within the corresponding EPW.
typical_weeks
A list of Ladybug AnalysisPeriod objects representing typical weeks within the corresponding EPW. The type of week can vary depending on the climate. For mid and high lattitude climates with 4 seasons (eg. New York), these weeks are for each of the 4 seasons ordered as follows: Winter, Spring, Summer, Autumn For low lattitude climates with wet/dry seasons (eg. Mumbai), these weeks might also include: Wet Season, Dry Season For equitorial climates with no seasons (eg. Singapore), This output is usually a single week representing typical conditions of the entire year.
-
Deconstruct design day into parameters.
design_day [Required]
A DesignDay object to deconstruct.
name
The name of the DesignDay object.
day_type
Text indicating the type of design day (ie. 'SummerDesignDay', 'WinterDesignDay' or other EnergyPlus days).
location
A Ladybug Location object describing the location of the design day.
date
Date for the day of the year the design day
dry_bulb_max
Maximum dry bulb temperature over the design day (in C).
dry_bulb_range
Dry bulb range over the design day (in C).
humidity_type
Type of humidity to use. Will be one of the following:
humidity_value
The value of the humidity condition above.
barometric_p
Barometric pressure in Pa.
wind_speed
Wind speed over the design day in m/s.
wind_dir
Wind direction over the design day in degrees.
sky_type
Script output sky_type.
sky_properties
A list of properties describing the sky above. For ASHRAEClearSky this is a single value for clearness. For ASHRAETau, this is the tau_beam and tau_diffuse.
-
Import hourly climate data from a Ladybug DesignDay object.
design_day [Required]
A DesignDay object to import.
location
A Ladybug Location object describing the location of the design day.
dry_bulb_temperature
The houlry dry bulb temperature over the design day, in C.
dew_point_temperature
The hourly dew point temperature over the design day, in C.
relative_humidity
The hourly Relative Humidity over the design day in percent.
wind_speed
The hourly wind speed over the design day in m/sec.
wind_direction
The hourly wind direction over the design day in degrees. The convention is that North=0.0, East=90.0, South=180.0, West=270.0.
direct_normal_rad
The hourly Direct Normal Radiation over the design day in Wh/m2.
diffuse_horizontal_rad
The hourly Diffuse Horizontal Radiation over the design day in Wh/m2.
global_horizontal_rad
The hourly Global Horizontal Radiation over the design day in Wh/m2.
horizontal_infrared_rad
The Horizontal Infrared Radiation Intensity over the design day in Wh/m2.
total_sky_cover
The fraction for total sky cover over the design day in tenths of coverage.
barometric_pressure
The hourly weather station pressure over the design day in Pa.
Produce a DDY file from the data contained within an EPW or STAT file.
For EPW files, this method will first check if there is any heating or cooling design day information contained within the EPW itself. If None is found, the heating and cooling design days will be derived from analysis of the annual data within the EPW. This process of analyzing the annual TMY data is less representative of the climate since only one year of data is used to derive the DDY (instead of the usual multi-year analysis). However, if the EPW is the best available representation of the climate for a given site, it can often be preferable to using a DDY constructed with more years of data but from further away. Information on the uncertainty introduced by using only one year of data to create design days can be found in AHSRAE HOF 2013, Chapter 14.14.
For STAT files, the DDY file will only be produced if the design day information is found within the file. If no information on the relevant design days are found, and error will be raised and the component will fail to run.
weather_file [Required]
The path to an .epw file or .stat file on your system, from which a .ddy will be generated.
percentile
A number between 0 and 50 for the percentile difference from the most extreme conditions within the EPW or STAT to be used for the design day. Typical values are 0.4 and 1.0. (Default: 0.4).
monthly_cool
A boolean to note whether the resulting .ddy file should contain twelve cooling design days for each of the months of the year. This type of DDY file is useful when the peak cooling might not be driven by warm outdoor temperatures but instead by the highest-intensity solar condition, which may not conincide with the highest temperature. Monthly conditions will be for the 2.0% hottest conditions in each month, which generally aligns with the annual 0.4% cooling design conditions.
folder
An optional file path to a directory into which the DDY file will be written. If None, the DDY file will be written to the ladybug default weather data folder and placed in a sub-folder called "ddy".
write [Required]
Set to "True" to write the .ddy file.
ddy_file
A .ddy file path that has been written to your system.
