ladybug package

Subpackages

• ladybug.cli package
  • Submodules
    • ladybug.cli.setconfig module
    • ladybug.cli.translate module
      • epw_to_ddy()
      • epw_to_wea()
      • wea_to_constant()
  • Module contents
• ladybug.datatype package
  • Submodules
    • ladybug.datatype.angle module
      • Angle
      • WindDirection
    • ladybug.datatype.area module
      • Area
    • ladybug.datatype.base module
      • DataTypeBase
    • ladybug.datatype.current module
      • Current
    • ladybug.datatype.distance module
      • CeilingHeight
      • Distance
      • LiquidPrecipitationDepth
      • PrecipitableWater
      • SnowDepth
      • Visibility
    • ladybug.datatype.energy module
      • Energy
    • ladybug.datatype.energyflux module
      • DiffuseHorizontalIrradiance
      • DirectHorizontalIrradiance
      • DirectNormalIrradiance
      • EffectiveRadiantField
      • EnergyFlux
      • GlobalHorizontalIrradiance
      • HorizontalInfraredRadiationIntensity
      • Irradiance
      • MetabolicRate
    • ladybug.datatype.energyintensity module
      • DiffuseHorizontalRadiation
      • DirectHorizontalRadiation
      • DirectNormalRadiation
      • EnergyIntensity
      • ExtraterrestrialDirectNormalRadiation
      • ExtraterrestrialHorizontalRadiation
      • GlobalHorizontalRadiation
      • Radiation
    • ladybug.datatype.fraction module
      • AerosolOpticalDepth
      • Albedo
      • Fraction
      • HumidityRatio
      • LiquidPrecipitationQuantity
      • OpaqueSkyCover
      • PercentagePeopleDissatisfied
      • RelativeHumidity
      • TotalSkyCover
    • ladybug.datatype.generic module
      • GenericType
    • ladybug.datatype.illuminance module
      • DiffuseHorizontalIlluminance
      • DirectNormalIlluminance
      • GlobalHorizontalIlluminance
      • Illuminance
    • ladybug.datatype.luminance module
      • Luminance
      • ZenithLuminance
    • ladybug.datatype.mass module
      • Mass
    • ladybug.datatype.massflowrate module
      • MassFlowRate
    • ladybug.datatype.power module
      • ActivityLevel
      • Power
    • ladybug.datatype.pressure module
      • AtmosphericStationPressure
      • Pressure
    • ladybug.datatype.rvalue module
      • ClothingInsulation
      • RValue
    • ladybug.datatype.specificenergy module
      • Enthalpy
      • SpecificEnergy
    • ladybug.datatype.speed module
      • AirSpeed
      • Speed
      • WindSpeed
    • ladybug.datatype.temperature module
      • AirTemperature
      • ClothingTemperature
      • CoreBodyTemperature
      • DewPointTemperature
      • DryBulbTemperature
      • GroundTemperature
      • HeatIndexTemperature
      • MeanRadiantTemperature
      • NeutralTemperature
      • OperativeTemperature
      • PhysiologicalEquivalentTemperature
      • PrevailingOutdoorTemperature
      • RadiantTemperature
      • SkinTemperature
      • SkyTemperature
      • StandardEffectiveTemperature
      • Temperature
      • UniversalThermalClimateIndex
      • WetBulbGlobeTemperature
      • WetBulbTemperature
      • WindChillTemperature
    • ladybug.datatype.temperaturedelta module
      • AirTemperatureDelta
      • OperativeTemperatureDelta
      • RadiantTemperatureDelta
      • TemperatureDelta
    • ladybug.datatype.temperaturetime module
      • CoolingDegreeTime
      • HeatingDegreeTime
      • TemperatureTime
    • ladybug.datatype.thermalcondition module
      • CoreTemperatureCategory
      • DiscomfortReason
      • PredictedMeanVote
      • ThermalComfort
      • ThermalCondition
      • ThermalConditionElevenPoint
      • ThermalConditionFivePoint
      • ThermalConditionNinePoint
      • ThermalConditionSevenPoint
      • UTCICategory
    • ladybug.datatype.time module
      • Time
    • ladybug.datatype.uvalue module
      • ConvectionCoefficient
      • RadiantCoefficient
      • UValue
    • ladybug.datatype.voltage module
      • Voltage
    • ladybug.datatype.volume module
      • Volume
    • ladybug.datatype.volumeflowrate module
      • VolumeFlowRate
    • ladybug.datatype.volumeflowrateintensity module
      • VolumeFlowRateIntensity
  • Module contents

Submodules

• ladybug.analysisperiod module
  • AnalysisPeriod
    • ToString()
    • duplicate()
    • from_dict()
    • from_start_end_datetime()
    • from_string()
    • is_possible_hour()
    • is_time_included()
    • to_dict()
    • MONTHNAMES
    • NUMOFDAYSEACHMONTH
    • NUMOFDAYSEACHMONTHLEAP
    • VALIDTIMESTEPS
    • datetimes
    • doys_int
    • end_day
    • end_hour
    • end_month
    • end_time
    • hoys
    • hoys_int
    • is_annual
    • is_leap_year
    • is_overnight
    • is_reversed
    • minute_intervals
    • months_int
    • months_per_hour
    • moys
    • st_day
    • st_hour
    • st_month
    • st_time
    • timestep
• ladybug.climatezone module
  • ashrae_climate_zone()
• ladybug.color module
  • Color
    • ToString()
    • duplicate()
    • from_dict()
    • from_hex()
    • to_dict()
    • to_hex()
    • a
    • b
    • g
    • r
  • ColorRange
    • ToString()
    • color()
    • duplicate()
    • from_dict()
    • to_dict()
    • colors
    • continuous_colors
    • domain
  • Colorset
    • ToString()
    • annual_comfort()
    • benefit()
    • benefit_harm()
    • black_to_white()
    • blue_green_red()
    • cividis()
    • cloud_cover()
    • cold_sensation()
    • ecotect()
    • energy_balance()
    • energy_balance_by_face_type()
    • energy_balance_storage()
    • glare_study()
    • harm()
    • heat_sensation()
    • multi_colored()
    • multicolored_2()
    • multicolored_3()
    • nuanced()
    • openstudio_palette()
    • original()
    • parula()
    • peak_cooling_by_face_type()
    • peak_heating_by_face_type()
    • peak_load_balance()
    • shade_benefit()
    • shade_benefit_harm()
    • shade_harm()
    • shadow_study()
    • therm()
    • thermal_comfort()
    • view_study()
    • viridis()
• ladybug.commandutil module
  • process_content_to_output()
  • run_command_function()
• ladybug.compass module
  • Compass
    • duplicate()
    • label_points_from_angles()
    • max_point3d()
    • min_point3d()
    • point3d_to_orthographic()
    • point3d_to_stereographic()
    • ticks_from_angles()
    • ALTITUDES
    • MAJOR_AZIMUTHS
    • MAJOR_TEXT
    • MINOR_AZIMUTHS
    • MINOR_TEXT
    • PI
    • all_boundary_circles
    • center
    • inner_boundary_circle
    • major_azimuth_points
    • major_azimuth_ticks
    • max_point
    • min_point
    • minor_azimuth_points
    • minor_azimuth_ticks
    • north_angle
    • north_vector
    • orthographic_altitude_circles
    • orthographic_altitude_points
    • radius
    • spacing_factor
    • stereographic_altitude_circles
    • stereographic_altitude_points
• ladybug.config module
  • Folders
    • config_file
    • default_epw_folder
    • ladybug_tools_folder
    • python_exe_path
    • python_package_path
    • python_scripts_path
    • python_version
    • python_version_str
• ladybug.datacollection module
  • DailyCollection
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • average_monthly()
    • compute_function_aligned()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_doys()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • group_by_month()
    • highest_values()
    • histogram()
    • histogram_circular()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • percentile_monthly()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_time_aggregated()
    • to_time_rate_of_change()
    • to_unit()
    • total_monthly()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • total
    • validated_a_period
    • values
  • HourlyContinuousCollection
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • average_daily()
    • average_monthly()
    • average_monthly_per_hour()
    • compute_function_aligned()
    • convert_to_culled_timestep()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • cull_to_timestep()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_hoys()
    • filter_by_moys()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • group_by_day()
    • group_by_month()
    • group_by_month_per_hour()
    • highest_values()
    • histogram()
    • histogram_circular()
    • interpolate_holes()
    • interpolate_to_timestep()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • percentile_daily()
    • percentile_monthly()
    • percentile_monthly_per_hour()
    • to_dict()
    • to_discontinuous()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_time_aggregated()
    • to_time_rate_of_change()
    • to_unit()
    • total_daily()
    • total_monthly()
    • total_monthly_per_hour()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • moys_dict
    • timestep_text
    • total
    • validated_a_period
    • values
  • HourlyDiscontinuousCollection
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • average_daily()
    • average_monthly()
    • average_monthly_per_hour()
    • compute_function_aligned()
    • convert_to_culled_timestep()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • cull_to_timestep()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_hoys()
    • filter_by_moys()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • group_by_day()
    • group_by_month()
    • group_by_month_per_hour()
    • highest_values()
    • histogram()
    • histogram_circular()
    • interpolate_holes()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • percentile_daily()
    • percentile_monthly()
    • percentile_monthly_per_hour()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_time_aggregated()
    • to_time_rate_of_change()
    • to_unit()
    • total_daily()
    • total_monthly()
    • total_monthly_per_hour()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • moys_dict
    • timestep_text
    • total
    • validated_a_period
    • values
  • MonthlyCollection
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • compute_function_aligned()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_months()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • highest_values()
    • histogram()
    • histogram_circular()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_unit()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • total
    • validated_a_period
    • values
  • MonthlyPerHourCollection
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • compute_function_aligned()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_months_per_hour()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • highest_values()
    • histogram()
    • histogram_circular()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_unit()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • total
    • validated_a_period
    • values
• ladybug.datacollectionimmutable module
  • DailyCollectionImmutable
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • average_monthly()
    • compute_function_aligned()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_doys()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • group_by_month()
    • highest_values()
    • histogram()
    • histogram_circular()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • percentile_monthly()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_time_aggregated()
    • to_time_rate_of_change()
    • to_unit()
    • total_monthly()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • total
    • validated_a_period
    • values
  • HourlyContinuousCollectionImmutable
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • average_daily()
    • average_monthly()
    • average_monthly_per_hour()
    • compute_function_aligned()
    • convert_to_culled_timestep()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • cull_to_timestep()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_hoys()
    • filter_by_moys()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • group_by_day()
    • group_by_month()
    • group_by_month_per_hour()
    • highest_values()
    • histogram()
    • histogram_circular()
    • interpolate_holes()
    • interpolate_to_timestep()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • percentile_daily()
    • percentile_monthly()
    • percentile_monthly_per_hour()
    • to_dict()
    • to_discontinuous()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_time_aggregated()
    • to_time_rate_of_change()
    • to_unit()
    • total_daily()
    • total_monthly()
    • total_monthly_per_hour()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • moys_dict
    • timestep_text
    • total
    • validated_a_period
    • values
  • HourlyDiscontinuousCollectionImmutable
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • average_daily()
    • average_monthly()
    • average_monthly_per_hour()
    • compute_function_aligned()
    • convert_to_culled_timestep()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • cull_to_timestep()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_hoys()
    • filter_by_moys()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • group_by_day()
    • group_by_month()
    • group_by_month_per_hour()
    • highest_values()
    • histogram()
    • histogram_circular()
    • interpolate_holes()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • percentile_daily()
    • percentile_monthly()
    • percentile_monthly_per_hour()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_time_aggregated()
    • to_time_rate_of_change()
    • to_unit()
    • total_daily()
    • total_monthly()
    • total_monthly_per_hour()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • moys_dict
    • timestep_text
    • total
    • validated_a_period
    • values
  • MonthlyCollectionImmutable
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • compute_function_aligned()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_months()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • highest_values()
    • histogram()
    • histogram_circular()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_unit()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • total
    • validated_a_period
    • values
  • MonthlyPerHourCollectionImmutable
    • ToString()
    • aggregate_by_area()
    • arange()
    • are_collections_aligned()
    • are_metadatas_aligned()
    • compute_function_aligned()
    • convert_to_ip()
    • convert_to_si()
    • convert_to_unit()
    • duplicate()
    • filter_by_analysis_period()
    • filter_by_conditional_statement()
    • filter_by_months_per_hour()
    • filter_by_pattern()
    • filter_by_range()
    • filter_collections_by_statement()
    • from_dict()
    • get_aligned_collection()
    • highest_values()
    • histogram()
    • histogram_circular()
    • is_collection_aligned()
    • is_in_data_type_range()
    • is_metadata_aligned()
    • linspace()
    • lowest_values()
    • normalize_by_area()
    • pattern_from_collections_and_statement()
    • percentile()
    • to_dict()
    • to_immutable()
    • to_ip()
    • to_mutable()
    • to_si()
    • to_unit()
    • validate_analysis_period()
    • average
    • bounds
    • datetime_strings
    • datetimes
    • header
    • is_continuous
    • is_mutable
    • max
    • median
    • min
    • total
    • validated_a_period
    • values
• ladybug.datautil module
  • collections_from_csv()
  • collections_from_json()
  • collections_from_pkl()
  • collections_to_csv()
  • collections_to_json()
  • collections_to_pkl()
• ladybug.ddy module
  • DDY
    • ToString()
    • duplicate()
    • filter_by_keyword()
    • from_ddy_file()
    • from_design_day()
    • from_dict()
    • save()
    • to_dict()
    • to_file_string()
    • write()
    • design_days
    • file_path
    • location
• ladybug.designday module
  • ASHRAEClearSky
    • ToString()
    • duplicate()
    • from_analysis_period()
    • from_dict()
    • radiation_values()
    • to_dict()
    • SOLAR_MODELS
    • beam_schedule
    • clearness
    • date
    • daylight_savings
    • diffuse_schedule
    • hourly_sky_cover
  • ASHRAETau
    • ToString()
    • duplicate()
    • from_analysis_period()
    • from_dict()
    • radiation_values()
    • to_dict()
    • SOLAR_MODELS
    • beam_schedule
    • date
    • daylight_savings
    • diffuse_schedule
    • hourly_sky_cover
    • tau_b
    • tau_d
    • use_2017
  • DesignDay
    • ToString()
    • duplicate()
    • from_ashrae_dict_cooling()
    • from_ashrae_dict_heating()
    • from_design_day_properties()
    • from_dict()
    • from_idf()
    • to_dict()
    • to_idf()
    • COOLING_KEYS
    • DAY_TYPES
    • EXTREME_KEYS
    • HEATING_KEYS
    • IDF_COMMENTS
    • analysis_period
    • day_type
    • dry_bulb_condition
    • hourly_barometric_pressure
    • hourly_datetimes
    • hourly_dew_point
    • hourly_dry_bulb
    • hourly_horizontal_infrared
    • hourly_relative_humidity
    • hourly_sky_cover
    • hourly_solar_radiation
    • hourly_wind_direction
    • hourly_wind_speed
    • humidity_condition
    • location
    • name
    • sky_condition
    • wind_condition
  • DryBulbCondition
    • ToString()
    • duplicate()
    • from_dict()
    • to_dict()
    • HOURLY_MULTIPLIERS
    • dry_bulb_max
    • dry_bulb_range
    • hourly_values
    • modifier_schedule
    • modifier_type
  • HumidityCondition
    • ToString()
    • dew_point()
    • duplicate()
    • from_dict()
    • hourly_dew_point_values()
    • to_dict()
    • HUMIDITY_TYPES
    • barometric_pressure
    • hourly_pressure
    • humidity_type
    • humidity_value
    • rain
    • schedule
    • snow_on_ground
    • wet_bulb_range
  • WindCondition
    • ToString()
    • duplicate()
    • from_dict()
    • to_dict()
    • hourly_values
    • hourly_wind_dirs
    • wind_direction
    • wind_speed
• ladybug.dt module
  • Date
    • ToString()
    • ctime()
    • from_array()
    • from_date_string()
    • from_dict()
    • from_doy()
    • fromisocalendar()
    • fromisoformat()
    • fromordinal()
    • fromtimestamp()
    • isocalendar()
    • isoformat()
    • isoweekday()
    • replace()
    • strftime()
    • timetuple()
    • to_array()
    • to_dict()
    • today()
    • toordinal()
    • weekday()
    • day
    • doy
    • leap_year
    • max
    • min
    • month
    • resolution
    • year
  • DateTime
    • ToString()
    • add_hour()
    • add_minute()
    • astimezone()
    • combine()
    • ctime()
    • dst()
    • from_array()
    • from_date_and_time()
    • from_date_time_string()
    • from_dict()
    • from_first_hour()
    • from_hoy()
    • from_last_hour()
    • from_moy()
    • fromisocalendar()
    • fromisoformat()
    • fromordinal()
    • fromtimestamp()
    • isocalendar()
    • isoformat()
    • isoweekday()
    • now()
    • replace()
    • strftime()
    • strptime()
    • sub_hour()
    • sub_minute()
    • timestamp()
    • timetuple()
    • timetz()
    • to_array()
    • to_dict()
    • to_simple_string()
    • today()
    • toordinal()
    • tzname()
    • utcfromtimestamp()
    • utcnow()
    • utcoffset()
    • utctimetuple()
    • weekday()
    • date
    • day
    • doy
    • float_hour
    • fold
    • hour
    • hoy
    • int_hoy
    • leap_year
    • max
    • microsecond
    • min
    • minute
    • month
    • moy
    • resolution
    • second
    • time
    • tzinfo
    • year
  • Time
    • ToString()
    • dst()
    • from_array()
    • from_dict()
    • from_mod()
    • from_time_string()
    • fromisoformat()
    • isoformat()
    • replace()
    • strftime()
    • to_array()
    • to_dict()
    • tzname()
    • utcoffset()
    • float_hour
    • fold
    • hour
    • max
    • microsecond
    • min
    • minute
    • mod
    • resolution
    • second
    • tzinfo
• ladybug.epw module
  • EPW
    • ToString()
    • approximate_design_day()
    • best_available_design_days()
    • convert_to_ip()
    • convert_to_si()
    • from_dict()
    • from_file_string()
    • from_missing_values()
    • import_data_by_field()
    • monthly_cooling_design_days()
    • save()
    • to_ddy()
    • to_ddy_monthly_cooling()
    • to_dict()
    • to_file_string()
    • to_mos()
    • to_wea()
    • write()
    • aerosol_optical_depth
    • albedo
    • annual_cooling_design_day_004
    • annual_cooling_design_day_010
    • annual_heating_design_day_990
    • annual_heating_design_day_996
    • ashrae_climate_zone
    • atmospheric_station_pressure
    • ceiling_height
    • comments_1
    • comments_2
    • cooling_design_condition_dictionary
    • daylight_savings_end
    • daylight_savings_start
    • days_since_last_snowfall
    • dew_point_temperature
    • diffuse_horizontal_illuminance
    • diffuse_horizontal_radiation
    • direct_normal_illuminance
    • direct_normal_radiation
    • dry_bulb_temperature
    • extraterrestrial_direct_normal_radiation
    • extraterrestrial_horizontal_radiation
    • extreme_cold_weeks
    • extreme_design_condition_dictionary
    • extreme_hot_weeks
    • file_path
    • global_horizontal_illuminance
    • global_horizontal_radiation
    • header
    • heating_design_condition_dictionary
    • horizontal_infrared_radiation_intensity
    • is_data_loaded
    • is_header_loaded
    • is_ip
    • is_leap_year
    • liquid_precipitation_depth
    • liquid_precipitation_quantity
    • location
    • metadata
    • monthly_ground_temperature
    • opaque_sky_cover
    • precipitable_water
    • present_weather_codes
    • present_weather_observation
    • relative_humidity
    • sky_temperature
    • snow_depth
    • total_sky_cover
    • typical_weeks
    • visibility
    • wind_direction
    • wind_speed
    • years
    • zenith_luminance
  • EPWField
    • missing
    • name
    • unit
    • value_type
  • EPWFields
    • field_by_number()
• ladybug.futil module
  • copy_file_tree()
  • copy_files_to_folder()
  • csv_to_matrix()
  • csv_to_num_matrix()
  • download_file()
  • download_file_by_name()
  • nukedir()
  • preparedir()
  • unzip_file()
  • write_to_file()
  • write_to_file_by_name()
• ladybug.graphic module
  • GraphicContainer
    • ToString()
    • from_dict()
    • to_dict()
    • data_type
    • legend
    • legend_parameters
    • lower_title_location
    • max_point
    • min_point
    • unit
    • upper_title_location
    • value_colors
    • values
• ladybug.header module
  • Header
    • ToString()
    • duplicate()
    • from_csv_strings()
    • from_dict()
    • to_csv_strings()
    • to_dict()
    • to_tuple()
    • analysis_period
    • data_type
    • metadata
    • unit
• ladybug.hourlyplot module
  • HourlyPlot
    • custom_hour_label_points2d()
    • custom_hour_label_points3d()
    • custom_hour_labels()
    • custom_hour_lines2d()
    • custom_hour_lines3d()
    • from_z_dim_per_unit()
    • HOUR_LABELS
    • analysis_period
    • base_point
    • chart_border2d
    • chart_border3d
    • colored_mesh2d
    • colored_mesh3d
    • colors
    • data_collection
    • hour_label_points2d
    • hour_label_points3d
    • hour_labels
    • hour_labels_24
    • hour_lines2d
    • hour_lines3d
    • legend
    • legend_parameters
    • lower_title_location
    • month_label_points2d
    • month_label_points3d
    • month_labels
    • month_lines2d
    • month_lines3d
    • reverse_y
    • title_text
    • upper_title_location
    • values
    • x_dim
    • y_dim
    • z_dim
• ladybug.legend module
  • Legend
    • ToString()
    • color_map_2d()
    • duplicate()
    • from_dict()
    • parse_dim_2d()
    • segment_text_location_2d()
    • title_location_2d()
    • to_dict()
    • color_range
    • is_max_default
    • is_min_default
    • legend_parameters
    • segment_colors
    • segment_length
    • segment_mesh
    • segment_mesh_scene_2d
    • segment_numbers
    • segment_text
    • segment_text_location
    • segment_text_location_scene_2d
    • title
    • title_location
    • title_location_scene_2d
    • value_colors
    • values
  • Legend2DParameters
    • ToString()
    • duplicate()
    • from_dict()
    • to_dict()
    • valid_dim_string()
    • VALID_DIM
    • is_default
    • is_origin_x_default
    • is_origin_y_default
    • is_segment_height_default
    • is_segment_width_default
    • is_text_height_default
    • origin_x
    • origin_y
    • segment_height
    • segment_width
    • text_height
  • Legend3DParameters
    • ToString()
    • duplicate()
    • from_dict()
    • to_dict()
    • base_plane
    • is_base_plane_default
    • is_default
    • is_segment_height_default
    • is_segment_width_default
    • is_text_height_default
    • segment_height
    • segment_width
    • text_height
  • LegendParameters
    • ToString()
    • colors_by_set()
    • duplicate()
    • from_dict()
    • to_dict()
    • are_colors_default
    • base_plane
    • colors
    • continuous_legend
    • decimal_count
    • font
    • include_larger_smaller
    • is_base_plane_default
    • is_origin_x_default
    • is_origin_y_default
    • is_segment_count_default
    • is_segment_height_2d_default
    • is_segment_height_default
    • is_segment_width_2d_default
    • is_segment_width_default
    • is_text_height_2d_default
    • is_text_height_default
    • is_title_default
    • max
    • min
    • ordinal_dictionary
    • origin_x
    • origin_y
    • properties_2d
    • properties_3d
    • segment_count
    • segment_height
    • segment_height_2d
    • segment_width
    • segment_width_2d
    • text_height
    • text_height_2d
    • title
    • user_data
    • vertical
  • LegendParametersCategorized
    • ToString()
    • colors_by_set()
    • duplicate()
    • from_dict()
    • to_dict()
    • are_colors_default
    • base_plane
    • category_names
    • colors
    • continuous_colors
    • continuous_legend
    • decimal_count
    • domain
    • font
    • include_larger_smaller
    • is_base_plane_default
    • is_origin_x_default
    • is_origin_y_default
    • is_segment_count_default
    • is_segment_height_2d_default
    • is_segment_height_default
    • is_segment_width_2d_default
    • is_segment_width_default
    • is_text_height_2d_default
    • is_text_height_default
    • is_title_default
    • max
    • min
    • ordinal_dictionary
    • origin_x
    • origin_y
    • properties_2d
    • properties_3d
    • segment_count
    • segment_height
    • segment_height_2d
    • segment_width
    • segment_width_2d
    • text_height
    • text_height_2d
    • title
    • user_data
    • vertical
• ladybug.location module
  • Location
    • ToString()
    • duplicate()
    • from_dict()
    • from_idf()
    • from_location()
    • to_dict()
    • to_idf()
    • city
    • country
    • elevation
    • is_default
    • latitude
    • longitude
    • meridian
    • source
    • state
    • station_id
    • time_zone
• ladybug.logutil module
  • get_logger()
• ladybug.monthlychart module
  • MonthlyChart
    • set_maximum_by_index()
    • set_minimum_by_index()
    • HOUR_LABELS
    • analysis_period
    • base_point
    • chart_border
    • colors
    • data_collections
    • data_meshes
    • data_polylines
    • data_polylines_with_colors
    • data_types
    • legend
    • legend_parameters
    • lower_title_location
    • month_label_points
    • month_labels
    • month_lines
    • percentile
    • stack
    • time_interval
    • time_label_points
    • time_labels
    • time_ticks
    • title_text
    • upper_title_location
    • x_dim
    • y_axis_label_points1
    • y_axis_label_points2
    • y_axis_labels1
    • y_axis_labels2
    • y_axis_lines
    • y_axis_title_location1
    • y_axis_title_location2
    • y_axis_title_text1
    • y_axis_title_text2
    • y_dim
• ladybug.north module
  • WorldMagneticModel
    • ToString()
    • magnetic_declination()
    • magnetic_to_true_north()
• ladybug.psychchart module
  • PsychrometricChart
    • ToString()
    • data_mesh()
    • from_dict()
    • from_epw()
    • hr_y_value()
    • plot_point()
    • relative_humidity_polyline()
    • t_x_value()
    • to_dict()
    • ACCEPTABLE_COLLECTIONS
    • ENTH_TYPE
    • TEMP_TYPE
    • average_pressure
    • base_point
    • chart_border
    • colored_mesh
    • container
    • data_points
    • enthalpy_label_points
    • enthalpy_labels
    • enthalpy_lines
    • hour_values
    • hr_label_points
    • hr_labels
    • hr_lines
    • legend
    • legend_parameters
    • max_humidity_ratio
    • max_temperature
    • min_temperature
    • relative_humidity
    • rh_label_points
    • rh_labels
    • rh_lines
    • saturation_line
    • temperature
    • temperature_label_points
    • temperature_labels
    • temperature_lines
    • time_matrix
    • title_location
    • title_text
    • use_ip
    • wb_label_points
    • wb_labels
    • wb_lines
    • x_axis_location
    • x_axis_text
    • x_dim
    • y_axis_location
    • y_axis_text
    • y_dim
• ladybug.psychrometrics module
  • db_temp_and_hr_from_wb_rh()
  • db_temp_from_enth_hr()
  • db_temp_from_rh_hr()
  • dew_point_from_db_enth()
  • dew_point_from_db_hr()
  • dew_point_from_db_rh()
  • dew_point_from_db_rh_fast()
  • dew_point_from_db_wb()
  • enthalpy_from_db_hr()
  • humid_ratio_from_db_rh()
  • humid_ratio_from_db_wb()
  • rel_humid_from_db_dpt()
  • rel_humid_from_db_enth()
  • rel_humid_from_db_hr()
  • rel_humid_from_db_wb()
  • saturated_vapor_pressure()
  • wet_bulb_from_db_hr()
  • wet_bulb_from_db_rh()
  • wet_bulb_from_db_rh_fast()
• ladybug.rootfinding module
  • bisect()
  • secant()
  • secant_three_var()
• ladybug.skymodel module
  • ashrae_clear_sky()
  • ashrae_revised_clear_sky()
  • calc_horizontal_infrared()
  • calc_sky_temperature()
  • clearness_index()
  • clearness_index_zenith_independent()
  • dirint()
  • disc()
  • estimate_illuminance_from_irradiance()
  • get_absolute_airmass()
  • get_extra_radiation()
  • get_relative_airmass()
  • zhang_huang_solar()
  • zhang_huang_solar_split()
• ladybug.solarenvelope module
  • SolarEnvelope
    • envelope_mesh()
    • base_height
    • geometry_mesh
    • geometry_point2ds
    • height_limit
    • obstacle_faces
    • obstacle_polygon2ds
    • solar_rights
    • sun_vector2ds
    • sun_vector2ds_reversed
    • sun_vectors
• ladybug.sql module
  • ComponentSize
    • ToString()
    • from_dict()
    • to_dict()
    • component_name
    • component_type
    • descriptions
    • properties
    • properties_dict
    • units
    • values
  • SQLiteResult
    • ToString()
    • component_sizes_by_type()
    • data_collections_by_output_name()
    • data_collections_by_output_name_run_period()
    • tabular_column_names()
    • tabular_data_by_name()
    • values_by_output_name()
    • available_outputs
    • available_outputs_info
    • component_sizes
    • component_types
    • file_path
    • location
    • reporting_frequency
    • run_period_indices
    • run_period_names
    • run_periods
    • zone_cooling_sizes
    • zone_heating_sizes
  • ZoneSize
    • ToString()
    • from_dict()
    • to_dict()
    • calculated_design_flow
    • calculated_design_load
    • design_day_name
    • final_design_flow
    • final_design_load
    • load_type
    • peak_date_time
    • peak_humidity_ratio
    • peak_outdoor_air_flow
    • peak_temperature
    • zone_name
• ladybug.stat module
  • STAT
    • ToString()
    • from_dict()
    • to_ddy()
    • to_ddy_monthly_cooling()
    • to_dict()
    • annual_cooling_design_day_004
    • annual_cooling_design_day_010
    • annual_heating_design_day_990
    • annual_heating_design_day_996
    • ashrae_climate_zone
    • extreme_cold_week
    • extreme_hot_week
    • file_path
    • koppen_climate_zone
    • location
    • monthly_clear_sky_conditions
    • monthly_cooling_design_days_004
    • monthly_cooling_design_days_020
    • monthly_cooling_design_days_050
    • monthly_cooling_design_days_100
    • monthly_db_temp_050
    • monthly_db_temp_range_050
    • monthly_found
    • monthly_tau_beam
    • monthly_tau_diffuse
    • monthly_wb_temp_050
    • monthly_wb_temp_range_050
    • monthly_wind_conditions
    • monthly_wind_dirs
    • monthly_ws_avg
    • other_typical_weeks
    • standard_pressure_at_elev
    • typical_autumn_week
    • typical_spring_week
    • typical_summer_week
    • typical_winter_week
• ladybug.sunpath module
  • Sun
    • ToString()
    • position_2d()
    • position_3d()
    • PI
    • altitude
    • altitude_in_radians
    • azimuth
    • azimuth_from_y_axis
    • azimuth_in_radians
    • data
    • datetime
    • hoy
    • is_daylight_saving
    • is_during_day
    • is_solar_time
    • north_angle
    • sun_vector
    • sun_vector_reversed
  • Sunpath
    • analemma_suns()
    • calculate_sun()
    • calculate_sun_from_date_time()
    • calculate_sun_from_hoy()
    • calculate_sun_from_moy()
    • calculate_sunrise_sunset()
    • calculate_sunrise_sunset_from_datetime()
    • day_arc3d()
    • day_polyline2d()
    • from_location()
    • hourly_analemma_polyline2d()
    • hourly_analemma_polyline3d()
    • hourly_analemma_suns()
    • is_daylight_saving_hour()
    • monthly_day_arc3d()
    • monthly_day_polyline2d()
    • PI
    • daylight_saving_period
    • is_leap_year
    • latitude
    • longitude
    • north_angle
    • time_zone
• ladybug.viewsphere module
  • ViewSphere
    • dome_patch_weights()
    • dome_patches()
    • dome_radial_patch_weights()
    • dome_radial_patches()
    • dome_view_mesh()
    • fin_pattern()
    • horizontal_circle_view_mesh()
    • horizontal_radial_patch_weights()
    • horizontal_radial_patches()
    • horizontal_radial_vectors()
    • horizontal_radial_view_mesh()
    • orientation_pattern()
    • overhang_pattern()
    • sphere_patch_weights()
    • sphere_patches()
    • sphere_view_mesh()
    • REINHART_COEFFICIENTS
    • REINHART_PATCHES_PER_ROW
    • TREGENZA_COEFFICIENTS
    • TREGENZA_PATCHES_PER_ROW
    • reinhart_dome_mesh
    • reinhart_dome_vectors
    • reinhart_solid_angles
    • reinhart_sphere_mesh
    • reinhart_sphere_vectors
    • tregenza_dome_mesh
    • tregenza_dome_mesh_high_res
    • tregenza_dome_vectors
    • tregenza_solid_angles
    • tregenza_sphere_mesh
    • tregenza_sphere_vectors
• ladybug.wea module
  • Wea
    • ToString()
    • count_timesteps()
    • directional_irradiance()
    • duplicate()
    • estimate_illuminance_components()
    • filter_by_analysis_period()
    • filter_by_hoys()
    • filter_by_moys()
    • filter_by_pattern()
    • filter_by_sun_up()
    • from_annual_values()
    • from_ashrae_clear_sky()
    • from_ashrae_revised_clear_sky()
    • from_daysim_file()
    • from_dict()
    • from_epw_file()
    • from_file()
    • from_stat_file()
    • from_zhang_huang_solar()
    • get_irradiance_value()
    • get_irradiance_value_for_hoy()
    • to_constant_value()
    • to_dict()
    • to_file_string()
    • write()
    • analysis_period
    • datetimes
    • diffuse_horizontal_irradiance
    • direct_horizontal_irradiance
    • direct_normal_irradiance
    • enforce_on_hour
    • global_horizontal_irradiance
    • header
    • hoys
    • is_annual
    • is_continuous
    • is_leap_year
    • location
    • metadata
    • timestep
• ladybug.windprofile module
  • WindProfile
    • ToString()
    • calculate_wind()
    • calculate_wind_data()
    • height_axis()
    • legend_plane()
    • mesh_arrow()
    • mesh_arrow_profile()
    • profile_polyline3d()
    • speed_axis()
    • title_plane()
    • wind_vector()
    • BLACK
    • TERRAINS
    • TERRAIN_PARAMETERS
    • boundary_layer_height
    • log_law
    • met_boundary_layer_height
    • met_power_law_exponent
    • met_roughness_length
    • meteorological_height
    • meteorological_terrain
    • power_law_exponent
    • roughness_length
    • terrain
• ladybug.windrose module
  • WindRose
    • prevailing_direction_from_data()
    • DEFAULT_BASE_POINT
    • DEFAULT_FREQUENCY_HOURS
    • DEFAULT_FREQUENCY_SPACING
    • DEFAULT_NORTH
    • analysis_data_collection
    • analysis_period
    • analysis_values
    • angles
    • base_point
    • bin_vectors
    • color_range
    • colored_mesh
    • compass
    • compass_radius
    • container
    • direction_data_collection
    • direction_values
    • frequency_hours
    • frequency_intervals_compass
    • frequency_intervals_mesh
    • frequency_lines
    • frequency_maximum
    • frequency_spacing_distance
    • frequency_spacing_hypot_distance
    • histogram_data
    • legend
    • legend_parameters
    • mesh_radius
    • north
    • orientation_lines
    • prevailing_direction
    • real_freq_max
    • show_freq
    • show_zeros
    • windrose_lines
    • zero_count
    • zeros_per_bin

Module contents