ladybug primer

0

1

1.1

1.1.1

1.1.2

1.1.3

1.1.4

1.1.5

1.1.6

1.1.7

1.1.8

1.1.9

1.1.10

1.1.11

1.2

1.2.1

1.2.2

1.2.3

1.2.4

1.2.5

1.2.6

1.2.7

1.2.8

1.2.9

1.2.10

1.2.11

1.2.12

1.2.13

1.3

1.3.1

TableofContentsWhatisthispremier?

Components

0|Ladybug

Ladybug

Import_epw

Open_EPW_And_STAT_Weather_Files

Open_EPW_Weather_File

download_EPW_Weather_File

Construct_Location

Decompose_Location

Import_Location

Import_stat

Open_STAT_File

Create_LB_Header

1|AnalyzeWeatherData

Analysis_Period

Average_Data

Branch_Data

Separate_data

CDD_HDD

Wind_Speed_Calculator

Adaptive_Comfort_Calculator

Outdoor_Comfort_Calculator

PMV_Comfort_Calculator

Thermal_Comfort_Indices

CDH_HDH

Clothing_Function

Humidity_Ratio_Calculator

2|VisualizeWeatherData

3D_Chart

LadybugPrimer

2

1.3.2

1.3.3

1.3.4

1.3.5

1.3.6

1.3.7

1.3.8

1.3.9

1.3.10

1.3.11

1.3.12

1.3.13

1.3.14

1.3.15

1.4

1.4.1

1.4.2

1.4.3

1.4.4

1.4.5

1.4.6

1.4.7

1.4.8

1.4.9

1.4.10

1.4.11

1.4.12

1.4.13

1.4.14

1.4.15

1.4.16

1.4.17

1.4.18

1.5

Adaptive_Comfort_Chart

Monthly_Bar_Chart

Psychrometric_Chart

GenCumulativeSkyMtx

selectSkyMtx

Colored_Sky_Visualizer

Outdoor_Solar_Temperature_Adjustor

Radiation_Calla_Lily

Radiation_Rose

Sky_Dome

SunPath

Wind_Boundary_Profile

Wind_Rose

Import_Ground_Temp

3|EnvironmentalAnalysis

Radiation_Analysis

Sunlight_Hours_Analysis

Bounce_from_Surface

View_Analysis

View_From_Sun

view_Rose

Comfort_Shade_Benefit_Evaluator

ShadingDesigner

SolarEnvelope

SolarFan

DC_to_AC_derate_factor

Photovoltaics_Performance_Metrics

Photovoltaics_Surface

Sunpath_Shading

Tilt_And_Orientation_Factor

Forward_Raytracing

SolarEnvelopeBasic

SolarFanBasic

4|Extra

LadybugPrimer

3

1.5.1

1.5.2

1.5.3

1.5.4

1.5.5

1.5.6

1.5.7

1.5.8

1.5.9

1.5.10

1.5.11

1.5.12

1.5.13

1.5.14

1.5.15

1.5.16

1.5.17

1.5.18

1.5.19

1.5.20

1.5.21

1.5.22

1.5.23

1.5.24

1.5.25

1.5.26

1.5.27

1.5.28

1.5.29

1.5.30

1.5.31

1.5.32

1.5.33

Mesh-To-Hatch

North

Recolor_Mesh

True_North

Adaptive_Comfort_Parameters

Body_Characteristics

Gradient_Library

Legend_Parameters

PMV_Comfort_Parameters

Passive_Strategy_List

Real_Time_Radiation_Analysis

Capture_View

Orient_to_Camera

Set_the_View

fly

C2F

DOY_HOY

Day_Month_Hour

F2C

Activities_Met_List

BTU2Wh

CombineSolarEnvelopes

Comfort_Mannequin

Construct_Time

Create_Legend

L2G

Orientation_Study_Parameters

Passive_Strategy_Parameters

Shading_Parameters_List

Wh2BTU

Wh2kWh

kWh2Wh

ms2mph

LadybugPrimer

4

1.5.34

1.5.35

1.6

1.6.1

1.6.2

1.7

1.7.1

1.7.2

1.7.3

1.7.4

1.7.5

1.7.6

1.7.7

1.7.8

1.7.9

1.7.10

1.7.11

1.7.12

1.7.13

rIP2rSI

uIP2uSI

5|Developers

Export_Ladybug

Update_Ladybug

6|WIP

Bioclimatic_Chart

Shadow_Study

PV_SWH_System_Size

Photovoltaics_Module

Cold_Water_Temperature

Commercial_Public_Apartment_Hot_Water

Residential_Hot_Water

Solar_Water_Heating_Performance_Metrics

Solar_Water_Heating_Surface

Solar_Water_Heating_System

Solar_Water_Heating_System_Detailed

Shading_Mask

Shading_Mask_II

LadybugPrimer

5

ladybug-primer

Thisprimerisgeneratedbyscript.Feelfreetoeditthepagesandsendpullrequests.Hereisthesourceofthispremier.

LadybugforGrasshopperLadybugisafreeandopensourceenvironmentalpluginforGrasshoppertohelpdesignerscreateanenvironmentally-consciousarchitecturaldesign.Theinitialstepinthedesignprocessshouldbetheweatherdataanalysis;athoroughunderstandingoftheweatherdatawill,morelikely,leaddesignerstohigh-performancedesigndecisions.

LadybugimportsstandardEnergyPlusWeatherfiles(.EPW)inGrasshopperandprovidesavarietyof2Dand3Ddesigner-friendlyinteractivegraphicstosupportthedecision-makingprocessduringtheinitialstagesofdesign.Thetoolalsoprovidesfurthersupportfordesignerstotesttheirinitialdesignoptionsforimplicationsfromradiationandsunlight-hoursanalysesresults.IntegrationwithGrasshopperallowsforanalmostinstantaneousfeedbackondesignmodifications,andasitrunswithinthedesignenvironment,theinformationandanalysisisinteractive.

LadybugPrimer

6Whatisthispremier?

https://github.com/mostaphaRoudsari/ladybug-premier

UsefullinksLadybugonGithub

LadybuggrouppageonGrasshopper

Facebookpage

LadybugonTwitter

LadybugPrimer

7Whatisthispremier?

https://github.com/mostaphaRoudsari/ladybug

http://www.grasshopper3d.com/group/ladybug

https://www.facebook.com/LadyBugAnalysisTools

https://www.twitter.com/ladybug_tool

Componentlist:

Ladybug

Import_epw

Open_EPW_And_STAT_Weather_Files

Open_EPW_Weather_File

download_EPW_Weather_File

Construct_Location

Decompose_Location

Import_Location

Import_stat

Open_STAT_File

Create_LB_Header

LadybugPrimer

80|Ladybug

Ladybug

ThiscomponentcarriesallofLadybug'smainclasses.Othercomponentsrefertotheseclassestorunthestudies.Therefore,youneedtoletherflybeforerunningthestudiessotheclasseswillbecopiedtoRhinossharedspace.Soletherfly!-Ladybug:APluginforEnvironmentalAnalysis(GPL)startedbyMostaphaSadeghipourRoudsariYoushouldhavereceivedacopyoftheGNUGeneralPublicLicensealongwithLadybug;Ifnot,seehttp://www.gnu.org/licenses/[email protected]+http://spdx.org/licenses/GPL-3.0+Sourcecodeisavailableat:https://github.com/mostaphaRoudsari/ladybug-

Inputs

LadybugPrimer

9Ladybug

http://www.gnu.org/licenses/

http://spdx.org/licenses/GPL-3.0+

https://github.com/mostaphaRoudsari/ladybug

defaultFolder[Optional]

OptionalinputforLadybugdefaultfolder.IfemptydefaultfolderwillbesettoC:\ladybugorC:\Users\%USERNAME%\AppData\Roaming\Ladybug\

Outputs

Vviiiiiiiiiizzz!

CurrentLadybugmood!!!

CheckHydraExampleFilesforLadybug

LadybugPrimer

10Ladybug

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Ladybug

Importepw

UsethiscomponenttoimportlistsofweatherdataintoGrasshopperfromastandard.epwfile.Fordetailedinformationaboutthestructureofanepwfile,youmaywanttoreadthe"WeatherConverterProgram"sectionin"AuxiliaryEnergyPlusPrograms"document.Alldescriptionsofimportaeddataareborrowedfromthisdocument.Thedocumentisavailableonlineatthisaddress:"http://apps1.eere.energy.gov/buildings/energyplus/pdfs/auxiliaryprograms.pdf"-

Inputs

epwFile[Required]

LadybugPrimer

11Import_epw

http://apps1.eere.energy.gov/buildings/energyplus/pdfs/auxiliaryprograms.pdf

An.epwfilepathonyoursystemasastring.

Outputs

readMe!

...

latitude

Thelatitudeoftheweatherfilelocation.

location

Alistoftextsummarizingthelocationdataintheweatherfile(usethistoconstructthesunpath).

dryBulbTemperature

"Thisisthehoulrydrybulbtemperature,inC.Notethatthisisafullnumericfield(i.e.23.6)andnotanintegerrepresentationwithtenths.Validvaluesrangefrom70Cto70C.Missingvalueforthisfieldis99.9."

dewPointTemperature

"Thisisthehourlydewpointtemperature,inC.Notethatthisisafullnumericfield(i.e.23.6)andnotanintegerrepresentationwithtenths.Validvaluesrangefrom70Cto70C.Missingvalueforthisfieldis99.9."

relativeHumidity

"ThisisthehourlyRelativeHumidityinpercent.Validvaluesrangefrom0%to110%.Missingvalueforthisfieldis999."

windSpeed

"Thisisthehourlywindspeedinm/sec.Valuescanrangefrom0to40.Missingvalueis999."

windDirection

"ThisisthehourlyWindDirectionindegreeswheretheconventionisthatNorth=0.0,East=90.0,South=180.0,West=270.0.(Ifwindiscalmforthegivenhour,thedirectionequalszero.)Valuescanrangefrom0to360.Missingvalueis999."

directNormalRadiation

LadybugPrimer

12Import_epw

"ThisisthehourlyDirectNormalRadiationinWh/m2.(AmountofsolarradiationinWh/m2receiveddirectlyfromthesolardiskonasurfaceperpendiculartothesun'srays,duringthenumberofminutesprecedingthetimeindicated.)Ifthefieldismissing(9999)orinvalid(<0),itissetto0.Countsofsuchmissingvaluesaretotaledandpresentedattheendoftherunperiod."

diffuseHorizontalRadiation

"ThisisthehourlyDiffuseHorizontalRadiationinWh/m2.(AmountofsolarradiationinWh/m2receivedfromthesky(excludingthesolardisk)onahorizontalsurfaceduringthenumberofminutesprecedingthetimeindicated.)Ifthefieldismissing(9999)orinvalid(<0),itissetto0.Countsofsuchmissingvaluesaretotaledandpresentedattheendoftherunperiod."

globalHorizontalRadiation

"ThisisthehourlyGlobalHorizontalRadiationinWh/m2.(TotalamountofdirectanddiffusesolarradiationinWh/m2receivedonahorizontalsurfaceduringthenumberofminutesprecedingthetimeindicated.)ItisnotcurrentlyusedinEnergyPluscalculations.Itshouldhaveaminimumvalueof0;missingvalueforthisfieldis9999."

directNormalIlluminance

"ThisisthehourlyDirectNormalIlluminanceinlux.(Averageamountofilluminanceinhundredsofluxreceiveddirectlyfromthesolardiskonasurfaceperpendiculartothesun'srays,duringthenumberofminutesprecedingthetimeindicated.)ItisnotcurrentlyusedinEnergyPluscalculations.Itshouldhaveaminimumvalueof0;missingvalueforthisfieldis999999andwillbeconsideredmissingof>=999900."

diffuseHorizontalIlluminance

"ThisisthehourlyDiffuseHorizontalIlluminanceinlux.(Averageamountofilluminanceinhundredsofluxreceivedfromthesky(excludingthesolardisk)onahorizontalsurfaceduringthenumberofminutesprecedingthetimeindicated.)ItisnotcurrentlyusedinEnergyPluscalculations.Itshouldhaveaminimumvalueof0;missingvalueforthisfieldis999999andwillbeconsideredmissingof>=999900."

globalHorizontalIlluminance

"ThisisthehourlyGlobalHorizontalIlluminanceinlux.(Averagetotalamountofdirectanddiffuseilluminanceinhundredsofluxreceivedonahorizontalsurfaceduringthenumberofminutesprecedingthetimeindicated.)ItisnotcurrentlyusedinEnergyPluscalculations.Itshouldhaveaminimumvalueof0;missingvalueforthisfieldis999999andwillbeconsideredmissingof>=999900."

LadybugPrimer

13Import_epw

totalSkyCover

"Thisisthefractionfortotalskycover(tenthsofcoverage).(i.e.1is1/10covered.10istotalcoverage).(Amountofskydomeintenthscoveredbycloudsorobscuringphenomenaatthehourindicatedatthetimeindicated.)Minimumvalueis0;maximumvalueis10;missingvalueis99."

liquidPrecipitationDepth

"Theamountofliquidprecipitation(mm)observedattheindicatedhourfortheperiodindicatedintheliquidprecipitationquantityfield.Ifthisvalueisnotmissing,thenitisusedandoverridestheprecipitationflagasrainfall.Conversely,iftheprecipitationflagshowsrainandthisfieldismissingorzero,itissetto1.5(mm)."

barometricPressure

"ThisisthehourlyweatherstationpressureinPa.Validvaluesrangefrom31,000to120,000...Missingvalueforthisfieldis999999."

modelYear

Theyearfromwhichthehourlydatahasbeenextracted.EPWfilesaresynthesizedfromrealrecordeddatafromdifferentyearsinagivenclimate.Thisisdonetoensurethat,foreachmonth,theselecteddataisstatisticallyrepresentativeoftheaveragemonthlyconditionsoverthe18+yearsofrecordingthedata.DifferentEPWfileswillbesynthesizedfromdifferentyearsdepedingonwhethertheyareTMY(TypicalMeteorologicalYear),TMY2,TMY3,AMY(ActualMeteorologicalYear)orother.

CheckHydraExampleFilesforImportepw

LadybugPrimer

14Import_epw

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Import epw

OpenEPWAndSTATWeatherFiles

Usethiscomponenttoautomaticallydownloada.zipfilefromtheDepartmentofEnergy's(DOE)database,unzipthefile,andopenboththe.epwand.statweatherfilesintoGrasshopper.ThecomponentrequirestheURLofthezippedfileforthespecificclimatethatyouwanttoimportfromtheDOE'swebsite.ToopentheDOE'swebsite,usetheLadybug_downloadEPWWeatherFilecomponent.NotethatyoucancopythezipfileURLtoyourclipboardbyright-clickingonthe"ZIP"linkfortheclimatethatyouwantontheDOE'swebsiteandchoosing"CopyLinkAddress."-

Inputs

LadybugPrimer

15Open_EPW_And_STAT_Weather_Files

weatherFileURL[Required]

Atextstringrepresentingthe.zipfileURLfromtheDepartmentofEnergy's(DOE's)website.ToopentheDOE'swebsite,usetheLadybug_downloadEPWWeatherFilecomponent.NotethatyoucancopythezipfileURLtoyourclipboardbyright-clickingonthe"ZIP"linkfortheclimatethatyouwantontheDOE'swebsiteandchoosing"CopyLinkAddress."

workingDir[Optional]

Anoptionaltextstringrepresentingafilepathtoaworkingdirectoryonyourcomputerwhereyouwouldliketodownloadandunzipthefile.Ifnothingisset,theweatherfileswillbedownloadedtoC:/ladybug/andplacedinafolderwiththenameoftheweatherfilelocation.

Outputs

epwFile

Thefilepathofthedownloadedepwfile.

statFile

Thefilepathofthedownloadedstatfile.

CheckHydraExampleFilesforOpenEPWAndSTATWeatherFiles

LadybugPrimer

16Open_EPW_And_STAT_Weather_Files

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Open EPW And STAT Weather Files

OpenEPWWeatherFile

Usethiscomponenttoopenan.epwweatherfilefromalocationonyourcomputer.-

Inputs

open[Required]

SetBooleantoTruetobrowseforaweatherfileonyoursystem.

Outputs

LadybugPrimer

17Open_EPW_Weather_File

epwFile

Thefilepathoftheselectedepwfile.

CheckHydraExampleFilesforOpenEPWWeatherFile

LadybugPrimer

18Open_EPW_Weather_File

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Open EPW Weather File

downloadEPWWeatherFile

Usethiscomponenttoopentheepwmappageinyourdefaultwebbrowseranddownloadan.epwweatherfile.-

Inputs

download[Required]

SetBooleantoTruetoopentheepwmappage

Outputs

LadybugPrimer

19download_EPW_Weather_File

readMe!

Willread'Happydownloading...'inthecaseofsuccessfullyopeningyourbrowser

CheckHydraExampleFilesfordownloadEPWWeatherFile

LadybugPrimer

20download_EPW_Weather_File

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_download EPW Weather File

ConstructLocation

Usethiscomponentifyoudonothavean.epwweatherfilebuthavealatitudeorotherinformationonthesite.Thelocationoutputofthiscomponentcanbeusedtomakeasunplotintheabsenceofan.epwweatherfile.-

Inputs

locationName[Required]

Anameforthelocationyouareconstructing.(ie.SteventonIsland,Antarctica)

LadybugPrimer

21Construct_Location

latitude[Required]

Thelatitudeofthelocationyouareconstructing.Valuesmustbebetween-90and90.Defaultissettotheequator.

longitude[Default]

Anoptionalnumericalvaluerepresentingthelongitudeofthelocationyouareconstructing.Thiscanimprovetheaccuracyoftheresultingsunplot.

timeZone[Default]

Anoptionalintegerrepresentingthetimezoneofthelocationyouareconstructing.Thiscanimprovetheaccuracyoftheresultingsunplot.Thetimezoneshouldfollowtheepwconventionandshouldbebetween-12and+12,where0isatGreenwich,UK,positivevaluesaretotheEastofGreenwichandnegativevaluesaretotheWest.

elevation[Default]

Anoptionalnumericalvaluerepresentingtheelevationofthelocationyouareconstructing.

Outputs

location


CheckHydraExampleFilesforConstructLocation

LadybugPrimer

22Construct_Location

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Construct Location

DecomposeLocation

Usethiscomponenttoseparateandexctracttheinformationinthe'location'outputoftheimportEPWorconstructLocationcomponent.-

Inputs

location[Required]

TheoutputfromtheimportEPWorconstructLocationcomponent.Thisisessentiallyalistoftextsummarizingalocationontheearth.

LadybugPrimer

23Decompose_Location

Outputs

locationName

Nameofthelocation.

latitude

Latitudeofthelocation.

longitude

Longitudeofthelocation.

timeZone

Timezoneofthelocation.

elevation

Elevationofthelocation.

CheckHydraExampleFilesforDecomposeLocation

LadybugPrimer

24Decompose_Location

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Decompose Location

ImportLocation

Usethiscomponenttoimportlocationdatafromastandard.epwfile.Youcanusetheoutputtodrawasunpath.-

Inputs

epwFile[Required]

An.epwfilepathonyoursystemasastring.

Outputs

LadybugPrimer

25Import_Location

location


CheckHydraExampleFilesforImportLocation

LadybugPrimer

26Import_Location

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Import Location

Importstat

Usethiscomponenttoimportclimatedatafoundinthe.statfilethatdownloadswiththe.epwfile(inthesame.zipfolder).Sepcifcally,thisallowsyoutoimporttheASHRAEandKoppenclimatezonesaswellasdesigntemperaturesrepresentingthetemperatureextremesoftheclimatethatshouldbeusedtodesignandsizeheatingandcoolingsystems.Lastly,thiscomponentbringsinthetypicalandextremeweeksoftheyearasladybuganalysisperiodsthatcanbepluggedintotheotherladybugcomponents.-

Inputs

statFile[Required]

LadybugPrimer

27Import_stat

A.statfilepathonyoursystemfromtheOpenSTATfilecomponent(ortypedoutasastring).

Outputs

readMe!

...

ashraeClimateZone

TheestimatedASHRAEclimatezoneoftheSTATfile.ASHRAEclimatezonesarefrequentlyusedtomakesuggestionsforheatingandcoolingsystemsandcorrespondtorecommendationsforinsulationlevelsofabuilding.Formoreinformation,seethispdf:https://www.ashrae.org/File%20Library/docLib/Public/20081111_CZTables.pdf

koppenClimateZone

TheestimatedKoppenclimatezoneoftheSTATfile.TheKoppenclimateclassificationisthemostwidelyusedclimateclassificationsystemandisbasedontheconceptthatnativevegetationisthebestexpressionofclimate.Thus,Koppenclimatezonescombineaverageannualandmonthlytemperatures,precipitation,andtheseasonalityofprecipitation.Formoreinformation,seethewikipendiapageonKoppenclimate:http://en.wikipedia.org/wiki/K%C3%B6ppen_climate_classification.

heatingDesignTemp

ThetemperatureinCelciusthatASHRAErecommendsusingtodesignaheatingsystemforabuilding.Itrempresentstheoneofthecoldesttemperaturesoftheyearforwhichonly0.4%ofthehoursarebelow.

coolingDesignTemp

ThetemperatureinCelciusthatASHRAErecommendsusingtodesignacoolingsystemforabuilding.Itrempresentstheoneofthehottesttemperaturesoftheyearforwhichonly0.4%ofthehoursareabove.

extremeHotWeek

Ananalysisperiodrepresentingthehottestweekofthetypicalmeanyear.Ifthestatfiledoesnotspecifyanextremehotweek,itisthemostextremeweekofthehottestseason.

typicalHotWeek

LadybugPrimer

28Import_stat

https://www.ashrae.org/File%20Library/docLib/Public/20081111_CZTables.pdf

http://en.wikipedia.org/wiki/K%C3%B6ppen_climate_classification

Ananalysisperiodrepresentingatypicalweekofthehottestseasoninthetypicalmeanyear.Notallstatfilesspecifysuchaweekand,inthiscase,theoutputherewillbe"Null."

typicalWeek

Ananalysisperiodrepresentingatypicalweekofthetypicalmeanyear.Ifthestatfiledoesnotspecifyatypicalweek,itisthetypicalweekofAutumn.

typicalColdWeek

Ananalysisperiodrepresentingatypicalweekofthecoldestseasoninthetypicalmeanyear.Notallstatfilesspecifysuchaweekand,inthiscase,theoutputherewillbe"Null."

extremeColdWeek

Ananalysisperiodrepresentingthecoldestweekofthetypicalmeanyear.Ifthestatfiledoesnotspecifyanextremecoldweek,itisthemostextremeweekofthecoldestseason.

CheckHydraExampleFilesforImportstat

LadybugPrimer

29Import_stat

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Import stat

OpenSTATFile

Usethiscomponenttoopena.statfile,whichdownloadswiththe.epwweatherfileandcontainsinformationsuchastheclimatezoneandmaximumtemperaturesfordesigningheating/coolingsystems.Thiscomponentopensthefilefromalocationonyourcomputer.-

Inputs

open[Required]

SetBooleantoTruetobrowsefora.statfileonyoursystem.

LadybugPrimer

30Open_STAT_File

Outputs

statFile

Thefilepathoftheselected.statfile.

CheckHydraExampleFilesforOpenSTATFile

LadybugPrimer

31Open_STAT_File

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Open STAT File

CreateLBHeader

UsethiscomponenttogeneratesaLadybugHeaderthatcanbecombinedwithanyrawdatainordertoformatitforusewiththeLadybug/Honeybeecomponents._ThiscomponentisparticularlyusefulifyouarebringingindatafromotherpluginsorfrominstrumentalmeasurementsandyouwanttovisualizeitoranalyzeitwiththeLadybugandHoneybeecomponents.ItisalsousefulifyouwanttoreplacetheheaderonLadybugdata.-

Inputs

location[Optional]

LadybugPrimer

32Create_LB_Header

Atextstringthatrepresentsthenameofthelocationwherethedatawascollected.Ifnovalueisconnectedhere,thedefaultwillbe"Somewhere."

dataType[Optional]

Atextstringthatrepresentsthetypeofdatathattheheadercorrespondsto.Thiscanbe"Temperature","Wind",etc.Ifnovalueisconnectedhere,thedefaultwillbe"SomeData."

units[Optional]

Atextstringthatrepresentstheunitsofthedata.Thiscanbe"C","m/s",etc.Ifnovalueisconnectedhere,thedefaultwillbe"SomeUnits."

timeStep[Optional]

Atextstringthatrepresentsthetimestepofthedata.Acceptablevaluesinclude"Hourly","Daily","Monthly",or"Annually."Ifnovalueisconnectedhere,thedefaultwillbe"Hourly."

analysisPeriod[Optional]

AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.Ifnoanalysisperiodisgiven,thedefaultwillbefortheenitreyear:(1,1,1)(12,31,24).

Outputs

LBHeader

ScriptvariablePython

CheckHydraExampleFilesforCreateLBHeader

LadybugPrimer

33Create_LB_Header

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Create LB Header

Componentlist:

Analysis_Period

Average_Data

Branch_Data

Separate_data

CDD_HDD

Wind_Speed_Calculator

Adaptive_Comfort_Calculator

Outdoor_Comfort_Calculator

PMV_Comfort_Calculator

Thermal_Comfort_Indices

CDH_HDH

Clothing_Function

Humidity_Ratio_Calculator

LadybugPrimer

341|AnalyzeWeatherData

AnalysisPeriod

Usethiscomponenttosetananalysisperiod,whichcanbeusedasinputforavarietyofotherLadybugandHoneybeecomponents.Defaultanalysisperiodwithoutanyinputsissettotheentireyear.-

Inputs

fromMonth[Default]

Anumberbetween1and12thatrepresentsthemonthoftheyearforthestartoftheanalysis.Defaultstartingmonthissetto1(January).

LadybugPrimer

35Analysis_Period

fromDay[Default]

Anumberbetween1and31thatrepresentsthedayofthemonthforthestartoftheanalysis.Defaultstartingdayissetto1(thefirstofthemonth).

fromHour[Default]

Anumberbetween1and24thatrepresentsthehourofthedayforthestartoftheanalysis.Defaultstartinghourissetto1(thefirsthourofthedayaftermidnight).

toMonth[Default]

Anumberbetween1and12thatrepresentsthemonthoftheyearfortheendoftheanalysis.Defaultendmonthissetto12(December).

toDay[Default]

Anumberbetween1and31thatrepresentsthedayofthemonthfortheendoftheanalysis.Defaultenddayissetto31(the31stofthemonth).

toHour[Default]

Anumberbetween1and24thatrepresentsthehourofthedayfortheendoftheanalysis.Defaultendhourissetto24(thelasthourofthedaybeforemidnight)

Outputs

readMe!

Atextconfirmationoftheanalysisperiod.

analysisPeriod

Twotuplesthatrepresenttherunningperiod(fromMonth,fromDay,fromHour)to(toMonth,toDay,toHour)

CheckHydraExampleFilesforAnalysisPeriod

LadybugPrimer

36Analysis_Period

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Analysis Period

AverageData

Usethiscomponenttoselectthedataoutofanannualhourlydatastream(fromtheimportEPWcomponent)usingthe"AnalysisPeriod"component.Thiscomponenentalsoaveragesortotalstheconnectedhourlydataforeachday,month,andaveragehourofeachmonthintheanalysisperiod.-

Inputs

annualHourlyData[Required]

Anhourlydatastreamfromthe"Importepw"component.

LadybugPrimer

37Average_Data

analysisPeriod[Default]

The"analysisPeriod"Outputfrom"AnalysisPeriod"component.Ifnoinputisprovided,thedefaultanalysisperiodissettothewholeyear.

totalOrAverage[Optional]

Setto'True'tohavethecomponenttotalthevaluesforthegivenperiodsandsetto'False'tohavethecomponentaveragethem.Thedefaultissetto'False'toaveragedata.

Outputs

readMe!

Atextconfirmationoftheanalysisperiod.

selHourlyData

Thehourlydatastreamfortheanalysisperiod.

averagedDaily

Theaverageddataforeachdayduringtheanalysisperiod.

averagedMonthly

Theaverageddataforeachmonthduringtheanalysisperiod.

avrMonthlyPerHour

Thedatafortheaveragehourofeachmonthduringtheanalysisperiod.

avrAnalysisPeriod

Theaverageddatafortheanalysisperiod.

CheckHydraExampleFilesforAverageData

LadybugPrimer

38Average_Data

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Average Data

BranchData

Usethiscomponenttoconvertanylistofannualdataintoadatatreebranchedbydayoftheyear,monthoftheyear,orhouroftheday.Ifthedataisnot8760valuesofeachhour,thenumberofdataitemsshouldmatchnumberofitemsinHOY.-

Inputs

data[Required]

Alistofdatatobebranchedforeachmonth,dayandhour.Notethatthiscanbeeitheralistof8760valuesforeachhouroftheyear,theoutputofthe"ImportEPW"

LadybugPrimer

39Branch_Data

component,oracustomlistofdatathatismatchedbythedataintheHOY_input.

HOY[Optional]

Alistofnumbersbetween1and8760thatrepresentsanhouroftheyear.

Outputs

dataEachDayOfYear

Theinputdatathathasbeenbrancheddataforeachdayoftheyear.Thepathsofthebranchesareinthefollowingformat{month;dayOfMonth}.

dataEachMonth

Theinputdatathathasbeenbranchedforeachmonthoftheyear.Branchpathsarefrom0to11.

dataEachHourOfDay

Theinputdatathathasbeenbranchedforeachhouroftheday.Branchesarefrom0to23.

CheckHydraExampleFilesforBranchData

LadybugPrimer

40Branch_Data

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Branch Data

Separatedata

UsethiscomponenttoseparatethetextstringsfromthenumbersintheclimatedatastreamsoutputfromtheImportEPWcomponent.YoucanthenperformmathamaticalfunctionsonthenumericalclimatedatausingtheGrasshoppermathcomponentsorquicklypreviewthenumericaldatastreamusingtheGrasshopper"QuickGraph"component.Thiscomponentcanalsobeusedgenerallytoseparateanydatastreamthatcontainsbothnumbersandtextstrings.-

Inputs

inputList[Required]

LadybugPrimer

41Separate_data

Alistofdatathatcontainsbothtextsrtingsandnumbers.Forexample,adatastreamoutputfromtheImportEPWcomponent.

Outputs

numbers

Thenumbersfrominthe_inputListdata.Notethattheorderofnumbersinthislististhesameasthe_inputList.

strings

Thetextstringsfrominthe_inputListdata.Notethattheorderoftextstringsinthislististhesameasthe_inputList.

CheckHydraExampleFilesforSeparatedata

LadybugPrimer

42Separate_data

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Separate data

CDD_HDD

Calculatesheatingandcoolingdegree-days.Traditionally,degree-daysaredefinedasthedifferencebetweenabasetemperatureandtheaverageambientairtemperaturemultipliedbythenumberofdaysthatthisdifferenceexists.Bydefault,thiscomponentusesamoreaccuratecalculationthanthetraditionalmethodbasedontheminimumandmaximumtemperatureofeachday.Youmaychecktheformulasinthispage:"http://www.vesma.com/ddd/ddcalcs.htm"Ifyourathertousethetraditionalmethod,setuseDailyAvrMethodtoTrue.-

Inputs

LadybugPrimer

43CDD_HDD

http://www.vesma.com/ddd/ddcalcs.htm

hourlyDryBulbTemperature[Required]

AnnualdrybulbtemperaturefromtheImportepwcomponent(indegreesCelsius).

coolingBaseTemperature[Default]

Basetemperatureforcooling(indegreesCelsius).Defaultissetto23.3Cbutthiscanbemuchloweriftheanalysisisforabuildingwithhighheatgainorinsulation.

heatingBaseTemperature[Default]

Basetemperatureforheating(indegreesCelsius).Defaultissetto18.3Cbutthiscanbemuchloweriftheanalysisisforabuildingwithhighheatgainorinsulation.

useDailyAvrMethod[Optional]

setto"True"tousethetraditionalmethodofdegreedayscalculation,whichwillcalculatetheaveragetemperatureofeachdayandsumupallofthesetemperaturesovertheyear.Thisisopoosedtothiscomponent'sdefaultanalysis,whichwillwillexamineeachhouroftheyearandthenconvertresultstodegree-days.

Outputs

readMe!

Asummaryoftheinput.

daily_coolingDegDays

Coolingdegree-dayssummedforeachdayoftheyear.Forvisualizationsofoverthewholeyear,connectthistothegrasshopperchart/graphcomponent.

daily_heatingDegDays

Heatingdegree-dayssummedforeachdayoftheyear.Forvisualizationsofoverthewholeyear,connectthistothegrasshopperchart/graphcomponent.

monthly_coolingDegDays

Coolingdegree-dayssummedforeachmonthoftheyear.

monthly_heatingDegDays

Heatingdegree-dayssummedforeachmonthoftheyear.

annual_coolingDegDays

LadybugPrimer

44CDD_HDD

Thetotalcoolingdegree-daysfortheentireyear.

annual_heatingDegDays

Thetotalheatingdegree-daysfortheentireyear.

CheckHydraExampleFilesforCDD_HDD

LadybugPrimer

45CDD_HDD

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_CDD_HDD

WindSpeedCalculator

Usethiscomponenttocalculatewindspeedataspecificheightforagiventerraintype.Bydefault,thecomponentwillcalculategroundwindspeed,whichisusefulforcomfrtcalculations.Also,byhookingupwinddatafromanepwfile,youcanusetheresultingdatatocreateawindroseatanyheight.-

Inputs

north[Optional]

InputavectortobeusedasatrueNorthdirectionforthesunpathoranumberbetween

LadybugPrimer

46Wind_Speed_Calculator

0and360thatrepresentsthedegreesofffromthey-axistomakeNorth.ThedefaultNorthdirectionissettotheY-axis(0degrees).

windSpeed_tenMeters[Required]

ThewindspeedfromtheimportEPWcomponentoranumberrepresentingthewindspeedat10metersoffthegroundinagriculturalorairportterrian.Thisinputalsoacceptslistsofnumbersrepresentingdifferentspeedsat10meters.

windDirection[Optional]

ThewinddirectionfromtheimportEPWcomponentoranumberindegreesrepresetingthewinddirectionfromnorth,Thisinputalsoacceptslistsofnumbersrepresentingdifferentdirections.

terrainType[Optional]

Anintergerfrom0to3thatsetstheterrainclassassociatedwiththeoutputwindSpeedAtHeight.Intergervaluesrepresentthefollowingterrainclasses:0=Urban:largecitycentres,50%ofbuildingsabove21moveradistanceofatleast2000mupwind.1=Suburban:suburbs,woodedareas.2=Country:open,withscatteredobjectsgenerallylessthan10mhigh.3=Water:Flat,unobstructedareasexposedtowindflowingoveralargewaterbody(nomorethan500minland).

epwTerrain[Optional]

Anoptionalintergerfrom0to3thatsetstheterrainclassassociatedwiththeoutputwindSpeedAtHeight.Thedefaultissetto2forflatclearland,whichistypicalformostEPWfilesthatarerecordedatairports.Intergervaluesrepresentthefollowingterrainclasses:0=Urban:largecitycentres,50%ofbuildingsabove21moveradistanceofatleast2000mupwind.1=Suburban:suburbs,woodedareas.2=Country:open,withscatteredobjectsgenerallylessthan10mhigh.3=Water:Flat,unobstructedareasexposedtowindflowingoveralargewaterbody(nomorethan500minland).

heightAboveGround[Optional]

Optional.Thisistheheightabovegroundforwhichyouwouldliketomeasurewindspeed.Providingmorethanonevaluewillgeneratealistofspeedsateachgivenheight.Defaultheightis1maboveground,whichiswhatapersonstandingonthegroundwouldfeel.


IfyouhaveconnecteddatafromanEPWcomponent,pluginananalysisperiodfrom

LadybugPrimer


theLadybug_AnalysisPeriodcomponenttocalculatedataforjustaportionoftheyear.ThedefaultisJan1st00:00-Dec31st24:00,theentireyear.

averageData[Optional]

Setto"True"toaverageallofthewinddatathatyouhaveconnectedintoasinglespeedandwindvector.ThedefaultisFalse,whichmeansthecomponentwillreturnalistofallhourswithintheanalysisperiod.IfsetotTure,thewinddatawillbeaveragedfortheentireanalysisperiodintoasinglevalue.

Outputs

readMe!

...

windSpeedAtHeight

Thewindspeedattheconnectedheightabovetheground.IfaverageData=True,thiswillbeasinglevaluerepresentingtheaveragespeedforallconnectedvaluesorvalueswithintheanalysisperiodateachheight.IfaverageData=False,thisreturnsalistofwindspeedsforeveryhourwithintheanalysisperiodateachheight.NotethanwhenaverageData_=False,thelistwillincludeaheaderspecifictoeachlist.Thisheadercanberemovedbyusingthe"Ladybug_SeparateData"component.

windVectorAtHeight

Returnsalistofvectorsrepresentingwindspeedanddirectionateveryhourwithintheanalysisperiod,ateachheightprovided.

CheckHydraExampleFilesforWindSpeedCalculator

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Wind Speed Calculator

AdaptiveComfortCalculator

Usethiscomponenttocalculatetheadaptivecomfortforagivensetofinputconditions.Thiscomponentwilloutputastreamof0'sand1'sindicatingwhethercertainconditionsarecomfortablegiventheprevailingmeanmonthlytemperaturethatocuppantstendtoadaptthemselvesto.Thiscomponentwillalsooutputaseriesofintergernumbersthatindicatethefollowing:-1=Theaveragemonthlytemperatureistooextremefortheadaptivemodel.0=Theinputconditionsaretoocoldforoccupants.1=Theinputconditionsarecomfortableforoccupants.2=Theinputconditionsaretoohotforoccupants.Lastly,thiscomponentoutputsthepercentoftimecomfortable,hot,coldandmonthlyextremeaswellasalitofnumbersindicatingtheuppertemperatureofcomfortandlowertemperatureofcomfort.TheadaptivecomfortmodelwascreatedinresponsetotheshortcomingsofthePMVmodelthat

LadybugPrimer

49Adaptive_Comfort_Calculator

becameapparentwhenitwasappliedtobuildingswithoutairconditioning.Namely,thePMVmodelwasover-estimatingthediscomfortofoccupantsinwarmconditionsofnautrallyventilatedbuildings.Accordingly,theadaptivecomfortmodelwasbuiltontheworkofhundredsoffieldstudiesinwhichpeopleinnaturallyventilatedbuildingswereaskedaskedabouthowcomfortabletheywere.Resultsshowedthatuserstendedtoadaptthemselvestothemonthlymeantemperatureandwouldbecomfortableinbuildingssolongasthebuildingtemperatureremainedaroundavalueclosetothatmonthlymean.Thissituationheldtruesolongasthemonthlymeantemperatureremainedabove10Candbelow33.5C.ThecomfortmodelsthatmakethiscomponentpossibleweretranslatedtopythonfromaseriesofvalidatedjavascriptcomfortmodelscodedattheBerkelyCenterfortheBuiltEnvironment(CBE).TheAdaptivemodelusedbyboththeCBEToolandthiscomponentwasoriginallypublishedinASHARAE55.SpecialthanksgoestotheauthorsoftheonlineCBEThermalComfortToolwhofirstcodedthejavascript:HoytTyler,SchiavonStefano,PiccioliAlberto,MoonDustin,andSteinfeldKyle.http://cbe.berkeley.edu/comforttool/-

Inputs

dryBulbTemperature[Required]

AnumberrepresentingthedrybulbtemperatureoftheairindegreesCelcius.ThisinputcanalsoacceptalistoftemperaturesrepresentingconditionsatdifferenttimesorthedirectoutputofdryBulbTemperaturefromtheImportEPWcomponent.

meanRadiantTemperature[Optional]

AnumberrepresentingthemeanradianttemperatureofthesurroundingsurfacesindegreesCelcius.Ifnovalueispluggedinhere,thiscomponentwillassumethatthemeanradianttemperatureisequaltoairtemperaturevalueabove.ThisinputcanalsoacceptalistoftemperaturesrepresentingconditionsatdifferenttimesorthedirectoutputofdryBulbTemperaturefromtheImportEPWcomponent.

prevailingOutdoorTemp[Required]

AnumberrepresentingtheaveragemonthlyoutdoortemperatureindegreesCelcius.Thisaveragemonthlyoutdoortemperatureisthetemperaturethatoccupantsinnaturallyventilatedbuildingstendtoadaptthemselvesto.Forthisreason,thisinputcanalsoacceptthedirectoutputofdryBulbTemperaturefromtheImportEPWcomponentifhoulryvaluesforthefullyearareconnectedfortheotherinputsofthiscomponent.

windSpeed[Optional]

Anumberrepresentingthewindspeedoftheairinmeterspersecond.Ifnovalueispluggedinhere,thiscomponentwillassumeaverylowwindspeedof0.3m/s,

LadybugPrimer


http://cbe.berkeley.edu/comforttool/

characteristicofmostnaturallyventilatedbuildings.ThisinputcanalsoacceptalistofwindspeedsrepresentingconditionsatdifferenttimesorthedirectoutputofwindSpeedfromoftheImportEPWcomponent.

comfortPar[Optional]

Optionalcomfortparametersfromthe"Ladybug_AdaptiveComfortParameters"component.UsethistoselecteithertheUSorEuropeancomfortmodel,setthethresholdofacceptibilityforcomfortorcomputeprevailingoutdoortemperaturebyamonthlyaverageorrunningmean.ThesecomfortParcanalsobeusedtosetalevelOfConditioning,whichmakesuseofresearchoutsideoftheofficialpublishedstandardsthatsurveyedpeopleinairconditionedbuildings.


AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.IfnoAnalysisperiodisgivenandepwdatafromtheImportEPWcomponenthasbeenconnected,theanalysiswillberunfortheenitreyear.

runIt[Required]

Setto"True"torunthecomponentandcalculatetheadaptivecomfortmetrics.

Outputs

readMe!

...

comfortableOrNot

Astreamof0'sand1's(or"False"and"True"values)indicatingwhetheroccupantsarecomfortableundertheinputconditionsgiventhefactthattheseoccupantstendtoadaptthemselvestotheprevailingmeanmonthlytemperature.0indicatesthatapersonisnotcomfortablewhile1indicatesthatapersoniscomfortable.

conditionOfPerson

Astreamofintergervaluesfrom-1to+1thatcorrespondtoeachhouroftheinputdataandindicatethefollowing:-1=Theinputconditionsaretoocoldforoccupants.0=Theinputconditionsarecomfortableforoccupants.+1=Theinputconditionsaretoohotforoccupants.

degreesFromTarget

LadybugPrimer


AstreamoftemperaturevaluesindegreesCelciusindicatinghowfarfromthetargettemperaturetheconditionsofthepeopleare.Positivevaluesindicateconditionshotterthanthetargettemperaturewhilenegativevaluesindicatedegreesbelowthetargettemperture.

targetTemperature

AstreamoftemperaturevaluesindegreesCelciusindicatingthemeantargettempertureorneutraltemperaturethatthemostpeoplewillfindcomfortable.

upperTemperatureBound

AstreamoftemperaturevaluesindegreesCelciusindicatingthehighestpossibletemperatureinthecomfortrangeforeachhouroftheinputconditions.

lowerTemperatureBound

AstreamoftemperaturevaluesindegreesCelciusindicatingthelowestpossibletemperatureinthecomfortrangeforeachhouroftheinputconditions.

percentOfTimeComfortable

Thepercentoftheinputdataforwhichtheoccupantsarecomfortable.Comfortableconditionsarewhentheindoortemperatureiswithinthecomfortrangedeterminedbytheprevailingoutdoortemperature.

percentHotCold

Alistof2numericalvaluesindicatingthefollowing:0)Thepercentoftheinputdataforwhichtheoccupantsaretoohot.1)Thepercentoftheinputdataforwhichtheoccupantsaretoocold.

CheckHydraExampleFilesforAdaptiveComfortCalculator

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Adaptive Comfort Calculator

OutdoorComfortCalculator

UsethiscomponenttocalculatetheUniversalThermalClimateIndex(UTCI)forasetofinputclimateconditions.PerhapsthemostfamiliarapplicationofUniveralThermalClimateIndex(UTCI)isthetemperaturegivenbyTVweathermenandwomenwhentheysaythat,"eventhoughthedrybulbtemperatureoutsideisacertainvalue,thetemperatureactually"feelslike"somethinghigherorlower."UTCIisthistemperatureofwhattheweather"feelslike"andittakesintoaccounttheradianttemperature(sometimesincludingsolarradiation),relativehumidity,andwindspeed.UTCIusesthesevariablesinahumanenergybalancemodeltogiveatemperaturevaluethatisindicativeoftheheatstressorcoldstressfeltbyahumanbodyintheoutdoors.AUTCIbetween9and26degreesCelciusindicatesnothermalstressorcomfortableconditionsoutdoors.AUTCIbetween26and28degrees

LadybugPrimer

53Outdoor_Comfort_Calculator

Celciusindicatesslightheatstress(comfortableforshortperiodsoftime).Between28and32degrees,UTCIindicatesmoderateheatstress(hotbutnotdangerous).Between32and38degrees,UTCIindicatesstrongheatstress(dangerousbeyondshortperiodsoftime).Above38,UTCIindicatesverystrongtoextremeheatstress(verydangerous).AUTCIbetween0and9degreesCelciusindicatesslightcoldstress(comfortableforshortperiodsoftime).Between0and-13degrees,UTCIindicatesmoderatecoldstress(coldbutnotdangerous).Between-13and-27degrees,UTCIindicatesstrongcoldstress(dangerousbeyondshortperiodsoftime).Below-27,UTCIindicatesverystongtoextremecoldstress(verydangerous).UTCIisresultoftheworld'sleadingcomfortspecailists'attempttomakeaninterationalstandardofoutdoortemperaturesensationthatfillsthefollwoingrequirements:1)Thermo-physiologicalsignificanceinthewholerangeofheatexchangeconditionsofexistingthermalenvironments2)Validinallclimates,seasons,andscales3)Usefulforkeyapplicationsinhumanbiometeorology._ThecodethatmakesthiscomponentpossibleisaPythonversionoftheoriginalFortrancodeforcalculatingUTCI.InformationonUTCIandtheoriginalFortrancodecanbefoundhere:http://www.utci.org/.-

Inputs





windSpeed_tenMeters[Optional]

Anumberrepresentingthewindspeedoftheairinmeterspersecond.Ifnovalueispluggedinhere,thiscomponentwillassumeaverylowwindspeedof0.05m/s,characteristicofmostindoorconditions.ThisinputcanalsoacceptalistofwindspeedsrepresentingconditionsatdifferenttimesorthedirectoutputofwindSpeedfromoftheImportEPWcomponent.

relativeHumidity[Required]

Anumberbetween0and100representingtherelativehumidityoftheairinpercentage.

LadybugPrimer


http://www.utci.org/

ThisinputcanalsoacceptalistofrelativehumidityvaluesrepresentingconditionsatdifferenttimesorthedirectoutputofrelativeHumidityfromoftheImportEPWcomponent.



runIt[Required]

ScriptvariableUTCIComfortCalculator

Outputs

readMe!

...

universalThermalClimateIndex

TheUTCIoftheinputconditionsindegreesCelcius.PerhapsthemostfamiliarapplicationofUniveralThermalClimateIndex(UTCI)isthetemperaturegivenbyTVweathermenandwomenwhentheysaythat,eventhoughthedrybulbtemperatureoutsideisacertainvalue,thetemperatureactually"feelslike"somethinghigherorlower.UTCIisthistemperatureofwhattheweather"feelslike"andittakesintoaccountradianttemperature(usuallyincludingsolarradiation),relativehumidity,windspeedandusestheminahumanenergybalancemodeltogiveatemperaturevaluethatisindicativeoftheheatstressorcoldstressfeltbythehumanbody.

comfortableOrNot

Astreamof0'sand1's(or"False"and"True"values)indicatingwhetherapersonoutsideiscomfortableforeachhouroftheinputconditions.0indicatesthatapersonisnotcomfortablewhile1indicatesthatapersoniscomfortable.Apersonisconsideredtobecomfortablewhenhe/sheexperiencesnothermalstress(9<UTCI<26).

thermalStress

Astreamofintergervaluesfrom-1to+1thatindicatethefollowing:-1-ColdStress-coldconditions(UTCI<9C).0-NoThermalStress-comfortableconditions(9C<UTCI<26C).+1-HeatStress-hotconditions(UTCI>26C).

LadybugPrimer


conditionOfPerson

Astreamofintergervaluesfrom-3to+3thatindicatethefollowing:-3-StrongColdStress-potentialpublichealthhazardwithhigher-than-normalmortalityrates(UTCI<-13C).-2-ModerateColdStress-coldbutnopublichealthhazard(-13C<UTCI<0C).-1-SlightColdStress-coolbutcomfortableforshortperiodsoftime(0C<UTCI<9C)0-NoThermalStress-comfortableconditions(9C<UTCI<26C).+1-SlightHeatStress-warmbutcomfortableforshortperiodsoftime(26C<UTCI<28C).+2-ModerateHeatStress-hotbutnopublichealthhazard(28C<UTCI<32C).+3-StrongHeatStress-potentialpublichealthhazardwithhigher-than-normalmortalityrates(UTCI>32C).


ThepercentoftheinputdataforwhichtheUTCIindicatesnothermalstress(comfortableconditions).ComfortableconditionsarewhentheUTCIisbetween9and26degreesCelcius.

percentComfForShortPeriod

ThepercentoftheinputdataforwhichtheUTCIindicatesslightheat/coldstress.Thisindicatesconditionsthatarecomfortableforshortperiodsoftimewithproperattire.ThisincludesallconditionswhentheUTCIisbetween0and9degreesCelciusorbetween26and28degreesCelcius.

percentHeatStress

ThepercentoftheinputdataforwhichtheUTCIindicatesmoderate-to-extremeheatstress.Thisindicatesconditionsthatarenotcomfortable.ThisincludesallconditionsarewhentheUTCIisabove28degreesCelcius.

percentColdStress

ThepercentoftheinputdataforwhichtheUTCIindicatesmoderate-to-extremecoldstress.Thisindicatesconditionsthatarenotcomfortable.ThisincludesallconditionsarewhentheUTCIisbelow0degreesCelcius.

CheckHydraExampleFilesforOutdoorComfortCalculator

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Outdoor Comfort Calculator

PMVComfortCalculator

UsethiscomponenttocalculatecomfortmetricsofPredictedMeanVote(PMV),thePercentofPeopleDissatisfied(PPD),andtheStandardEffectiveTemperature(SET)forasetofclimateconditionsandoccupantbehavior/clothing.ThiscomponentcanalsocalculateOutdoorStandardEffectiveTemperature(OUT-SET)ifEPWweatherdataisconnected.HOWEVER,ifyouareinterestedinknowingwhetheroutdoorconditionsareactuallycomfortable,itishighlyrecommendedthatyouusetheLadybugUTCIComfortCalculator.OUT-SEThasbeenshowntobeapoorindicatorofoutdoorcomfortandisbetterusedasatooltohelpunderstandwhatclothingandmetabolicrateacomfortablepersonmighthaveintheoutdoorsAFTERrunningaUTCIstudy.PredictedMeanVote(PMV)isaseven-pointscaleofoccupantcomfortfromcold(-3)tohot(+3)thatwasusedinthecomfortsurveysof

LadybugPrimer

57PMV_Comfort_Calculator

P.O.Fanger,whoinitiallydevelopedthescaleandthePMVcomfortmodeloffofit.EachintergervalueofthePMVscaleindicatesthefollowing:-3:Cold,-2:Cool,-1:SlightlyCool,0:Neutral,+1:SlightlyWarm,+2:Warm,+3:Hot.TherangeofcomfortisgenerallyacceptedasaPMVbetween-1and+1.Exceeding+1willresultinanuncomfortablywarmoccupantwhiledroppingbelow-1willresultinanuncomfortablycooloccupant.PMVisaMEANvotebecauseismeanttorepresenttheaveragevoteofallpeopleundertheinputconditions.ThiscomponentwilloutputthePMVoftheoccupantfortheinputconditionsaswellasanestimatedPercentageofPeopleDissatisfied(PPD)underthegivenconditions.PPDreferstotheperceontofpeoplethatwouldgiveaPMVgreaterthan/equalto1orlessthan/equalto-1.Notethat,withthismodel,itisnotpossibletogetaPPDof0%andmostengineersjustaimtohaveaPPDbelow20%whendesigningaHVACsystem.ThiscomponentwillalsooutputStandardEffectiveTemperature(SET),whichisanajustedtemperaturescalemeanttoreflecttheheatstressorcoldfeltbytheoccupant.Specifically,SETisdefiniedastheequivalenttemperatureofanimaginaryenvironmentat50%relativehumidity,<0.1m/sairspeed,andmeanradianttemperatureequaltoairtemperature,inwhichthetotalheatlossfromtheskinofanimaginaryoccupantisthesameasthatfromapersonexistingundertheinputconditions.Itisalsoimportanttonotethattheimaginaryoccupantismodeledwithanactivitylevelof1.0metandaclothinglevelof0.6clo.Theactualoccupantintherealenvironmentcanhavedifferentvaluesfromthese.TheoriginalPMVstudiesbyFangerinvolvedplacingsubjectsinanairconditionedclimatechamberforanhourinwhichthesubjectshadnomeanstoadjusttheirconditionstomakethemcomfortable.SubjectswherethenaskedtopickanintergeronthePMVscale.SincePMVsubjectscouldnotchangetheirlayersofclothingoropenwindowstomakethemselvescomfortable,thePMVmodelismostusefulwhenappliedtotheseconditionsofanairconditionedbuildinginwhichuserscannotopenwindows,turnonfansorchangedresscode.Forcomfortinconditionswherepeoplecanadjustthesefactors,theadaptivecomfortcalculatororUTCIcomfortcalculatorwouldbemostuseful._ThecomfortmodelsthatmakethiscomponentpossibleweretranslatedtopythonfromaseriesofvalidatedjavascriptcomfortmodelscodedattheBerkelyCenterfortheBuiltEnvironment(CBE).ThePMVmodelusedbyboththeCBEToolandthiscomponentwasoriginallypublishedinASHARAE55.SpecialthanksgoestotheauthorsoftheonlineCBEThermalComfortToolwhofirstcodedthejavascriptcomfortmodels:HoytTyler,SchiavonStefano,PiccioliAlberto,MoonDustin,andSteinfeldKyle.http://cbe.berkeley.edu/comforttool/-

Inputs



LadybugPrimer





windSpeed[Optional]

Anumberrepresentingthewindspeedoftheairinmeterspersecond.Ifnovalueispluggedinhere,thiscomponentwillassumeaverylowwindspeedof0.05m/s,characteristicofmostindoorconditions.ThisinputcanalsoacceptalistofwindspeedsrepresentingconditionsatdifferenttimesorthedirectoutputofwindSpeedfromoftheImportEPWcomponent.


Anumberbetween0and100representingtherelativehumidityoftheairinpercentage.ThisinputcanalsoacceptalistofrelativehumidityvaluesrepresentingconditionsatdifferenttimesorthedirectoutputofrelativeHumidityfromoftheImportEPWcomponent.

metabolicRate[Optional]

Anumberrepresentingthemetabolicrateofthehumansubjectinmet.Thisinputcanalsoaccepttextinputsfordifferentactivities.AcceptabletextinputsincludeSleeping,Reclining,Sitting,Typing,Standing,Driving,Cooking,HouseCleaning,Walking,Walking2mph,Walking3mph,Walking4mph,Running9mph,Lifting10lbs,Lifting100lbs,Shoveling,Dancing,andBasketball.Ifnovalueisinputhere,thecomponentwillassumeametabolicrateof1met,whichisthemetabolicrateofaseatedhumanbeing.Thisinputcanalsoacceptlistsofmetabolicrates.

clothingLevel[Optional]

Anumberrepresentingtheclothinglevelofthehumansubjectinclo.Ifnovalueisinputhere,thecomponentwillassumeaclothinglevelof1clo,whichisroughlytheinsulationprovidedbya3-piecesuit.ApersondressedinshortsandaT-shirthasaclothinglevelofroughly0.5cloandapersoninathickwinterjacketcanhaveaclothinglevelashighas2to4clo.Thisinputcanalsoacceptlistsofclothinglevels.


Optionalcomfortparametersfromthe"Ladybug_PMVComfortParameters"component.

LadybugPrimer


Usethistoadjustmaximumandminimumacceptablehumidityratios.ThesecomfortParcanalsochangewhethercomfortisdefinedbyeightyorninetypercentofpeoplecomfortable.Bydefault,comfortisdefinedas90%oftheoccupantscomfortableandtherearenolimitsonhumiditywhenthereisnothermalstress.



calcBalanceTemperature[Optional]

Setto"True"tohavethecomponentcalculatethebalancetemperaturefortheinputwindSpeed,_relativeHumidity,metabolicRate,andclothingLevel_.ThebalancetemperatureisessentiallythetemperaturefortheseconditionsatwhichthePMVisequalto0(ortheenergyflowingintothehumanbodyisequaltotheenergyflowingout).Notethatcalculatingthebalancetemperatureforawholeyearwithepwwindspeedcantakeaslongas10minutesandso,bydefault,thisoptionissetto"False".

runIt[Required]

Setto"True"torunthecomponentandcalculatethePMVcomfortmetrics.

Outputs

readMe!

...

predictedMeanVote

Theestimatedpredictedmeanvote(PMV)oftestsubjectsundertheinputconditions.PMVisaseven-pointscalefromcold(-3)tohot(+3)thatwasusedincomfortsurveysofP.O.Fanger.Eachintergervalueofthescaleindicatesthefollowing:-3:Cold,-2:Cool,-1:SlightlyCool,0:Neutral,+1:SlightlyWarm,+2:Warm,+3:Hot.TherangeofcomfortisgenerallyacceptedasaPMVbetween-1and+1.Exceeding+1willresultinanuncomfortablywarmoccupantwhiledroppingbelow-1willresultinanuncomfortablycooloccupant.FordetailedinformationonthePMVscale,seeP.O.Fanger'soriginalpaper:Fanger,POle(1970).ThermalComfort:Analysisandapplicationsinenvironmentalengineering.

percentPeopleDissatisfied

LadybugPrimer


Theestimatedpercentageofpeopledissatisfied(PPD)underthegiveninputconditions.Specifically,thisisdefinedbythepercentofpeoplewhowouldhaveaPMVlessthan-1orgreaterthan+1undertheconditions.Notethat,withthismodel,itisnotpossibletogetaPPDof0%andmostengineersjustaimtohaveaPPDbelow20%.

standardEffectiveTemperature

Thestandardeffectivetemperature(SET)forthegiveninputconditionsindegreesCelcius.SETisanajustedtemperaturescalemeanttoreflecttheheatstressorcoldfeltbytheoccupant.Specifically,SETisdefiniedastheequivalenttemperatureofanimaginaryenvironmentat50%relativehumidity,<0.1m/sairspeed,andmeanradianttemperatureequaltoairtemperature,inwhichthetotalheatlossfromtheskinofanimaginaryoccupantisthesameasthatfromapersonexistingundertheinputconditions.Itisalsoimportanttonotethattheimaginaryoccupantismodeledwithanactivitylevelof1.0metandaclothinglevelof0.6clo.Theactualoccupantintherealenvironmentcanhavedifferentvaluesfromthese.

comfortableOrNot

Astreamof0'sand1's(or'False'and'True'values)indicatingwhethertheoccupantiscomfortableforeachhouroftheinputconditions.0indicatesthattheoccupantisnotcomfortablewhile1indicatesthattheoccupantiscomfortable.


Thepercentofinputconditionsforwhichtheoccupantiscomfortable.Notethatthisoutputisonlymenaingfulwhenmultiplevaluesareconnectedfortheinputconditions.

balanceTemperature

ThebalancetemperatureisthetemperaturefortheinputwindSpeed,_relativeHumidity,metabolicRate,andclothingLevel_atwhichthePMVisequalto0(ortheenergyflowingintothehumanbodyisequaltotheenergyflowingout).SettingthedrybulbandradianttemperaturestothisvaluewillproduceaPMVof0andwillyieldthelowestpossiblePPD.

CheckHydraExampleFilesforPMVComfortCalculator

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_PMV Comfort Calculator

ThermalComfortIndices

Usethiscomponenttocalculatevariousthermalcomfortindices:

HI(HeatIndex)humidex(humidityindex)DI(DiscomfortIndex)WCI(WindChillIndex)WCT(WindChillTemperature)

LadybugPrimer

62Thermal_Comfort_Indices

WBGT(Wet-BulbGlobeTemperature)indoorsWBGT(Wet-BulbGlobeTemperature)outdoorsTE(EffectiveTemperature)AT(ApparentTemperature)TS(ThermalSensation)ASV(ActualSensationVote)MRT(MeanRadiantTemperature)Iclp(PredictedInsulationIndexOfClothing)HR(HeartRate)DhRa(DehydrationRisk)PET(PhysiologicalEquivalentTemperature)THI(TemperatureHumidityIndex)PHS(PredictedHeatStrain)-

Inputs

comfortIndex[Required]

Chooseoneofthecomfortindices:0-HI(HeatIndex)1-humidex(humidityindex)2-DI(DiscomfortIndex)3-WCI(WindChillIndex)4-WCT(WindChillTemperature)5-WBGT(Wet-BulbGlobeTemperature)indoors6-WBGT(Wet-BulbGlobeTemperature)outdoors7-TE(EffectiveTemperature)8-AT(ApparentTemperature)9-TS(ThermalSensation)10-ASV(ActualSensationVote)11-MRT(MeanRadiantTemperature)12-Iclp(PredictedInsulationIndexOfClothing)13-HR(HeartRate)14-DhRa(DehydrationRisk)15-PET(PhysiologicalEquivalentTemperature)fortemperateclimates16-PET(PhysiologicalEquivalentTemperature)fortropicalandsubtropicalhumidclimates17-THI(TemperatureHumidityIndex)18-PHS(PredictedHeatStrain)

location[Required]

InputdatafromLadybug's"Importepw""location"output,orcreateyourownlocationdatawithLadybug's"ConstructLocation"component.


Airtemperature.Inputasinglevalueorawholelistfrom"Importepw"component's"dryBulbTemperature"output.-InCelsiusdegrees(°C).


Anaveragetemperatureofthesurfacesthatsurroundtheanalysislocation.Forindoorconditionsoroutdoorin-shade,itshouldbeequaltoairtemperature.Sojustinputthe

LadybugPrimer


samedatayouinputtedto"_dryBulbTemperature".-Ifnothingsupplied,itwillbecalculatedforoutdoorconditions(bothin-shadeandout-shade).-InCelsiusdegrees(°C).

dewPointTemperature[Optional]

Dewpointtemperature.Inputasinglevalueorawholelistfrom"Importepw"component's"dewPointTemperature"output.-Ifnotsupplied,itwillbecalculatedfromdryBulbTemperatureandrelativeHumiditydata.-InCelsiusdegrees(°C).

relativeHumidity[Optional]

Relativehumidity.Inputasinglevalueorawholelistfrom"Importepw"component's"relativeHumidity"output.-Ifnotsupplied50%willbeusedasadefault(indoorconditions).-Inpercent(from0%to110%).

windSpeed[Optional]

Windspeedat1.1metersheightfromanalysissurface(heightofstandingperson’sgravitycenter).Itcanbeasinglevalueoralistofvalues.Takethe"windSpeed"outputfrom"Importepw"componentandplugitto"WindSpeedCalculator"component's"windSpeed_tenMeters"input.Setthe"heightAboveGround"inputto"1.1".Thenpluginthedatafrom"WindSpeedCalculator"component's"windSpeedAtHeight"outputtothiscomponent's"windSpeed_"input.Inthiswayweconvertedthe10meterwindspeedfromthe.epwfiletorequired1.1m.-Ifnotsupplied,defaultvalueof0.3m/sisused(meaning:theanalysisisconductedinoutdoornowindconditions,orindoorconditions).-Inmeters/second.

globalHorizontalRadiation[Optional]

Totalamountofdirectanddiffusesolarradiationthatananalysispersonreceived.Usethe"globalHorizontalRadiation"datafromLadybug's"Importepw"componentforanalysiswithoutshading.Foranalysiswithshadingincluded,usethe"shadedSolarRadiationPerHour"outputfrom"Sunpathshading"componentinstead.-Ifnotsupplied,defaultvalueof0Wh/m2willbeused(meaning:theanalysisisconductedinoutdoorinshadeconditions,orindoorconditions).-InWh/m2.

totalSkyCover[Optional]

Amountofskydomecoveredbyclouds.Inputasinglevalueorawholelistfrom"Importepw"component's"totalSkyCover"output.Itrangesfromfrom1to10.Forexample:1is1/10covered.10istotalcoverage(10/10).-Ifnotsupplied6/10willbeused(cloudcoverageoftemperatehumidclimate).-Intenthsofskycover.

LadybugPrimer


bodyCharacteristics[Optional]

Alistofbodycharacteristicsinthefollowingorder:age,sex,height,weight,bodyPosition,clothingInsulation,acclimated,metabolicRate,activityDuration.UseLadybug's"BodyCharacteristics"componenttogenerateit.-

Ifnotsupplied,thefollowingdefaultvalueswillbeused:30-age"male"-sex175-heightincentimeters75-weightinkilograms"standing"-bodyPositionNone(clothingInsulation-"None"meansthatitwillbecalculatedbasedonairtemperature)37-clothingAlbedoin%(formediumcoloredclothes)"unacclimated"-acclimated2.32-metabolicRateinmets(2.32correspondstowalking4km/h)480-activityDurationinminutes

HOY[Optional]

Anhour(orhours)oftheyearforwhichyouwouldliketocalculatethermalindices.Thesehoursmustbeavaluebetween1and8760.ThisinputwilloverridetheanalysisPeriod_inputbelow.-Ifnotsupplied,thisinputwillbeignored.


Anoptionalanalysisperiodfromthe"AnalysisPeriod"component.-Ifnotsupplied,thewholeyearperiodwillbeusedasananalysisperiod.

runIt[Required]

...

Outputs

readMe!

...

comfortIndexValue

Thevalueofthechosencomfort.

comfortIndexLevel

Thelevel(category,sensation)ofthechosenindex.

LadybugPrimer


comfortableOrNot

Indicationofwhetherthatpersoniscomfortable(1)ornot(0)atparticularhour.

percentComfortable

Percentageoftime,duringwhichchosenindexfallsintothecomfortablecategory.

percentHotExtreme

Percentageoftime,duringwhichchosenindexfallsintothehotextremecategory.

percentColdExtreme

Percentageoftime,duringwhichchosenindexfallsintothecoldextremecategory.

CheckHydraExampleFilesforThermalComfortIndices

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Thermal Comfort Indices

CDH_HDH

Calculatesheatingandcoolingdegree-hours.Degree-hoursaredefinedasthedifferencebetweenthebasetemperatureandtheaverageambientoutsideairtemperaturemultipliedbythenumberofhoursthatthisdifferenceconditionexists.-

Inputs

hourlyDryBulbTemperature[Required]

AnnualdrybulbtemperaturefromtheImportepwcomponent(indegreesCelsius).

LadybugPrimer

67CDH_HDH

coolingBaseTemperature[Default]

Basetemperatureforcooling(indegreesCelsius).Defaultissetto23.3Cbutthiscanbemuchloweriftheanalysisisforabuildingwithhighheatgainorinsulation.

heatingBaseTemperature[Default]

Basetemperatureforheating(indegreesCelsius).Defaultissetto18.3Cbutthiscanbemuchloweriftheanalysisisforabuildingwithhighheatgainorinsulation.

Outputs

readMe!

Aummaryoftheinput.

hourly_coolingDegHours

Coolingdegree-hoursforeachhouroftheyear.Forvisualizationsoverthewholeyear,connectthistothegrasshopperchart/graphcomponent.

hourly_heatingDegHours

Heatingdegree-daysforeachhouroftheyear.Forvisualizationsoverthewholeyear,connectthistothegrasshopperchart/graphcomponent.

daily_coolingDegHours

Coolingdegree-dayssummedforeachdayoftheyear.Forvisualizationsofoverthewholeyear,connectthistothegrasshopperchart/graphcomponent.

daily_heatingDegHours

Heatingdegree-dayssummedforeachdayoftheyear.Forvisualizationsofoverthewholeyear,connectthistothegrasshopperchart/graphcomponent.

monthly_coolingDegHours

Coolingdegree-dayssummedforeachmonthoftheyear.

monthly_heatingDegHours

Heatingdegree-dayssummedforeachmonthoftheyear.

annual_coolingDegHours

Thetotalcoolingdegree-daysfortheentireyear.

LadybugPrimer

68CDH_HDH

annual_heatingDegHours

Thetotalheatingdegree-daysfortheentireyear.

CheckHydraExampleFilesforCDH_HDH

LadybugPrimer

69CDH_HDH

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_CDH_HDH

ClothingFunction

Usethiscomponenttogeneratealistofvaluesrepresentingaclothingschedulebasedonoutdoorairtemperature.ThisschedulecanbepluggedintotheclothingLevel_inputofthePMVComfortCalculatorcomponent.Bydefault,thisfunctionusedtoderiveclothinglevelsbasedonoutsidetemperaturewasdevelopedbySchiavon,StefanoandimplementedontheCBEcomforttool(http://smap.cbe.berkeley.edu/comforttool/).Thisversionofthecomponentallowsuserstochangethemaximumandminimumclothinglevels,whichSchiavonsetat1and0.46respectively,andthetemperaturesatwhichtheseclothinglevelsoccur,whichSchiavonsetat26Cand-5Crespectively.NotethatSchiavondidnotendorsethechangingofthesevaluesbuttheyareprovidedheretoallowusersanadditionalleveloffreedom.-

LadybugPrimer

70Clothing_Function

http://smap.cbe.berkeley.edu/comforttool/

Inputs

outdoorAirTemperature[Required]

AnumberorlistofnumbersrepresentingthedrybulbtemperatureoftheairindegreesCelcius.ThisinputcanalsoacceptthedirectoutputofdryBulbTemperaturefromtheImportEPWcomponentandthisisrecommendedforhourlycomfortanalysis.


IfyouhavehookedupannualtemperaturesfromtheimportEPWcomponent,usethisinputto

maxClo[Optional]

AnoptionalnumberrepresentingthemaximumclovaluethatsomeonewillwearonthecoldestdaysoftheoutdoorAirTemperatureinput.Thedefaultissetto1clo,whichcorrespondstoa3-piecesuit.

maxCloTemp[Optional]

AnoptionalnumberrepresentingthetemperatureatwhichthemaxClovaluewillbeapplied.Thedefaultissetto-5C,whichmeansthatanylowertemperaturewillgetthemaxClovalue.

minClo[Optional]

AnoptionalnumberrepresentingtheminimumclovaluethatsomeonewillwearonthehotestdaysoftheoutdoorAirTemperatureinput.Thedefaultissetto0.46clo,whichcorrespondstoshortsandaT-shirt.

minCloTemp[Optional]

AnoptionalnumberrepresentingthetemperatureatwhichtheminClovaluewillbeapplied.Thedefaultissetto26C,whichmeansthatanyhighertemperaturewillgettheminClovalue.

Outputs

readMe!

...

cloValues

Alistofnumbersrepresentingtheclothingthatwouldbewornateachhourofthe

LadybugPrimer

71Clothing_Function

_outdoorAirTemperature.Notethat,ifthecomponentsensesthatyouhavehookedupastreamofhourlydata,theclothinglevelswillalternateona12-hourbasis.

CheckHydraExampleFilesforClothingFunction

LadybugPrimer

72Clothing_Function

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Clothing Function

HumidityRatioCalculator

CalculatesthehumidityratiofromtheladybugweatherfileimportparametersConversionformulasaretakenfromthefollowingpublications:Vaisala.(2013)HumidityConversionFormulas:CalculationFormulasforHumidity.www.vaisala.com/Vaisala%20Documents/Application%20notes/Humidity_Conversion_Formulas_B210973EN-F.pdfW.WagnerandA.Pruß:"TheIAPWSFormulation1995fortheThermodynamicPropertiesofOrdinaryWaterSubstanceforGeneralandScientificUse",JournalofPhysicalandChemicalReferenceData,June2002,Volume31,Issue2,pp.387535-

Inputs

LadybugPrimer

73Humidity_Ratio_Calculator


ThedrybulbtemperaturefromtheImportepwcomponent.


TherelativehumidityfromtheImportepwcomponent.

barometricPressure[Required]

ThebarometricpressurefromtheImportepwcomponent.

Outputs

readMe!

...

humidityRatio

Thehourlyhumidityratio(kgwater/kgair).

enthalpy

Thehourlyenthalpyoftheair(kJ/kg).

partialPressure

Thehourlypartialpressureofwatervaporintheatmosphere(Pa).

saturationPressure

Thesaturationpressureofwatervaporintheatmosphere(Pa).

CheckHydraExampleFilesforHumidityRatioCalculator

LadybugPrimer

74Humidity_Ratio_Calculator

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Humidity Ratio Calculator

Componentlist:

3D_Chart

Adaptive_Comfort_Chart

Monthly_Bar_Chart

Psychrometric_Chart

GenCumulativeSkyMtx

selectSkyMtx

Colored_Sky_Visualizer

Outdoor_Solar_Temperature_Adjustor

Radiation_Calla_Lily

Radiation_Rose

Sky_Dome

SunPath

Wind_Boundary_Profile

Wind_Rose

Import_Ground_Temp

LadybugPrimer

752|VisualizeWeatherData

3DChart

Usethiscomponenttomakea3DchartintheRhinosceneofanyclimatedataorhourlysimulationdata.-

Inputs

inputData[Required]

Alistofinputdatatoplot.

basePoint[Default]

LadybugPrimer

763D_Chart

Anoptionalpointwithwhichtolocatethe3DchartintheRhinoModel.ThedefaultissettotheRhinooriginat(0,0,0).

xScale[Default]

ThescaleoftheXaxisofthegraph.ThedefaultwillplottheXaxiswithalengthof3650Rhinomodelunits(for365daysoftheyear).Connectalistofvaluesformultiplegraphs.

yScale[Default]

ThescaleoftheYaxisofthegraph.ThedefaultwillplottheYaxiswithalengthof240Rhinomodelunits(for24hoursoftheday).Connectalistofvaluesformultiplegraphs.

zScale[Default]

ThescaleoftheZaxisofthegraph.ThedefaultwillplottheZaxiswithanumberofRhinomodelunitscorrespondingtotheinputdatavalues.Setto0toseegraphCurvesappearontopofthemesh.Connectalistofvaluesformultiplegraphs.

yCount[Default]

Thenumberofsegmentsonyoury-axis.Thedefaultissetto24for24hoursoftheday.Thisvariableisparticularlyusefulforinputdatathatisnotforeachhouroftheyear.

legendPar[Optional]

OptionallegendparametersfromtheLadybugLegendParameterscomponent.

condStatement[Optional]

Anoptionalconditionalstatement,whichwillremovedatafromthechartthatdoesnotfittheconditions.Theinputmustbeavalidpythonconditionalstatement(e.g.a>25).

bakeIt[Optional]

IfsettoTrue,thechartwillbeBakedintotheRhinosceneasacoloredmesh.TextwillbebakedasRhinotextobjects,whichfacilitateseasyexporttoPDForvector-editingprograms.

Outputs

readMe!

...

LadybugPrimer

773D_Chart

graphMesh

A3Dplotoftheinputdataasacoloredmesh.Multiplemesheswillbeoutputforseveralinputdatastreamsorgraphscales.

graphCurves

Alistofcurvesandtextsurfacesrepresentingthetimeperiodscorrespondingtotheinputdata.Notethatifthetimeperiodoftheinputdataisnotclear,nocurvesorlabelswillbegeneratedhere.

legend

Alegendofthechart.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendintheRhinoscene.g

legendBasePts

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtothechartwiththenativerasshopper"Move"component.

title

Thetitletextofthechart.HookthisuptoanativeGrasshopper'Geo'componenttopreviewitseparatelyfromtheotheroutputs.

titleBasePts

Pointsforplacementofthetitleandaxeslabelsofthechart,whichcanbeusedtomovethesetextitemsinrelationtothechartwiththenativeGrasshopper"Move"component.

dataPts

Pointsrepresentingthelocationofeachpieceofdataonthechart.Usethistolabelthepointsofthechartwithtextlablesusinganativegrasshopper"TextTag"component.

conditionalHOY

Theinputdataforthehoursoftheyearthatpasstheconditionalstatement.

CheckHydraExampleFilesfor3DChart

LadybugPrimer

783D_Chart

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_3D Chart

AdaptiveComfortChart

Usethiscomponenttocalculatetheadaptivecomfortforagivensetofinputconditions.Thiscomponentwilloutputastreamof0'sand1'sindicatingwhethercertainconditionsarecomfortablegiventheprevailingmeanmonthlytemperaturethatocuppantstendtoadaptthemselvesto.Thiscomponentwillalsooutputaseriesofintergernumbersthatindicatethefollowing:-1=Theaveragemonthlytemperatureistooextremefortheadaptivemodel.0=Theinputconditionsaretoocoldforoccupants.1=Theinputconditionsarecomfortableforoccupants.2=Theinputconditionsaretoohotforoccupants.Lastly,thiscomponentoutputsthepercentoftimecomfortable,hot,coldandmonthlyextremeaswellasalitofnumbersindicatingtheuppertemperatureofcomfortandlowertemperatureofcomfort.TheadaptivecomfortmodelwascreatedinresponsetotheshortcomingsofthePMVmodelthat

LadybugPrimer

79Adaptive_Comfort_Chart

becameapparentwhenitwasappliedtobuildingswithoutairconditioning.Namely,thePMVmodelwasover-estimatingthediscomfortofoccupantsinwarmconditionsofnautrallyventilatedbuildings.Accordingly,theadaptivecomfortmodelwasbuiltontheworkofhundredsoffieldstudiesinwhichpeopleinnaturallyventilatedbuildingswereaskedaskedabouthowcomfortabletheywere.Resultsshowedthatuserstendedtoadaptthemselvestothemonthlymeantemperatureandwouldbecomfortableinbuildingssolongasthebuildingtemperatureremainedaroundavalueclosetothatmonthlymean.Thissituationheldtruesolongasthemonthlymeantemperatureremainedabove10Candbelow33.5C.ThecomfortmodelsthatmakethiscomponentpossibleweretranslatedtopythonfromaseriesofvalidatedjavascriptcomfortmodelscodedattheBerkelyCenterfortheBuiltEnvironment(CBE).TheAdaptivemodelusedbyboththeCBEToolandthiscomponentwasoriginallypublishedinASHARAE55.SpecialthanksgoestotheauthorsoftheonlineCBEThermalComfortToolwhofirstcodedthejavascript:HoytTyler,SchiavonStefano,PiccioliAlberto,MoonDustin,andSteinfeldKyle.http://cbe.berkeley.edu/comforttool/-

Inputs


AnumberrepresentingthedrybulbtemperatureoftheairindegreesCelcius.ThisinputcanalsoacceptalistoftemperaturesrepresentingconditionsatdifferenttimesorthedirectoutputofdryBulbTemperaturefromthe'ReadEPResult'or'ImportEPW'component.


AnumberrepresentingthemeanradianttemperatureofthesurroundingsurfacesindegreesCelcius.Ifnovalueispluggedinhere,thiscomponentwillassumethatthemeanradianttemperatureisequaltoairtemperaturevalueabove.Thisinputcanalsoacceptalistoftemperaturesrepresentingconditionsatdifferenttimesorthedirectoutputfromthe'ReadEPResult'or'ImportEPW'component.

prevailingOutdoorTemp[Required]

AnumberrepresentingtheprevailingoutdoortemperatureindegreesCelcius.FortheASHRAEstandard,thisistheaveragemonthlyoutdoortemperatureand,fortheEuropeanstandard,thisisarunningmeanoutdoortemperaturecalculatedfromtheconditionsofthelastweek.Forthisreason,thisinputcanalsoacceptthedirectoutputofdryBulbTemperaturefromthe'ImportEPW'componentifhoulryvaluesforthefullyearareconnectedfortheotherinputsofthiscomponent.Thisinputfromthe'ImportEPW'componentisrecommended.

LadybugPrimer



windSpeed[Optional]

Anumberrepresentingthewindspeedoftheairinmeterspersecond.Ifnovalueispluggedinhere,thiscomponentwillassumealowwindspeedof<0.2m/s,characteristicofmostnaturallyventilatedbuildingswithoutfans.Thisinputcanalsoacceptseveralwindspeedstogeneratemultiplecomfortpolygons.Lastly,thiscomponentcanacceptthedirectoutputofwindSpeedfromoftheImportEPWcomponentand,fromthisdata,twocomfortpolygonswillbedrawnrepresentingthemaximumandminumuwindspeed.


Optionalcomfortparametersfromthe"Ladybug_AdaptiveComfortParameters"component.UsethistoselecteithertheUSorEuropeancomfortmodel,setthethresholdofacceptibilityforcomfortorcomputeprevailingoutdoortemperaturebyamonthlyaverageorrunningmean.ThesecomfortParcanalsobeusedtosetalevelOfConditioning,whichmakesuseofresearchoutsideoftheofficialpublishedstandardsthatsurveyedpeopleinairconditionedbuildings.

includeColdTime[Optional]

Setto"True"tohavethecomponentincludethetimeperiodwheretheoutdoortemperatureistoocoldfortheofficialASHRAEorEuropeanstandardandsetto"False"toexcludeit.Whentheoutdoortemperatueistoocoldforthesestandards,acorrelationfromrecentresearchisused.Thedefaultissetto"True"toincludethecoldperiodinthevisualizationandoutput.


AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.IfnoAnalysisperiodisgivenandepworenergysimulationdatahasbeenconnected,theanalysiswillberunfortheenitreyear.

annualHourlyData[Optional]

Anoptionallistofhourlydatafromthe'ImportEPW'component,whichwillbeusedtocreatehourPointColorsthatcorrespondtothehoursofthedata(e.g.windSpeed).YoucanconnectupseveraldifferentannualHourlydatahere.

conditionalStatement[Optional]

Thisinputallowsuserstoremovedatathatdoesnotfitspecificconditionsorcriteriafromtheadaptivechart.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<80"(withoutquotationmarks).The

LadybugPrimer


currentversionofthiscomponentaccepts"and"and"or"operators.Tovisualizethehourlydata,onlylowercaseEnglishlettersshouldbeusedasvariables,andeachletteralphabeticallycorrespondstoeachofthelists(intheirrespectiveorder):"a"alwaysrepresentsthe1stlistpluggedintoannualHourlyData,"b"alwaysrepresentsthe2ndlistpluggedintoannualHourlyData,"c"alwaysrepresentsthe3rdlistpluggedintoannualHourlyData_,etc.Forexample,ifyouwanttoplotthedataforthetimeperiodwhentemperatureisbetween18Cand23C,andhumidityislessthan80%,theconditionalstatementshouldbewrittenas“18<a<23andb<80”(withoutquotationmarks).

basePoint[Optional]

AnoptionalbasepointthatwillbeusedtoplacetheadaptivechartintheRhinoscene.Ifnobasepointisprovided,thebasepointwillbetheRhinomodelorigin.

scale[Optional]

AnoptionalnumbertochangethescaleoftheadaptivechartintheRhinoscene.Bydefault,thisvalueissetto1.

legendPar[Optional]


runIt[Required]

Setto"True"torunthecomponentandgenerateanAdaptivecomfortchart.

Outputs

readMe!

...

comfPercentOfTime

Thepercentoftheinputdataforwhichtheoccupantsarecomfortable.Comfortableconditionsarewhentheindoortemperatureiswithinthecomfortrangedeterminedbytheprevailingoutdoortemperature.

percentHotCold

Alistof2numericalvaluesindicatingthefollowing:0)Thepercentoftheinputdataforwhichtheoccupantsaretoohot.1)Thepercentoftheinputdataforwhichtheoccupantsaretoocold.

LadybugPrimer


comfortableOrNot

Astreamof0'sand1's(or"False"and"True"values)indicatingwhetheroccupantsarecomfortableundertheinputconditionsgiventhefactthattheseoccupantstendtoadaptthemselvestotheprevailingmeanmonthlytemperature.0indicatesthatapersonisnotcomfortablewhile1indicatesthatapersoniscomfortable.

conditionOfPerson

Astreamofintergervaluesfrom-1to+1thatcorrespondtoeachhouroftheinputdataandindicatethefollowing:-1=Theinputconditionsaretoocoldforoccupants.0=Theinputconditionsarecomfortableforoccupants.+1=Theinputconditionsaretoohotforoccupants.

degreesFromTarget

AstreamoftemperaturevaluesindegreesCelciusindicatinghowfarfromthetargettemperaturetheconditionsofthepeopleare.Positivevaluesindicateconditionshotterthanthetargettemperaturewhilenegativevaluesindicatedegreesbelowthetargettemperture.

chartCurvesAndTxt

Thechartcurvesandtextlabelsoftheadaptivechart.

adaptiveChartMesh

Acoloredmeshshowingthenumberofinputhourshappenineachpartoftheadaptivechart.

legend

Acoloredlegendshowingthenumberofhoursthatcorrespondtoeachcolor.

legendBasePt

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtothechartwiththegrasshopper"move"component.

comfortPolygons

Abreprepresentingtherangeofcomfortfor.

chartHourPoints

PointsrepresentingeachofthehoursofinputtemperatureandopTemperityratio.By

LadybugPrimer


default,thisouputishiddenand,toseeit,youshouldconnectittoaGrasshopperpreviewcomponent.

hourPointColors

ColorsthatcorrespondtothechartHourPointsaboveandcanbehookeduptothe"Swatch"inputofaGrasshopperPreviewcomponentthathasthehourpointsaboveconnectedasgeometry.Bydefault,pointsarecoloredrediftheylieinsidecomfortpolygonandarecoloredblueiftheydonotmeetsuchcomfortcriteria.IntheeventthatyouhavehookedupannualHourlyData_thisoutputwillbeagraftedlistofcolors.ThefirstlistcorrespondstothecomfortconditionswhilethesecondlistcolorspointsbasedontheannualHourlyData.

hourPointLegend

Alegendthatcorrespondstothehourpointcolorsabove.IntheeventthatannualHourlyData_isconnected,thisoutputwillbeagraftedlistoflegendsthateachcorrespondtothegraftedlistsofcolors.

CheckHydraExampleFilesforAdaptiveComfortChart

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Adaptive Comfort Chart

MonthlyBarChart

UsethiscomponenttomakeabarchartintheRhinosceneofanymonhtlyoravrMonthyPerHourclimatedataorsimulationdata._Thiscomponentcanalsoplotdailyorhourlydatabut,forvisualizingthistypeofdata,itisrecommendedthatyouusethe"Ladybug_3DChart"component.-

Inputs

inputData[Required]

Alistofinputdatatoplot.Thisshouldusuallybedataoutofthe'Ladybug_Average

LadybugPrimer

85Monthly_Bar_Chart

Data'componentormonthlydatafromanenergysimulationbutcanalsobehourlyordailydatafromthe'Ladybug_ImportEPW.'However,itisrecommendedthatyouusethe'Ladybug_3DChart'componentfordailyorhourlydataasthisisusuallyabitclearer.

comfortModel[Optional]

Anoptionalintergertodrawthecomfortmodelonthechart.Choosefromthefollowing:0-Nocomfortrange1-PMVcomfortrange(indoor)2-Adaptiveconfortrange(naturallyventilated)3-UTCIComfort(outdoor)Notethatthisoptionisonlyavailablewhentemperatureisconnectedso,bydefault,itissetto0fornocomfortrange.

bldgBalancePt[Optional]

Anoptionalfloatvaluetorepresenttheoutdoortemperatureatwhichtheenergypassivelyflowingintoabuildingisequaltothatflowingoutofthebuilding.Thisisusuallyanumberthatiswellbelowthecomforttemperture(~12C-18C)sincetheinternalheatofabuildinganditsinsulationkeeptheinteriorwarmerthentheexterior.However,bydefault,thisissetto23.5Cforfullyoutdoorconditions.

stackValues[Optional]

Setto'True'ifyouhavemultipleconnectedmonthlyordaily_inputDatawiththesameunitsandwantthemtobedrawnasbarsstackedontopofeachother.Otherwise,allbarsformonthly/dailydatawillbeplacednexttoeachother.Thedefaultissetto'False'tohavethesebarsplacednexttoeachother.

plotFromZero[Optional]

Setto'True'tohavethecomponentplotallbarvaluesstartingfromzero(asopposedfromthebottomofthechart,whichmightbeanegativenumber).Thisisusefulwhenyouareplottingthetermsofanenergybalancewhereyouwantgainstobeabovezeroandlossestobebelow.Itcanbedetrimentalifyouareplottingtemperaturesindegreescelciusanddonotwantnegativevaluestogobelowzero.Assuch,thedefaultissetto'False'tonotplotfromzero.

altTitle[Optional]

Anoptionaltextstringtoreplacethedefaulttitleofthechartofthechart.Thedefaultissettopickoutthelocationofthedataconnectedto'inputData.'

altYAxisTitle[Optional]

AnoptionaltextstringtoreplacethedefaultY-Axislabelofthechart.Thiscanalsobea

LadybugPrimer

86Monthly_Bar_Chart

listof2y-axistitlesiftherearetwodifferenttypesofdataconnectedto_inputData.Thedefaultissettopickoutthenamesofthefirst(andpossiblythesecond)listconnectedtothe'inputData.'

basePoint[Default]

Anoptionalpointwithwhichtolocatethe3DchartintheRhinoModel.ThedefaultissettotheRhinooriginat(0,0,0).

xScale[Default]

ThescaleoftheXaxisofthegraph.Thedefaultissetto1andthiswillplottheXaxiswithalengthof120Rhinomodelunits(for12monthsoftheyear).

yScale[Default]

ThescaleoftheYaxisofthegraph.Thedefaultissetto1andthiswillplottheYaxiswithalengthof50Rhinomodelunits.

legendPar[Optional]


Outputs

readMe!

...

dataMesh

Aseriesofmeshesthatrepresentthedifferentmonthly(ordaily)inputdata.Multiplelistsofmesheswillbeoutputforseveralinputdatastreams.

dataCurves

AlistofcurvesthatrepresentthedifferentavrMonthyPerHourandhourlyinputdata.Multiplelistsofcurveswillbeoutputforseveralinputdatastreams.

dataCrvColors

AlistofcolorsthatcorrespondtothedataCurvesabove.Hookthisuptothe'swatch'inputofthenativeGrasshopper'Preview'componentandthecurvesaboveuptothe'geometryinputtopreviewthecurveswiththeirrepectivecolor.

graphAxes

LadybugPrimer

87Monthly_Bar_Chart

Alistofcurvesrepresentingtheaxesofthechart.

graphLabels

Alistoftextmeshesrepresentingthetimeperiodscorrespondingtotheinputdata

title

Atitleforthechart.Bydefault,thisisjustthelocationofthedatabutyoucaninputacustomtitlewiththealtTitle_input.

titleBasePt

Thetitlebasepoint,whichcanbeusedtomovethetitleinrelationtothechartwiththegrasshopper"move"component.

legend

Alegendofthechartthattellswhateachconnecteddatastram'scoloris.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendintheRhinoscene.

legendBasePt


dataLabelPts

Aseriesofpointsthatmarkwhereeachofthebarsorlinesofthechartlie.Youcanusethistolabelthebarsorlineswithnumericalvaluesusinganativegrasshopper"texttag"componentandthedatathatyouhaveconnectedtothe_inputDataofthiscomponent.

comfortBand

AseriesofmeshesthatrepresentthecomfortrangeineachmonthaccordingtotheinputcomfortModel_.

CheckHydraExampleFilesforMonthlyBarChart

LadybugPrimer

88Monthly_Bar_Chart

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Monthly Bar Chart

PsychrometricChart

UsethiscomponenttodrawapsychrometricchartintheRhinosceneandevaluateasetoftemperaturesandhumidityratiosintermsofindoorcomfort.ConnecteddatacanincludeeitheroutdoortemperatureandhumidtyratiosfromimportedEPWweatherdata,indoortemperatureandhumidityratiosfromanenergysimulation,orindivdualnumericalinputsoftemperatureandhumidity.Theinputdatawillbeplottedalongsidepolygonsonthechartrepresentingcomfortaswellaspolygonsrepresentingtheefectsofpassivebuildingstrategiesoncomfort.ThespecifichumanenergybalancemodelusedbythepsychrometricchartisthePredictedMeanVote(PMV)modeldevelopedbyP.O.Fanger.PMVisaseven-pointscalefromcold(-3)tohot(+3)thatisusedincomfortsurveys.Eachintergervalueofthescaleindicatesthefollowing:-3:Cold,-2:Cool,-1:SlightlyCool,0:Neutral,+1:Slightly

LadybugPrimer

89Psychrometric_Chart

Warm,+2:Warm,+3:Hot.TherangeofcomfortisgenerallyacceptedasaPMVbetween-1and+1andthisiswhatdefinestherangeofthecomfortpolygononthepsychrometricchart.Accordingly,thiscomponentwillalsooutputthePMVoftheoccupantfortheinputconditionsaswellasanestimatedpercentageofpeopledissatisfied(PPD)inthegivenconditions.ThecomfortmodelsthatmakethiscomponentpossibleweretranslatedtopythonfromaseriesofvalidatedjavascriptcomfortmodelsdevelopedattheBerkelyCenterfortheBuiltEnvironment(CBE).Specificdocumentationonthecomfortmodelscanbefoundhere:https://code.google.com/p/cbe-comfort-tool/wiki/ComfortModelsSpecialthanksgoestotheauthorsoftheonlineCBEThermalComfortToolwhofirstmadethejavascriptmodelsinordertopowerthetool:HoytTyler,SchiavonStefano,PiccioliAlberto,MoonDustin,andSteinfeldKyle,2013,CBEThermalComfortTool.CenterfortheBuiltEnvironment,UniversityofCaliforniaBerkeley,http://cbe.berkeley.edu/comforttool/Theinformationforthepolygonsrepresentingpassivestrategiescomesfromtheclimateconsultantpsychrometricchart.Furtherinformationonhowthesepolygonsarecalculatedcanbefoundhere:http://apps1.eere.energy.gov/buildings/tools_directory/software.cfm/ID=123/pagename=alpha_list-

Inputs


AnumberrepresentingthedrybulbtemperatureoftheairindegreesCelcius.ThisinputcanalsoacceptalistoftemperaturesrepresentingconditionsatdifferenttimesorthedirectoutputofdryBulbTemperaturefromtheImportEPWcomponent.IndoortemperaturesfromHoneybeeenergysimulationsarealsopossibleinputs.Finally,thiscomponentcanalsoacccepttemperaturesinFarenheitinordertodrawachartwithIPunitsbut,inorderforthiscomponenttosensethatthevaluesareFarenheit,theremustbeatleastone'F'or'°F'inthestreamofconnecteddata.



barometricPressure[Optional]

AnumberrepresentingthebarometricpressureinPascals.Ifnovalueisconnectedhere,thedefaultpressurewillbe101325Pa,whichisairpressureatsealevel.ItisrecommendedthatyouconnectthebarometricpressurefromtheImportepwcomponenthereastheairpressureatsealevelcancausesomemisleadingresultsfor

LadybugPrimer


https://code.google.com/p/cbe-comfort-tool/wiki/ComfortModels


http://apps1.eere.energy.gov/buildings/tools_directory/software.cfm/ID=123/pagename=alpha_list

citiesathigherelevations.

meanRadTemperature[Optional]

Anumberrepresentingthemeanradianttemperatureofthesurroundingsurfaces.ThisvalueshouldbeindegreesCelciusunlessyouhaveconnectedvaluesinFarenheittothedryBulbTemperatureandyouareseeingachartinIPunits.Ifnovalueispluggedinhere,thiscomponentwillassumethatthemeanradianttemperatureisequalto23C.Thisinputcanalsoacceptalistoftemperaturesandthiswillproduceseveralcomfortpolygons(oneforeachmeanradianttemperature).

windSpeed[Optional]

Anumberrepresentingthewindspeedoftheairinmeterspersecond.Ifnovalueispluggedinhere,thiscomponentwillassumeaverylowwindspeedof0.05m/s,characteristicofmostindoorconditions.Thisinputcanalsoacceptalistofwindspeedsrepresentingconditionsandthiswillproduceseveralcomfortpolygons(oneforeachwindspeed).


Anumberrepresentingthemetabolicrateofthehumansubjectinmet.Thisinputcanalsoaccepttextinputsfordifferentactivities.AcceptabletextinputsincludeSleeping,Reclining,Sitting,Typing,Standing,Driving,Cooking,HouseCleaning,Walking,Walking2mph,Walking3mph,Walking4mph,Running9mph,Lifting10lbs,Lifting100lbs,Shoveling,Dancing,andBasketball.Ifnovalueisinputhere,thecomponentwillassumeametabolicrateof1met,whichisthemetabolicrateofaseatedhumanbeing.Thisinputcanalsoacceptlistsofmetabolicratesandwillproducemultiplecomfortpolygonsaccordingly.


Anumberrepresentingtheclothinglevelofthehumansubjectinclo.Ifnovalueisinputhere,thecomponentwillassumeaclothinglevelof1clo,whichisroughlytheinsulationprovidedbya3-piecesuit.ApersondressedinshortsandaT-shirthasaclothinglevelofroughly0.5cloandapersoninathickwinterjacketcanhaveaclothinglevelashighas2to4clo.Thisinputcanalsoacceptlistsofclothinglevelsandwillproducemultiplecomfortpolygonsaccordingly.

mergeComfPolygons[Optional]

Setto"True"ifyouhaveconnectedmultiplevaluesforanyofthefourcomfortvariablesinthesectionaboveandyouwishtomergeallofthecomputedcomfortpolygonsintoone.

LadybugPrimer



Optionalcomfortparametersfromthe"Ladybug_PMVComfortParameters"component.Usethistoadjustmaximumandminimumacceptablehumidityratios.ThesecomfortParcanalsochangewhethercomfortisdefinedbyeightyorninetypercentofpeoplecomfortable.

passiveStrategy[Optional]

Anoptionaltextinputofpassivestrategiestobelaidoverthepsychrometricchartaspolygons.Itisrecommendedthatyouusethe"Ladybug_PassiveStrategyList"toselectwhichpolygonsyouwouldliketodisplay.Otherwise,acceptabletextinputsinclude"EvaporativeCooling","ThermalMass+NightVent","OccupantUseofFans","InternalHeatGain",and"DessicantDehumidification".

strategyPar[Optional]

Optionalpassivestrategyparametersfromthe"Ladybug_PassiveStrategyParameters"component.Usethistoadjustthemaximumcomfortablewindspeed,thebuildingbalancetemperature,andthetemperaturelimitsforthermalmassandnightflushing.

mollierHX[Optional]

Setto"True"tovisualizethepsychrometricchartasamollier-hxdiagram.Thisisessentiallyapsychrometricchartwheretheaxeshavebeenswitched,whichispopularinEurope.

enthalpyOrWetBulb[Optional]

Setto"True"tohavethepsychrometricchartplotlinesofconstantenthalpyandsetto"False"tohavethechartplotlinestofconstantwetbulbtemperature.Thedefaultissetto"True"forenthalpy.


AnoptionalanalysisperiodfromtheLadybug_AnalysisPeriodcomponent.IfnoAnalysisperiodisgivenandepwdatafromtheImportEPWcomponenthasbeenconnected,theanalysiswillberunfortheenitreyear.


AnoptionallistofhourlydatafromtheImportepwcomponent,whichwillbeusedtocreatehourPointColorsthatcorrespondtothehoursofthedata(e.g.windSpeed).YoucanconnectupseveraldifferentannualHourlydatahere.

LadybugPrimer



Thisinputallowsuserstoremovedatathatdoesnotfitspecificconditionsorcriteriafromthepsychrometricchart.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<80"(withoutquotationmarks).Thecurrentversionofthiscomponentaccepts"and"and"or"operators.Tovisualizethehourlydata,onlylowercaseEnglishlettersshouldbeusedasvariables,andeachletteralphabeticallycorrespondstoeachofthelists(intheirrespectiveorder):"a"alwaysrepresentsdryBulbtemperature,"b"alwaysrepresentstherelativeHumidity,"c"alwaysrepresentsthe1stlistpluggedintoannualHourlyData_,"d"representsthe2ndlist,etc.Forexample,ifyouwanttoplotthedataforthetimeperiodwhentemperatureisbetween18Cand23C,andhumidityislessthan80%,theconditionalstatementshouldbewrittenas“18<a<23andb<80”(withoutquotationmarks).

basePoint[Optional]

AnoptionalbasepointthatwillbeusedtoplacethePsychrometricChartintheRhinoscene.Ifnobasepointisprovided,thebasepointwillbetheRhinomodelorigin.

scale[Optional]

AnoptionalnumbertochangethescaleofthespychrometricchartintheRhinoscene.Bydefault,thisvalueissetto1.

legendPar[Optional]


runIt[Required]

Setto"True"torunthecomponentandgenerateapsychrometricchart!

Outputs

readMe!

...

totalComfortPercent

Thepercentoftheinputdatathatareinsideallcomfortandpassivestrategypolygons.

totalComfortOrNot

Alistof0'sand1'sindicating,foreachhouroftheinputdata,ifthehourisinsidea

LadybugPrimer


comfortorstrategypolygon(1)ornot(0).

strategyNames

Alistofnamesforthecomfortpolygonsandstrategeisthatcorrespondstothenumbersinthefollowingoutputs.

strategyPercentOfTime

Thepercentoftheinputdatathatareineachofthecomfortorpassivestrategypolygons.Eachnumberherecorrespondstothenamesinthe"strategyNames"outputabove.

strategyOrNot

Alistof0'sand1'sindicating,foreachhouroftheinputtemperatureandhumidityratio,ifthehourisinsideagivencomfortorpassivestrategypolygon(1)ornot(0).IftherearemultiplecomfortpolyognsorpassivestrategiesconnectedtothepassiveStrategy_input,thisoutputwillbeagraftedlistforeachpolygon.Eachlistherecorrespondstothenamesinthe"strategyNames"outputabove.

chartCurvesAndTxt

Thechartcurvesandtextlabelsofthepsychrometricchart.

psychChartMesh

Acoloredmeshshowingthenumberofinputhourshappenineachpartofthepsychrometricchart.

legend

Acoloredlegendshowingthenumberofhoursthatcorrespondtoeachcolor.

legendBasePt


comfortPolygons

Abreprepresentingtherangeofcomfortfortheinputradianttemperature,windspeed,metabolicrateandclothinglevel.IFmultiplevalueshavebeenhookedupforanyoftheseinputs,multiplepolygonswillbeoutputhere.

strategyPolygons

LadybugPrimer


Abreprepresentingtheareaofthechartmadecomfortablebythepassivestrategies.IfmultiplestrategieshavebeenhookeduptothepassiveStrategy_input,multiplepolygonswillbeoutputhere.

chartHourPoints

Pointsrepresentingeachofthehoursofinputtemperatureandhumidityratio.Bydefault,thisouputishiddenand,toseeit,youshouldconnectittoaGrasshopperpreviewcomponent.

hourPointColors

ColorsthatcorrespondtothechartHourPointsaboveandcanbehookeduptothe"Swatch"inputofaGrasshopperPreviewcomponentthathasthehourpointsaboveconnectedasgeometry.Bydefault,pointsarecoloredrediftheylieinsidecomfortorstrategypolygonsandarecoloredblueiftheydonotmeetsuchcomfortcriteria.IntheeventthatyouhavehookedupannualHourlyData_thisoutputwillbeagraftedlistofcolors.ThefirstlistcorrespondstothecomfortconditionswhilethesecondlistcolorspointsbasedontheannualHourlyData.

hourPointLegend

Alegendthatcorrespondstothehourpointcolorsabove.IntheeventthatannualHourlyData_isconnected,thisoutputwillbeagraftedlistoflegendsthateachcorrespondtothegraftedlistsofcolors.

CheckHydraExampleFilesforPsychrometricChart

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Psychrometric Chart

GenCumulativeSkyMtx

ThiscomponentusesRadiance'sgendaymtxfunctiontocalculatethesky'sradiationforeachhouroftheyear.Thisisanecessarypre-stepbeforedoingradiationanalysiswithRhinogeometryorgeneratingaradiationrose.Thefirsttimeyouusethiscomponent,youwillneedtobeconnectedtotheinternetsothatthecomponentcandownloadthe"gendaymtx.exe"functiontoyoursystem.GendaymtxiswrittenbyIanAshdownandGregWard.Formoreinformation,checktheRadiancemanualat:http://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf-

Inputs

LadybugPrimer

96GenCumulativeSkyMtx

http://www.radiance-online.org/learning/documentation/manual-pages/pdfs/gendaymtx.pdf

epwFile[Required]

TheoutputoftheLadybugOpenEPWcomponentorthefilepathlocationoftheepwweatherfileonyoursystem.

skyDensity[Default]

Setto0togenerateaTregenzasky,whichwilldivideuptheskydomewithacoarsedensityof145skypatches.Setto1togenerateaReinhartsky,whichwilldivideuptheskydomeusingaveryfinedensityof580skypatches.Notethat,whiletheReinhartskyismoreaccurate,itwillresultinconsiderablylongercalculationtimes.Accordingly,thedefaultissetto0foraTregenzasky.


Anoptionalworkingdirectoryinyoursystemwheretheskywillbegenerated.DefaultissettoC:\LadybugorC:\Users\yourUserName\AppData\Roaming\Ladybug.ThelatterisusedifyoucannotwritetotheC:\driveofyourcomputer.Anyvalidfilepathlocationcanbeconnected.

useOldRes[Optional]

Setthisto"True"ifyouhavealreadyrunthiscomponentpreviouslyandyouwanttousethealready-generateddataforthisweatherfile.

runIt[Required]

Setto"True"torunthecomponentandgenerateaskymatrix.

Outputs

readMe!

...

cumulativeSkyMtx

Theresultofthegendaymtxfunction.UsetheselectSkyMtxcomponenttoselectadesiredskymatrixfromthisoutputforuseinaradiationstudy,raditionrose,orskydomevisualization.

CheckHydraExampleFilesforGenCumulativeSkyMtx

LadybugPrimer

97GenCumulativeSkyMtx

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_GenCumulativeSkyMtx

selectSkyMtx

Usethiscomponenttoselectaspecificskymatrix(skyMxt)foranhouroftheyearorforananalysisperiod.-

Inputs

cumulativeSkyMtx[Required]

TheoutputfromaGenCumulativeSkyMtxcomponent.

HOY[Optional]

LadybugPrimer

98selectSkyMtx

Anhouroftheyearforwhichyouwouldliketoselectasky.Thismustbeavaluebetween1and8760.


AnanalysisperiodfromAnalysisPeriodcomponent.ThiswilloverrideaninputHOY(houroftheyear).

removeDiffuse[Optional]

Setto"True"ifyouwanttoremovethediffusecomponentoftheselectedsky.

removeDirect[Optional]

Setto"True"ifyouwanttoremovethedirectcomponentoftheselectedsky.

Outputs

readMe!

...

selectedSkyMtx

Theselectedskymatrix(SkyMtx)fortheinputhouroftheyearorananalysisperiod.

CheckHydraExampleFilesforselectSkyMtx

LadybugPrimer

99selectSkyMtx

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_selectSkyMtx

ColoredSkyVisualizer

UsethiscomponenttovisualizeaPerezskyasacoloredmeshintheRhinosceneusingtheweatherfilelocation,atimeanddate,andanestimateofturbidity(oramountofparticulatesintheatmosphere.-

Inputs

north[Optional]

InputavectortobeusedasatrueNorthdirectionfortheskydomeoranumberbetween0and360thatrepresentsthedegreesofffromthey-axistomakeNorth.The

LadybugPrimer

100Colored_Sky_Visualizer

defaultNorthdirectionissettotheY-axis(0degrees).

location[Required]


hour[Default]

Anumberbetween1and24(oralistofnumbers)thatrepresenthour(s)ofthedaytopositionsunontheskydome.Thedefaultis12,whichsignifies12:00PM.

day[Default]

Anumberbetween1and31(oralistofnumbers)thatrepresentdays(s)ofthemonthtopositionsunontheskydome.Thedefaultis21,whichsignifiesthe21stofthemonth(whensolsticesandequinoxesoccur).

month[Default]

Anumberbetween1and12(oralistofnumbers)thatrepresentmonths(s)oftheyeartopositionsunontheskydome.Thedefaultis12,whichsignifiesDecember.

turbidity[Optional]

Anumberbetween2and15thatrepresentsthelevelofparticulatematterintheatmosphereofthesky.Arurallocationmighthavealowturbidityof2whileaplacelikeBeijingmighthaveaturbidityashighas10or12.Thedefaultissetto3forarelativelyclearskywithoutmuchpollution.

resolution[Optional]

Anoptionalinputfortheresolutionofthegeneratedmesh.Ahigherresolutionwillproducealess-splotchyimagebutwilltakelongertocalculate.Thedefaultissetto10forarealtivelyquickcalculation.

scale[Optional]

Anoptionalinputtoscalethedomemesh.Thedefaultissetto1.

centerPt[Optional]

Anoptionalpointtomovethecenteroftheskydomemesh.ThedefaultissettotheRhinoorigin.

domeOrRect[Optional]

LadybugPrimer


Setto"True"togenerateaskycolormeshthatisintheshapeofadomeandsetto"False"togenerateaskyasaflatrectangularmesh.Thedefaultissetto"True"togeneratetheskyasadome.

Outputs

readMe!

...

coloredMesh

Acoloredmeshofthesky.

meshLabels

Timeanddatelablesfortheskymesh.

skyColorRGB

TheRGBcolorsthatcorrespondtotheverticesofthemeshabove.

skyColorXYZ

TheXYZcolorsthatcorrespondtotheverticesofthemeshabove.

CheckHydraExampleFilesforColoredSkyVisualizer

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Colored Sky Visualizer

OutdoorSolarTemperatureAdjustor

UsethiscomponenttoadjustanexistingMeanRadiantTemperatureforshortwavesolarradiation.Thisadjustedmeanradianttemperaturecanthenbeusedincomfortstudies.Notethatthiscomponentassumesthatyouhavealreadyaccountedforlongwaveradiationintheformofthe_meanRadTemperatureinput.Ifyoudonothookupa_meanRadTemperature,thiscomponentwillassumethatthesurroundingradianttemperatureisthesameastheairtemperature,whichisadecentassumptionforsomeonestandinginanunobstructedfield.However,themoreobstaclesthatsurroundtheperson(andthemore"context"thatyouadd),themoreimportantitistoderiveastartingmeanradianttemperaturefromaHoneybeeEnergysimulation.Alsonotethatthiscomponentisnotmeanttoaccountforshortwaveradiationpassingthroughglass.ThiscomponentusesRadiancefunctionsinorderto

LadybugPrimer

103Outdoor_Solar_Temperature_Adjustor

determinetheamountofdirectanddiffusesolarradiationfallingonacomfortmannequin.Theportionreflectedoffofthegroundtothecomfortmannequinisderivedfromthesevaluesofdirectanddiffuseradiation.Lastly,theformulastotranslatethisradiationintoaneffectiveradiantfieldandintoasolar-adjustedmeanradianttemperaturecomefromthispaper:Arens,Edward;Huang,Li;Hoyt,Tyler;Zhou,Xin;Shiavon,Stefano.(2014).Modelingthecomforteffectsofshort-wavesolarradiationindoors.IndoorEnvironmentalQuality(IEQ).http://escholarship.org/uc/item/89m1h2dg#page-4-

Inputs

location[Required]

Thelocationoutputfromthe'Ladybug_Importepw'component.

cumSkyMtxOrDirNormRad[Required]

EithertheoutputfromaGenCumulativeSkyMtxcomponent(forhigh-resolutionanalysis)orthedirectNormallRadiationouputfromthe'Ladybug_Importepw'component(forsimple,low-resolutionanalsysis).

meanRadTemperature[Required]

AnumberorlistofnumbersrepresentingthemeanradianttemperatureofthesurroundingsurfacesindegreesCelcius.Thisnumberwillbemodifiedtoaccountforsolarradiation.Thisinputcanbeairtemperaturedatafromthe'Importepw'componentandwillfollowtheassumptionthatthesurroundingmeanradianttemperatureisthesameastheairtemperature.Thisassumptionisokforapersoninanoutdooropenfield.However,themoreobstaclesthatsurroundtheperson(andthemore'contextShading'thatyouadd),themoreimportantitistoderiveastartingmeanradianttemperaturefromaHoneybeeEnergysimulation.

bodyPosture[Optional]

Anintergerbetween0and5tosetthepostureofthecomfortmannequin,whichcanhavealargeeffectontheradiationforagivensunposition.0=Standing,1=Sitting,2=LyingDown,3=Low-ResStanding,4=Low-ResSitting,and5=Low-ResLyingDown.Thedefaultissetto1forsitting.

rotationAngle[Optional]

Anoptionalrotationangleindegrees.Usethisnumbertoadjusttheangleofthecomfortmannequininspace.Theangleofthemannequininrelationtothesuncanhavealargeeffectontheamountofradiationthatfallsonitandthuslargelyaffecttheresultingmeanradianttemperature.

LadybugPrimer


http://escholarship.org/uc/item/89m1h2dg#page-4

bodyLocation[Optional]

Anoptionalpointthatsetsthepositionofthecomfortmannequininspace.UsethistomovethecomfortmannequinaroundinrelationtocontextShading_connectedbelow.Notethatthispointshouldbethecenterofgravityofyourperson.ThedefaultissettoapersonjustabovetheRhinoorigin.

contextShading[Optional]

Optionalbrepsormeshesthatrepresentshadingoropaquesolarobstructionsaroundthemannequin.Ifyouareusingthiscomponentforindoorstudies,windowsoranytransparentmaterialsshouldnotbeincludedinthisgeometry.YoushouldfactorthetransmissivityofthesematerialsinwiththewindowTransmissivity_input.Also,notethat,ifyouhavealotofthiscontextgeometry,youshouldmakesurethatyouinputastarting_meanRadTemperaturethataccountsforthetemperatureofallthetempertureoftheseshadingsurfaces.

north[Optional]

InputavectortobeusedasatrueNorthdirectionforthesunpathoranumberbetween0and360thatrepresentsthedegreesofffromthey-axistomakeNorth.ThedefaultNorthdirectionissettotheY-axis(0degrees).

groundReflectivity[Optional]

Anoptionaldecimalvaluebetween0and1thatrepresentsthefractionofsolarradiationreflectedoffoftheground.Bydefault,thisissetto0.25,whichischaracteristicofoutdoorgrassordrybaresoil.Youmaywanttoincreasethisvalueforconcreteordecreaseitforwaterordarksoil.

clothingAbsorptivity[Optional]

Anoptionaldecimalvaluebetween0and1thatrepresentsthefractionofsolarradiationabsorbedbythehumanbody.Thedefaultissetto0.7for(average/brown)skinandaverageclothing.Youmaywanttoincreasethisvaluefordarkerskinordarkerclothing.

windowTransmissivity[Optional]

Anoptionaldecimalvaluebetween0and1thatrepresentsthetransmissivityofwindowsaroundtheperson.Thiscanalsobealistof8760valuesbetween0and1thatrepresentsalistofhourlywindowtransmissivties,inordertorepresenttheeffectofoccupantspullingblindsoverthewindows,etc.Notethatyoushouldonlysetavaluehereifyouareusingthiscomponentforindooranalysiswheretheonlymeansbywhichsunlightwillhitanoccupantisifitcomesthroughawindow.Thedefaultissetto1for

LadybugPrimer


outdoorconditions.

analysisPeriodOrHOY[Optional]

Anoptionalanalysisperiodfromthe'AnalysisPeriodcomponent'oranhouroftheyearbetween1and8760forwhichyouwanttoconducttheanalysis.Ifnovalueisconnectedhere,thecomponentwillrunfornoononthewintersolstice.

legendPar[Optional]


tempOrRad[Optional]

Setto'True'tohavethemannequinlabledwithadjustedperceivedradianttemperatureandsetto'False'tohavethemannequinlabledwithtotalradiationfallingontheperson.

parallel[Optional]

Setto'True'torunthecomponentusingmultipleCPUs.Thiscandramaticallydecreasecalculationtimebutcaninterferewithotherintensecomputationalprocessesthatmightberunningonyourmachine.Forthisreason,thedefaultissetto'True.'

runIt[Required]

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtothechartwiththegrasshopper'move'component.

Outputs

readMe!

...

effectiveRadiantField

Theestimatedeffectiveradiantfieldofthecomfortmannequininducedbythesunforeachhouroftheanalysisperiod.ThisisinW/m2.

MRTDelta

Theestimatedchangeinmeanradianttemperatureforthecomfortmannequininducedbythesolarradiation.ThisisindegreedCelcius.

solarAdjustedMRT

LadybugPrimer


Theestimatedsolaradjustedmeanradianttemperatureforeachhouroftheanalysisperiod.Thisisessentiallythechangeinmeanradianttemperatureaboveaddedtothehourly_meanRadTemperatureinput.ThisisindegreedCelciusandcanbepluggedintoanycomfortcomponentsforcomfortstudies.

mannequinMesh

Acoloredmeshofacomfortmannequinshowingtheamountofradiationfallingoverthemannequin'sbody.

legend

AlegendthatcorrespondstothecolorsonthemannequinMeshandshowstherelativeW/m2.

legendBasePt

Theinputdatanormalizedbythefloorareaofitcorrespondingzone.

meshFaceResult

If'tempOrRad'issettoTrue,thiswillbetheestimatedsolaradjustedradianttemperatureforeachmeshfaceofthemannequinindegreesCelcius.Thisradianttemperatureisaveragedoverthetheentireanalysisperiod.if'tempOrRad'issettoFalse,thiswillbethetotalradiationoneachmeshfaceovertheanalysisperiod.

meshFaceArea

TheareasofeachmeshfaceofthemannequininsquareRhinomodelunits.ThislistcorrespondstothemeshFaceRadTemplistaboveandcanbeusedtohelpinformstatisticalanalysisoftheradiantassymmetryoverthemannequin.

CheckHydraExampleFilesforOutdoorSolarTemperatureAdjustor

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Outdoor Solar Temperature Adjustor

RadiationCallaLily

UsethiscomponenttodrawRadiationCallaLilyorDome,whichshowsyouhowradiationwouldfallonanobjectfromalldirectionsforagivensky.Itisusefulforfindingthebestdirectionwithwhichtoorientsolarpanelsandgivesasenseoftheconsequencesofdeviatingfromsuchanorientation.TheCallaLily/Domecanbeunderstoodinthreedifferentways:_1)TheCallaLily/Domea3Drepresentationofallpossibleradiationrosesforagivenskysinceitincludesallverticalanglesfrom0to90.2)TheCallaLily/DomeisthereciprocaloftheTergenzaSkyDomesincetheCalaDomeessentiallyshowsyouhowtheradiationfromtheskywillfallontoahemisphericalobject.3)TheCallaLily/Domeisasmartradiationanalysisofahemisphere.Yourresultswouldeffectivelybethesameifyoumadea

LadybugPrimer

108Radiation_Calla_Lily

hemisphereinRhinoandranitthroughthe"RadiationAnalysis"componentbut,withthiscomponent,youwillgetasmoothercolorgradientandthecomponentwillautomaticallyoutputthepoint(orvector)withthemostradiation.-

Inputs

selectedSkyMtx[Required]

TheoutputfromtheselectSkyMtxcomponent.

horAngleStep[Default]

Anangleindegreesbetween0and360thatrepresentsthestepforhorizontalrotation.Smallernumberswillyeildafinerandsmoothermeshwithsmoothercolors.Thenumberinputhereshouldbesmallerthan360anddivisibleby360.Thedefaultissetto10degrees.

verAngleStep[Default]

Angleindegreesstepbetween0and90thatrepresentsthestepforverticalrotation.Smallernumberswillyeildafinerandsmoothermeshwithsmoothercolors.Thenumberinputhereshouldbesmallerthan90anddivisibleby90.Thedefaultissetto10degrees.

centerPoint[Default]

InputapointtolocatethecenterpointoftheCallaLilyGraph

horScale[Default]

Inputanumberheretochangehorizontal(XY)scaleofthegraph.Thedefaultvalueissetto1.Notethat,forthedomerepresentation,thisinputwillchangethescaleoftheentiredome(bothhorizontalandvertical).

verScale[Default]

Inputanumberheretochangevertical(Z)scaleofthegraph.Thedefaultvalueissetto1.Notethat,forthedomerepresentation,thisinputwillhavenoeffect.

domeOrLily[Optional]

Setto"True"tohavethecomponentcreatearadiationdomeandsetto"False"tohaveitgenerateaLily.Thedefaultissetto"False"foraLily.ThedifferencebetweentheDomeandtheLilyisthat,fortheLily,theZscaleisessentiallythesameasthecolorscale,whichisredundantbutalsobeautifulandpotentiallyusefulifyouhavetopresent

LadybugPrimer


datawithaBlack/Whiteprinterortosomeonewhoiscolorblind.FortheDome,theverticalanglesofrotationservetodefinetheZscale.Inthissense,thenormaltothedomeatanygivenpointistheangleatwhichtheradiationstudyisbeingrun.Thisgivesageometricintuitivesenseofhowyoushouldorientpanelstocaptureoravoidthemostsun.

legendPar[Optional]


runIt[Required]

Setto"True"torunthecomponentandgeneratearadiationCallaLily.

bakeIt[Optional]

Setto"True"tobaketheCallaLilyintotheRhinoscene.

Outputs

readMe!

...

radiationLilyMesh

AcoloredmeshrepresentingradiationoftheCallaLilyorDome.

baseCrvs

AsetofguidecurvesfortheCallaLily.

legend

AlegendoftheradiationontheCallaLily.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendintheRhinoscene.

testPts

TheverticesoftheCallaLilymesh.Thesearehiddenbydefault.

testPtsInfo

InformationforeachtestpointoftheCallaLilymesh."HRA"standsfor"HorizontalRotationAngle"while"VRA"standfor"VerticalRotationAngle."HRAvariesfrom0to360whileVRAvariesfrom0to90.

LadybugPrimer


values

Theradiationvaluesforeachtestpoints(ormeshfaces)oftheCallaLilyinkWh/m2.

maxRadPt

ThepointontheCalaLillywiththegreatestamountofsolarradiation.Thisisusefulforunderstandingthebestdirectiontoorientsolarpanels.

maxRadVector

Thevectorthatshouldbeusedtoorientsolarpanelssuchthattheyrecievethegreatestpossiblesolarradiation.

maxRadInfo

InformationaboutthetestpointwiththegreatesamountofradiationintheCallaLily."HRA"standsfor"HorizontalRotationAngle"while"VRA"standfor"VerticalRotationAngle."HRAvariesfrom0to360whileVRAvariesfrom0to90.

CheckHydraExampleFilesforRadiationCallaLily

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Radiation Calla Lily

RadiationRose

UsethiscomponenttomakearadiationroseintheRhinoscene.Radiationrosesgiveasenseofhowmuchradiationcomesfromthedifferentcardinaldirections,whichwillgiveaninitialideaofwhereglazingshouldbeminimized,shadingapplied,orsolarcollectorsplaced.-

Inputs

north[Optional]


LadybugPrimer

112Radiation_Rose




context[Optional]

Optionalbrepsormeshesrepresentingcontextsurroundingthepointatthecenteroftheradiationrose.Thiscontextgeometrywillblocktheradiationthatshowsupintherose.

numOfArrows[Default]

Anintergerthatsetsthenumberofarrows(orcardingaldirections)intheradiationrose.Thedefaultissetto36.

surfaceTiltAngle[Default]

Anumberbetween0and90thatsetsthetiltangleindegreesoftheanalysisplane(0=roof,90=verticalwall).Thedefultissetto90foraradiationstudyofawall(ie.radiationonacurtainwall).


Apointthatsetsthelocationoftheradiationrose.ThedefaultissettotheRhinoorigin(0,0,0).

scale[Default]

Usethisinputtochangethescaleoftheradiationrose.Thedefaultissetto1foranyselSkyMtxthatislongerthanadayand1000foranyselSkyMtxthatislessthanaday.

arrowHeadScale[Default]

Usethisinputtochangethescaleofthearrowheadsoftheradiationrose.Thedefaultissetto1.

legendPar[Optional]


showTotalOnly[Optional]

Setto"True"toonlyshowaradiationrosewiththetotalradiation.Thedefaultis"False",whichwillproduce3radiationroses:oneofdiffuseradiation,oneofdirectradiation,and

LadybugPrimer

113Radiation_Rose

oneofthetotalradiation.

runIt[Required]

Setto"True"torunthecomponentandgeneratearadiationrose.

bakeIt[Optional]

Setto"True"tobaketheradiationroseintotheRhinoscene.

Outputs

readMe!

...

radiationArrowsMesh

Acoloredmeshrepresentingtheintensityofradiationfromdifferentcardinaldirections.

radRoseBaseCrvs

Asetofguidecurvesthatmarkthedirectionsofradiationanalysis.

legend

Alegendoftheradiationrose.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePts

Thelegendbasepoint(s),whichcanbeusedtomovethelegend(s)inrelationtotherosewiththegrasshopper"move"component.

radRoseEndPts

Theendpointsoftherosearrows.

radRoseValues

TheradiationvaluesinkWh/m2foreachrosearrow.

CheckHydraExampleFilesforRadiationRose

LadybugPrimer

114Radiation_Rose

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Radiation Rose

SkyDome

ThiscomponentallowsyoutovisualizeaselectedskymatrixfromtheselectSkyMxtcomponentinordertoseethepatchesoftheskydomewhereradiationiscomingfrom.Thecomponentwillproduce3skydomesbydefault:adomeshowingjustthediffuseradiation,adomeshowingjustthedirectradiation,andadomeshowingthetotalradiation.-

Inputs

north[Optional]


LadybugPrimer

115Sky_Dome





Apointthatsetsthelocationoftheskydomes.ThedefaultissettotheRhinoorigin(0,0,0).

scale[Default]

Usethisinputtochangethescaleoftheskydome.Thedefaultissetto1.

legendPar[Optional]


showTotalOnly[Optional]

Setto"True"toonlyshowaskydomewiththetotalradiation.Thedefaultis"False",whichwillproduce3skydomes:oneofdiffuseradiation,oneofdirectradiation,andoneofthetotalradiation.

runIt[Required]

Setto"True"torunthecomponentandgenerateaskydome.

bakeIt[Optional]

Setto"True"tobaketheskydomeintotheRhinoscene.

Outputs

readMe!

...

skyPatchesMesh

Acoloredmeshrepresentingtheintensityofradiationforeachoftheskypatchesoftheskydome.

baseCrvs

LadybugPrimer

116Sky_Dome

Asetofguidecurvesthatmarkinformationontheskydome.

legend

Alegendfortheskydome.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePts

Thelegendbasepoint(s),whichcanbeusedtomovethelegend(s)inrelationtotheskydomeswiththegrasshopper"move"component.

skyPatchesCenPts

Thecenterpointsofskypatches,whichcanbeusedtoshapeRhinogeometryinrelationtoradiationfromdifferentskypatches.

skyPatchesAreas

TheareaofskypatchesinRhinomodelunits.

skyPatchesAsBrep

Thegeometryofskypatchesasbreps.

values

RadiationvaluesfortheskypatchesinkWh/m2.

CheckHydraExampleFilesforSkyDome

LadybugPrimer

117Sky_Dome

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Sky Dome

SunPath

Usethiscomponenttomakea3Dsun-path(aka.sunplot)intheRhinoscene.ThecomponentalsooutputssunvectorsthatcanbeusedforsunlighthoursanalysisorshadingdesignwiththeotherLadybugcomponents.Thesun-pathfunctionusedhereisaPythonversionoftheRADIANCEsun-pathscriptbyGregWard.TheRADIANCEsourcecodecanbeaccessedat:http://www.radiance-online.org/download-install/CVS%20source%20code-

Inputs

north[Optional]

LadybugPrimer

118SunPath

http://www.radiance-online.org/download-install/CVS%20source%20code


location[Required]


hour[Default]

Anumberbetween1and24(oralistofnumbers)thatrepresenthour(s)ofthedaytopositionsunsphere(s)onthesunpath.Thedefaultis12,whichsignifies12:00PM.

day[Default]

Anumberbetween1and31(oralistofnumbers)thatrepresentdays(s)ofthemonthtopositionsunsphere(s)onthesunpath.Thedefaultis21,whichsignifiesthe21stofthemonth(whensolsticesandequinoxesoccur).

month[Default]

Anumberbetween1and12(oralistofnumbers)thatrepresentmonths(s)oftheyeartopositionsunsphere(s)onthesunpath.Thedefaultis12,whichsignifiesDecember.

timeStep[Default]

Thenumberoftimestepsperhourinthesunpath.Thisnumbershouldbesmallerthan60anddivisibleby60.Thedefaultissetto1suchthatonesunsphereandonesunvectorisgeneratedforeachhour.NotethatalinearinterpolationwillbeusedtogeneratecurvesandsunsfortimeStepsgreaterthan1.


AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.Inputsherewilloverridethehour,day,andmonthinputsabove.

centerPt[Default]

InputapointheretochangethelocationofthesunpathintheRhinoscene.ThedefaultissettotheRhinomodelorigin(0,0,0).

sunPathScale[Default]

Inputanumberheretochangethescaleofthesunpath.Thedefaultissetto1.

LadybugPrimer

119SunPath

sunScale[Default]

Inputanumberheretochangethescaleofthesunsphereslocatedalongthesunpath.Thedefaultissetto1.


AnoptionallistofhourlydatafromtheImportepwcomponent,whichwillbeusedtocolorthesunspheresofthesunpath(e.g.dryBulbTemperature).


Thisinputallowsuserstoremovedatathatdoesnotfitspecificconditionsorcriteriafromthesunpath.Tousethisinputcorrectly,hourlydata,suchastemperatureorhumidity,mustbepluggedintotheannualHourlyDatainput.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<80"(withoutquotationmarks).Thecurrentversionofthiscomponentaccepts"and"and"or"operators.Tovisualizethehourlydata,onlylowercaseEnglishlettersshouldbeusedasvariables,andeachletteralphabeticallycorrespondstoeachofthelists(intheirrespectiveorder):"a"alwaysrepresentsthe1stlist,"b"alwaysrepresentsthe2ndlist,etc.Forexample,ifyouhavehourlydrybulbtemperatureconnectedasthefirstlist,andrelativehumidityconnectedasthesecondlist(bothtotheannualHourlyDatainput),andyouwanttoplotthedataforthetimeperiodwhentemperatureisbetween18Cand23C,andhumidityislessthan80%,theconditionalstatementshouldbewrittenas18<a<23andb<80(withoutquotationmarks).

legendPar[Optional]


dailyOrAnnualSunPath[Default]

Bydefault,thisvalueissetto"True"(or1),whichwillproduceasunpathforthewholeyear.Setthisinputto"False"(or0)togenerateasunpathforjustonedayoftheyear(orseveraldaysifmultipledaysareincludedintheanalysisperiod).

solarOrStandardTime[Optional]

Setto'True'tohavethesunPathdisplayinsolartimeandsetto'False'tohaveitdisplayinstandardtime.Thedefaultissetto'False.'Notethatthisinputonlychangesthewayinwhichthesupathcurvesaredrawncurrentlyanddoesnotyetchangethepositionofthesunbasedontheinputhour.

bakeIt[Optional]

LadybugPrimer

120SunPath

SettoTruetobakethesunpathintotheRhinoscene.

Outputs

readMe!

...

sunVectors

Vector(s)indicatingthedirectionofsunlightforeachsunpositiononthesunpath.

sunAltitudes

Number(s)indicatingthesunaltitude(s)indegreesforeachsunpositiononthesunpath.

sunAzimuths

Number(s)indicatingthesunazimuthsindegreesforeachsunpositiononthesunpath.

sunSpheresMesh

Acoloredmeshofspheresrepresentingsunpositions.ColorsindicateannualHourlyDataandwillbeyellowifnodataishookeduptoannualHourlyData.

sunPathCrvs

Asetofguidecurvesthatmarkthepathofthesunacrosstheskydome.

legend

Alegendforthesunpath.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePts

Thelegendbasepoint(s),whichcanbeusedtomovethelegend(s)inrelationtothesunpathwiththegrasshopper"move"component.

title

Thetitletextofthesunpath.HookthisuptoanativeGrasshopper'Geo'componenttopreviewitseparatelyfromtheotheroutputs.

titleBasePt

LadybugPrimer

121SunPath

Pointfortheplacementofthetitle,whichcanbeusedtomovethetitleinrelationtothesunpathwiththenativeGrasshopper"Move"component.

sunPathCenPts

Thecenterpointofthesunpath(orsunpathsifmultipleannualHourlyData_streamsareconnected).UsethistomovesunpathsaroundintheRhinoscenewiththegrasshopper"move"component.

sunPositions

Point(s)idicatingthelocationonthesunpathofeachsunposition.

sunPositionsInfo

Detailiedinformationforeachsunpositiononthesunpathincludingdateandtime.

sunPositionsHOY

Thehouroftheyearforeachsunpositiononthesunpath.

selHourlyData

TheannualHourlyDataforeachsunpositiononthesunpath.Notethatthisdatahasthefollowingremovedfromit:1)AnypartsoftheannualHourlyDatathathappenwhenthesunisdown,2)annualHourlyDatathatisnotapartoftheanalysisPeriodand,3)annualHourlyData_thatdoesnotfittheconditionalstatement.

CheckHydraExampleFilesforSunPath

LadybugPrimer

122SunPath

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_SunPath

WindBoundaryProfile

Usethiscomponenttovisualizeawindprofilecurveforagiventerraintype.Windspeedincreasesasoneleavesthegroundandwindprofilesareameansofvisualizingthischangeinwindspeedwithheight.-Moreinformationonthepowerlawofthewindprofilecanbefoundhere:http://en.wikipedia.org/wiki/Wind_profile_power_law-

Inputs

north[Optional]


LadybugPrimer

123Wind_Boundary_Profile

http://en.wikipedia.org/wiki/Wind_profile_power_law


windSpeed_tenMeters[Required]

ThewindspeedfromtheimportEPWcomponentoranumberrepresentingthewindspeedat10metersofftheground.Ifthisvalueisinputwithoutacorrespondingwinddirectionbelow,theprofilewillbedrawnwiththeaverageofthespeedinputhere.IfcorrespondingvaluesareconnectedtothewindDirection,thespeedontheprofilewillbetheaveragespeedoftheprevailingwinddirection.

windDirection[Optional]

Anoptionalnumberrepresentingthedegreesfromnorthofthewinddirection.ThiscanalsobethewindDirectionoutputfromtheimportEPWcomponent.Thisdirectionwillbeusedtoorientthewindprofilein3dimensionstothedirectionoftheprevailingwind.

terrainType[Optional]

Anintergerfrom0to3thatsetstheterrainclassassociatedwiththeoutputwindSpeedAtHeight.Intergervaluesrepresentthefollowingterrainclasses:0=Urban:largecitycentres,50%ofbuildingsabove21moveradistanceofatleast2000mupwind.1=Suburban:suburbs,woodedareas.2=Country:open,withscatteredobjectsgenerallylessthan10mhigh.3=Water:Flat,unobstructedareasexposedtowindflowingoveralargewaterbody(nomorethan500minland).

epwTerrain[Optional]

Anoptionalintergerfrom0to3thatsetstheterrainclassassociatedwiththeoutputwindSpeedAtHeight.Thedefaultissetto2forflatclearland,whichistypicalformostEPWfilesthatarerecordedatairports.Intergervaluesrepresentthefollowingterrainclasses:0=Urban:largecitycentres,50%ofbuildingsabove21moveradistanceofatleast2000mupwind.1=Suburban:suburbs,woodedareas.2=Country:open,withscatteredobjectsgenerallylessthan10mhigh.3=Water:Flat,unobstructedareasexposedtowindflowingoveralargewaterbody(nomorethan500minland).

HOY[Optional]

Usethisinputtoselectoutspecificindicesofalistofvaluesconnectedforwindspeedandwinddirection.IfyouhaveconnectedhourlyEPWdata,thisistheequivalentofa"HOY"inputandyoucanusethe"LadybugDOY_HOY"componenttoselectoutaspecifichouranddate.NotethatthisoverridestheanalysisPeriodinputbelow.


LadybugPrimer


IfyouhaveconnecteddatafromanEPWcomponent,pluginananalysisperiodfromtheLadybug_AnalysisPeriodcomponenttocalculatedataforjustaportionoftheyear.ThedefaultisJan1st00:00-Dec31st24:00,theentireyear.


AnoptionallistofhourlydatafromtheImportepwcomponent,whichwillbeoverlaidonwindrose(e.g.dryBulbTemperature)


Thisinputallowsuserstoremovedatathatdoesnotfitspecificconditionsorcriteriafromthewindrose.Tousethisinputcorrectly,hourlydata,suchastemperatureorhumidity,mustbepluggedintotheannualHourlyDatainput.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<80"(withoutquotationmarks).Thecurrentversionofthiscomponentaccepts"and"and"or"operators.Tovisualizethehourlydata,onlylowercaseEnglishlettersshouldbeusedasvariables,andeachletteralphabeticallycorrespondstoeachofthelists(intheirrespectiveorder):"a"alwaysrepresentsthe1stlist,"b"alwaysrepresentsthe2ndlist,etc.FortheWindBoundaryProfilecomponent,thevariable"a"alwaysrepresentswindSpeed.Forexample,ifyouhavehourlydrybulbtemperatureconnectedasthesecondlist,andrelativehumidityconnectedasthethirdlist(bothtotheannualHourlyDatainput),andyouwanttoplotthedataforthetimeperiodwhentemperatureisbetween18Cand23C,andhumidityislessthan80%,theconditionalstatementshouldbewrittenas“18<b<23andc<80”(withoutquotationmarks).

originPt[Optional]

Anoptionalpointthatcanbeusedtochangethebasepointatshichthewindprofilecurvesaregenerated.Bydefault,thewondprofilecurvesgenerateattheRhinomodelorigin.

windVectorScale[Optional]

Anoptionalnumberthatcanbeusedtochangethescaleofthewindvectorsinrelationtotheheightofthewindprofilecurve.Thedefaultissetto5sothatitiseasiertoseehowthewindspeedischangingwithheight.

windProfileHeight[Optional]

Anoptionalnumberinrcmodelunitsthatcanbeusedtochangetheheightofthewindprofilecurve.Bydefault,theheightofthecurveissetto30meters(ortheequivalentdistanceinyourRhinomodelunits).Youmaywanttomovethisnumberhigherorlowerdependingonthewindeffectsthatyouareinterestedin.

LadybugPrimer


distBetweenVec[Optional]

Anoptionalnumberinrhinomodelunitsthatrepresentsthedistancebetweenwindvectorsintheprofilecurve.Thedefaultissetto2meters(ortheequivalentdistanceinyourrcmodelunits).

windArrowStyle[Optional]

Anoptionalintegertosetthestyleofthewindvectors.Thedefaultissetto1forcoloredarrows.Choosefromthefollowingoptions:0=NoWindArrows-usethisoptionifyoudonotwanttogerenatearrows.1=3DColoredWindArrows-usethisoptiontogeneratearrowsasacolored3Dmesh(arrowswillbecoloredbasedonthemagnitudeoftheirwindspeed).2=High-Res3DColoredWindArrows-usethisoptiontocreatecolorarrowsjustlikeOption1butwithacircularcrosssectionandsmoothedges.3=ColoredLineWindArrows-usethisoptiontogeneratearrowsaslineswithcoloredtips.4=BlackLineWindArrows-usethisoptiontogeneratearrowsaslineswithblacktips.

legendPar[Optional]


bakeIt[Optional]

Setto"True"tobakethewindboundaryprofileintotheRhinoscene.

Outputs

readMe!

...

windSpeeds

Thewindspeedsthatcorrespondtothewindvectorsinthewindprofilevisualization.

windVectors

Thewindvectorsthatcorrespondtothoseinthewindprofilevisualization.NotethatthemagnitudeofthesevectorswillbescaledbasedonthewindVectorScale_input.

vectorAnchorPts

Anchorpointsforeachofthevectorsabove,whichcorrespondtotheheightabovethegroundforeachofthevectors.ConnectthisalongwiththeoutputabovetoaGrasshopper"VectorDisplay"componenttoseethevectorsasagrasshoppervector

LadybugPrimer


display(asopposedtothevectormeshbelow).

windVectorMesh

Ameshdisplayingthewindvectorsthatwereusedtomaketheprofilecurve.

windProfileCurve

Acurveoutliningthewindspeedasitchangeswithheight.Thismayalsobealistofwindprofilecurvesifmultiple"HOY"inputsareconnectedor"averageData"issettoFalse."

profileAxes

ScriptvariableWindBoundaryProfile

axesText

Themeshesoftheaxestext(labellingwindspeedsandheights).

legend

Alegendofthewindprofilecurves.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyinthercscene.

legendBasePt

Thelegendbasepoint(s),whichcanbeusedtomovethelegendinrelationtothewindprofilewiththegrasshopper"move"component.

CheckHydraExampleFilesforWindBoundaryProfile

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Wind Boundary Profile

WindRose

UsethiscomponenttomakeawindRoseintheRhinoscene.-

Inputs

north[Default]

InputavectortobeusedasatrueNorthdirectionforthewindroseoranumberbetween0and360thatrepresentsthedegreesofffromthey-axistomakeNorth.ThedefaultNorthdirectionissettotheY-axis(0degrees).

LadybugPrimer

128Wind_Rose

hourlyWindDirection[Required]

ThelistofhourlywinddirectiondatafromtheImportepwcomponent.

hourlyWindSpeed[Required]

ThelistofhourlywindspeeddatafromtheImportepwcomponent.


AnoptionallistofhourlydatafromtheImportepwcomponent,whichwillbeoverlaidonwindrose(e.g.dryBulbTemperature)


AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.


Thisinputallowsuserstoremovedatathatdoesnotfitspecificconditionsorcriteriafromthewindrose.Tousethisinputcorrectly,hourlydata,suchastemperatureorhumidity,mustbepluggedintotheannualHourlyDatainput.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<80"(withoutquotationmarks).Thecurrentversionofthiscomponentaccepts"and"and"or"operators.Tovisualizethehourlydata,onlylowercaseEnglishlettersshouldbeusedasvariables,andeachletteralphabeticallycorrespondstoeachofthelists(intheirrespectiveorder):"a"alwaysrepresentsthe1stlist,"b"alwaysrepresentsthe2ndlist,etc.FortheWindBoundaryProfilecomponent,thevariable"a"alwaysrepresentswindSpeed.Forexample,ifyouhavehourlydrybulbtemperatureconnectedasthesecondlist,andrelativehumidityconnectedasthethirdlist(bothtotheannualHourlyDatainput),andyouwanttoplotthedataforthetimeperiodwhentemperatureisbetween18Cand23C,andhumidityislessthan80%,theconditionalstatementshouldbewrittenas“18<b<23andc<80”(withoutquotationmarks).

numOfDirections[Default]

Anumberofcardinaldirectionswithwhichtodivideupthedatainwindrose.Valuesmustbegreaterthan4sinceyoucanhavenofewerthan4cardinaldirections.


InputapointheretochangethelocationofthewindroseintheRhinoscene.ThedefaultissettotheRhinomodelorigin(0,0,0).

maxFrequency[Optional]

LadybugPrimer

129Wind_Rose

Anoptionalnumberbetween1and100thatrepresentsthemaximumpercentageofhoursthattheouter-mostringofthewindroserepresents.Bydefault,thisvalueissetbythewinddirectionwiththelargestnumberofhours(thehighestfrequency)butyoumaywanttochangethisifyouhaveseveralwindrosesthatyouwanttocomparetoeachother.Forexample,ifyouhavewindrosesfordifferentmonthsorseasons,whicheachhavedifferentmaximumfrequencies.

scale[Default]

Inputanumberheretochangethescaleofthewindrose.Thedefaultissetto1.

legendPar[Optional]


runIt[Required]

Setthisvalueto"True"torunthecomponentandgenerateawindroseintheRhinoscene.

bakeIt[Optional]

Setthisvalueto"True"tobakethewindroseintotheRhinoscene.

Outputs

readMe!

...

calmRoseMesh

Ameshinthecenterofthewindroserepresentingtherelativenumberofhourswherethewindspeedisaround0m/s.

windRoseMesh

Ameshrepresentingthewindspeedfromdifferentdirectionsforallhoursanalyzed.

windRoseCrvs

AsetofguidecurvesthatmarkthenumberofhourscorrespondingtothewindRoseMesh.

windRoseCenPts

LadybugPrimer

130Wind_Rose

Thecenterpoint(s)ofwindrose(s).Usethistomovethewindrosesinrelationtooneanotherusingthegrasshopper"move"component.

legend

Alegendofthewindrose.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePts

Thelegendbasepoint(s),whichcanbeusedtomovethelegendinrelationtotherosewiththegrasshopper"move"component.

title

Thetitleforthewindrose.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

CheckHydraExampleFilesforWindRose

LadybugPrimer

131Wind_Rose

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Wind Rose

ImportGroundTemp

Usethiscomponenttovisualisegroundtemperaturesthroughouttheyearatspecificdepths.Pleasenotethatepwfilesusuallyonlyprovidegroundtemperaturedataatdepths0.5meters,2metersand4metersthusdatahasbeeninterpolatedforallotherdepths.Inparticularthisinterpolationassumesthatgroundtemperaturesdonotvaryovertheseasonsoncethedepthhasreach9metersbelowthegroundsurface.-

Inputs

epwFile[Required]

LadybugPrimer

132Import_Ground_Temp

An.epwfilepathonyoursystemasastring

visualisedata_Season[]

Settotruetovisualisethegroundtemperaturedataasanaverageforeveryseason

visualisedata_Month[]

Settotruetovisualisethegroundtemperaturedataforeverymonth

Outputs

readMe!

...

groundtemp1st

Ineveryepwfiletherearemonthlygroundtemperaturesat3differentdepthsthisisthe1st

groundtemp2nd

Ineveryepwfiletherearemonthlygroundtemperaturesat3differentdepthsthisisthe2nd

groundtemp3rd

Ineveryepwfiletherearemonthlygroundtemperaturesat3differentdepthsthisisthe3rd

profileCrvs

ThisoutputdrawsthecurvesofthetemperaturecurvesconnectittoGoftheGrasshoppercomponentCustomPreview

crvColors

ThisoutputdrawsthecoloursofthetemperaturecurvesconnectittoSoftheGrasshoppercomponentCustomPreview

graphAxes

Thisoutputdrawstheaxesofthegraphitdoesn'tneedtobeconnectedtoanything

graphtext

LadybugPrimer


Thisoutputdrawsthetextofthegraphitdoesn'tneedtobeconnectedtoanything

Legend

ScriptvariableImportgroundtemp

CheckHydraExampleFilesforImportGroundTemp

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Import Ground Temp

Componentlist:

Radiation_Analysis

Sunlight_Hours_Analysis

Bounce_from_Surface

View_Analysis

View_From_Sun

view_Rose

Comfort_Shade_Benefit_Evaluator

ShadingDesigner

SolarEnvelope

SolarFan

DC_to_AC_derate_factor

Photovoltaics_Performance_Metrics

Photovoltaics_Surface

Sunpath_Shading

Tilt_And_Orientation_Factor

Forward_Raytracing

SolarEnvelopeBasic

SolarFanBasic

LadybugPrimer

1353|EnvironmentalAnalysis

RadiationAnalysis

Thiscomponentallowsyoutocalculatetheradiationfallinoninput_geometryusingaskymatrixfromtheselectSkyMxtcomponent.Thistypeofradiationsutdyisusefulforbuildingsurfacessuchaswindows,whereyoumightbeinterestedinsolarheatgain,orsolarpanels,whereyoumightbeinterestedintheenergythatcanbecollected.Thiscomponentisalsogoodforsurfacesrepresentingoutdoorspaces(suchasparksorseatingareas)whereradiationcouldaffectthermalcomfortorvegetationgrowth.Noreflectionofsunlightisincludedintheradiationanalysiswiththiscomponentanditshouldthereforebeusedneitherforinteriordaylightstudiesnorforcomplexgeometriesnorforsurfaceswithhighareflectivity.Forthesesituationswheretherelfectionoflightisimportant,theHoneybeedaylightcomponentsshouldbeusedinsteadofthisone.-

LadybugPrimer

136Radiation_Analysis

Inputs

north[Optional]


geometry[Required]

Geometryforwhichradiationanalysiswillbeconducted.GeometrymustbeeitheraBrep,aMeshoralistofBrepsorMeshes.

context[Optional]

Contextgeometrythatcouldblocksunlighttothetest_geometry.ConextgeometrymustbeeitheraBrep,aMeshoralistofBrepsorMeshes.

gridSize[Default]

AnumberinRhinomodelunitsthatrepresentstheaveragesizeofagridcellforradiationanalysisonthetestsurface(s).Thisvalueshouldbesmallerthanthesmallestdimensionofthetestgeometryformeaningfulresults.Notethat,thesmallerthegridsize,thehighertheresolutionoftheanalysisandthelongerthecalculationwilltake.

disFromBase[Required]

AnumberinRhinomodelunitsthatrepresentstheoffsetdistanceofthetestpointgridfromtheinputtest_geometry.Usually,thetestpointgridisoffsetbyasmallamountfromthetest_geometryinordertoensurethatradiationanalysisisdoneforthecorrectsideofthetest_geometry.Iftheresultingradiationmeshofthiscomponentisoffsettothewrongsideoftest_geometry,youshouldusethe"Flip"Rhinocommandonthetest_geometrybeforeinputtingittothiscomponent.

orientationStudyP[Optional]

Optionaloutputfromthe"OrientationStudyParameter"component.YoucanuseanOrientationStudyinputheretoanswerquestionslike"Whatorientationofmybuildingwillgivemethehighestorlowestradiationgainformyanalysisperiod?"AnOrientationStudywillautomaticallyrotateyourinput_geometryaroundseveraltimesandrecordtheradiationresultseachtimeinordertooutputalistofvaluesfortotalRadiationandagrafteddatastreamforradiationResult.


LadybugPrimer



legendPar[Optional]


parallel[Optional]

Setto"True"toruntheradiationanalysisusingmultipleCPUs.Thiscandramaticallydecreasecalculationtimebutcaninterferewithotherintensecomputationalprocessesthatmightberunningonyourmachine.

runIt[Required]

Setto"True"torunthecomponentandperformradiationanalysisontheinput_geometry.

bakeIt[Optional]

SettoTruetobaketheanalysisresultsintotheRhinoscene.


Usethisinputtochangetheworkingdirectoryoftheradiationanalysisonyoursystem.Inputheremustbeavalidfilepathlocationonyourcomputer.Thedefaultissetto"C:\Ladybug"anditisfromthisfilelocationthatradiationresultsareloadedintograsshopperaftertheanalysisisdone.

projectName[Optional]

Usethisinputtochangetheprojectnameofthefilesgeneratedintheworkingdirectory.Inputheremustbeastringwithoutspecialcharacters.If"bakeIt_"issetto"True",theresultwillbebakedintoalayerwiththisprojectname.

Outputs

readMe!

...

contextMesh

Anuncoloredmeshrepresentingthecontext_geometrythatwasinputtothiscomponent.Connectthisoutputtoa"Mesh"grasshoppercomponenttopreviewthisoutputseperatelyfromtheothersofthiscomponent.Notethatthismeshisgeneratedbeforetheanalysisisrun,allowingyoutobesurethattherightgeometrywillberun

LadybugPrimer


throughtheanalysisbeforerunningthiscomponent.

analysisMesh

Anuncoloredmeshrepresentingthetest_geometrythatwillbeanalyzed.Connectthisoutputtoa"Mesh"grasshoppercomponenttopreviewthisoutputseperatelyfromtheothersofthiscomponent.Notethatthismeshisgeneratedbeforetheanalysisisrun,allowingyoutobesurethattherightgeometrywillberunthroughtheanalysisbeforerunningthiscomponent.

testPts

Thegridoftestpointsonthetest_geometrythatwillbeusedtoperformtheradiationanalysis.Notethatthesepointsaregeneratedbeforetheanalysisisrun,allowingyoutopreviewtheresolutionoftheresultbeforeyourunthecomponent.

testVec

Vectorsforeachofthetestpointsonthetest_geometry,whichindicatethedirectionforwhichradiationanalysisisperformed.HookthisandthetestpointsuptoaGrasshopper"VectorDisplay"componenttoseehowanalysisisperformedonthetest_geometry.

radiationResult

TheamountofradiationinkWh/m2fallingontheinputtest_geometryateachofthetestpoints.

radiationMesh

Acoloredmeshofthetest_geometryrepresentingtheradiationinkWh/m2fallingonthisinput_geometryfortheselectedsky.

radiationLegend

AlegendfortheradiationstudyshowingradiationvaluesthatcorrespondtothecolorsoftheradiationMesh.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePt

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtotheradiationmeshwiththegrasshopper"move"component.

totalRadiation

ThetotalradiationinkWhfallingontheinputtest_geometry.Thisiscomputedthrough

LadybugPrimer


amassadditionofresultsateachofthetestpointsinkWh/m2multipliedbytheareaofthefacethatthetestpointisrepresenting.

intersectionMtx

Apythonlistthatincludestherelationbetweeneachtestpointandalltheskypatchsontheskydome.Afterrunningabasicradiationstudy,youcanconnectthisoutputtotheLadybug"RealTimeRadiationAnalysis"componenttoscrollthroughtheradiationfallingonyourtestgeometryonanhour-by-hour,day-by-day,ormonth-by-monthbasisinrealtime.

CheckHydraExampleFilesforRadiationAnalysis

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Radiation Analysis

SunlightHoursAnalysis

ThiscomponentcalculatesthenumberofhoursofdirectsunlightreceivedbyinputgeometryusingsunvectorsfromthesunPathcomponent.Thiscomponentcanbeusedtoevaluatethenumberofhoursofsunlightreceivedbyvegetationinaparkorthehourswheredirectsunlightmightmakeacertainoutdoorspacecomfortableoruncomfortable.Itcanalsobeusedforcoarsely-griddedshadowstudiesintheRhinoscene.Forfinerandmoredetailedshadowstudieswithsimpleinputgeometry,theLadybugShadowStudycomponentcanbeused.Fordetailedshadowstudieswithcomplexgeometry,theHoneybeedaylighttoolsarerecommended.-

Inputs

LadybugPrimer

141Sunlight_Hours_Analysis

north[Optional]


geometry[Required]

Geometryforwhichsunlighthoursanalysiswillbeconducted.GeometrymustbeeitheraBrep,aMeshoralistofBrepsorMeshes.

context[Optional]

Contextgeometrythatcouldblocksunlighttothetest_geometry.ConextgeometrymustbeeitheraBrep,aMeshoralistofBrepsorMeshes.

gridSize[Default]

AnumberinRhinomodelunitsthatrepresentstheaveragesizeofagridcellforsunlighthoursanalysisonthetest_geometry.Thisvalueshouldbesmallerthanthesmallestdimensionofthetest_geometryformeaningfulresults.Notethat,thesmallerthegridsize,thehighertheresolutionoftheanalysisandthelongerthecalculationwilltake.


AnumberinRhinomodelunitsthatrepresentstheoffsetdistanceofthetestpointgridfromtheinputtest_geometry.Usually,thetestpointgridisoffsetbyasmallamountfromthetest_geometryinordertoensurethatsunlighthoursanalysisisdoneforthecorrectsideofthetest_geometry.Iftheresultingmeshofthiscomponentisoffsettothewrongsideoftest_geometry,youshouldusethe"Flip"Rhinocommandonthetest_geometrybeforeinputtingittothiscomponent.


Optionaloutputfromthe"OrientationStudyParameter"component.

sunVectors[Required]

SunvectorsfromthesunPathcomponent,whichwillbeusedtodeterminethenumberofhoursofdirectsunlightreceivedbythetest_geometry.

timeStep[Default]

ThenumberoftimestepsperhourusedbythesunPathcomponentthatgeneratedthesunvectors.Thisnumbershouldbesmallerthan60anddivisibleby60.Thedefaultis

LadybugPrimer


setto1suchthatonessunvectorisgeneratedforeachhour.

legendPar[Optional]

Optionaloutputfromthe"OrientationStudyParameter"component.YoucanuseanOrientationStudyinputheretoanswerquestionslike"Whatorientationofmybuildingwillgivemethehighestorlowesthoursofdirectsunlightformyanalysisperiod?"AnOrientationStudywillautomaticallyrotateyourinput_geometryaroundseveraltimesandrecordthesunlighthoursresultseachtimeinordertooutputalistofvaluesfortotalSunlightHoursandagrafteddatastreamforsunlightHoursResult.

parallel[Optional]

Setto"True"torunthesunlighthoursanalysisusingmultipleCPUs.Thiscandramaticallydecreasecalculationtimebutcaninterferewithotherintensecomputationalprocessesthatmightberunningonyourmachine.

runIt[Required]

Setto"True"torunthecomponentandperformsunlighthoursanalysisontheinput_geometry.

bakeIt[Optional]

Setto"True"tobaketheanalysisresultsintotheRhinoscene.


Usethisinputtochangetheworkingdirectoryofthesunlighthoursanalysisonyoursystem.Inputheremustbeavalidfilepathlocationonyourcomputer.Thedefaultissetto"C:\Ladybug"anditisfromthisfilelocationthatsunlighthoursresultsareloadedintograsshopperaftertheanalysisisdone.

projectName[Optional]

Usethisinputtochangetheprojectnameofthefilesgeneratedintheworkingdirectory.Inputheremustbeastringwithoutspecialcharacters.If"bakeIt_"issetto"True",theresultwillbebakedintoalayerwiththisprojectname.

Outputs

readMe!

...

LadybugPrimer


contextMesh

Anuncoloredmeshrepresentingthecontext_geometrythatwasinputtothiscomponent.Connectthisoutputtoa"Mesh"grasshoppercomponenttopreviewthisoutputseperatelyfromtheothersofthiscomponent.Notethatthismeshisgeneratedbeforetheanalysisisrun,allowingyoutobesurethattherightgeometrywillberunthroughtheanalysisbeforerunningthiscomponent.

analysisMesh


testPts

Thegridoftestpointsonthetest_geometrythatwillbeusedtoperformthesunlighthoursanalysis.Notethatthesepointsaregeneratedbeforetheanalysisisrun,allowingyoutopreviewtheresolutionoftheresultbeforeyourunthecomponent.

testVec

Vectorsforeachofthetestpointsonthetest_geometry,whichindicatethedirectionforwhichsunlighthoursanalysisisperformed.HookthisandthetestpointsuptoaGrasshopper"VectorDisplay"componenttoseehowanalysisisperformedonthetest_geometry.

sunlightHoursResult

Thenumberofhoursofdirectsunlightreceivedbyeachofthetestpointsoftheinputtest_geometry.Notethatisisthenumberofhoursoutofthetotalnumberofconnected_sunVectors.

sunlightHoursMesh

Acoloredmeshofthetest_geometryrepresentingthehoursofdirectsunlightreceivedbythisinput_geometryfortheinputsunVectors.

sunlightHoursLegend

AlegendforthesunlighthoursstudyshowingthenumberofhoursthatcorrespondtothecolorsofthesunlightHoursMesh.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

LadybugPrimer


legendBasePt

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtothesunlighthoursmeshwiththegrasshopper"move"component.

totalSunlightHours

Theaveragenumberofhoursofdirectsunlightreceivedbythetest_geometry.

sunIsVisible

Agrafteddatastreamforeachtestpointwitha"1"foreachhourofthesunVectorsthatthesunisvisibleanda"0"foreachhourofthesunVectorswhenthesunisblocked.

CheckHydraExampleFilesforSunlightHoursAnalysis

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Sunlight Hours Analysis

BouncefromSurface

UsethiscomponenttogetasenseofhowdirectsunlightisreflectedoffofaninitialsourceSrfandsubsequentlytoasetofcontextgeometriesbytracingsunraysforwardsthroughthisgeometry.Exampleswherethiscomponentmightbeusefulincludetheevaluationofthediffusionoflightbyalightshelf,ortestingtoseewhetheraparabolicbuildinggeometry(likeaGherybuilding)mightfocussunlighttodangerouslevelsatcertaintimesoftheyear.Notethatthiscomponentassumesthatallsunlightisreflectedoffofthesegeometriesspecularly(asiftheywereamirror)and,formoredetailedraytraceanalysis,theHoneybeedaylightcomponentsshouldbeused.-

Inputs

LadybugPrimer

146Bounce_from_Surface

sourceSrfs[Required]

Abrepormeshrepresentingasurfacethatyouareinterestedinseeingdirectsunlightbounceoffof.Youcanalsoputinlistsofbrepsormeshes.Thesesurfaceswillbeusedtogeneratetheinitialsunraysinagrid-likepattern.Notethat,forcurvedsurfaces,smoothmeshesofthegeometrywillbemoreaccuratethaninputingaBrep.

gridSizeOrPoints[Required]

AnumberinRhinomodelunitsthatrepresentstheaveragesizeofagridcelltogeneratethepoints,orlistofpointsitself.Notethat,ifyouputinmeshesfortheinputabove,the_gridSizenumberoptionofthisinputwillnotworkasthiscomponentwillusetheverticesofthemeshtogeneratethesunrays.


AsunvectorfromthesunPathcomponentoralistofsunvectorstobeforwardray-traced.

context[Optional]

Brepsormeshesofconextgeometry,whichwillreflectthesunraysaftertheybounceoffofthe_sourceSrfs.Notethat,forcurvedsurfaces,smoothmeshesofthegeometrywillbemoreaccuratethaninputingaBrep.

numOfBounce[Default]

Anintergerrepresentingthenumberofraybouncestotracethesunraysforward.

lastBounceLen[Default]

Anumberrepresentingthelengthofthesunrayafterthelastbounce.Ifleftempty,thislengthwillbethediagonaloftheboundingboxsurroundingallinputgeometries.

firstBounceLen[Optional]

Anumberrepresentingthelengthofthesunraybeforethefirstbounce.Ifleftempty,thislengthwillbethediagonaloftheboundingboxsurroundingallinputgeometries.

Outputs

rays

Thesunraystracedforwardthroughthegeometry.

bouncePts

LadybugPrimer


Thegeneratedbasepointsonthe_sourceSrfstowhichthesunrayswillbedirected.Thepreviewofthisoutputissettobehiddenbydefault.ConnecttoaGrasshopper"Point"componenttovisualize.

CheckHydraExampleFilesforBouncefromSurface

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Bounce from Surface

ViewAnalysis

Usethiscomponenttoevaluatethevisibilityofinput_geometryfromasetofkeyviewingpoints.Forexample,thiscomponentcanbeusedtoevaluatethevisibilityofan3Darchitecturalfeaturefromasetofkeyviewingpointsalonganearbystreetorparkwherepeoplecongregate.AnotherexamplewouldbeevaluatingthevisibilityofparkvegetationgeometryfromasetofkeysunpositionpointsfromthesunPathcomponent.Yetanotherexamplewouldbeevaluatingthe"visibility"ofanoutdooroverheadradiativeheaterfromasetofkey"viewing"pointslocatedoverahumanbodystandingbeneathit.Thiscomponentoutputsapercentageofviewpointsseenbytheinput_geometry.Inthethreeexampleshere,thiswouldbethepercentageofthe3Darchitecturalfeatureseenfromthestreet,the

LadybugPrimer

149View_Analysis

percentageofsunlithoursreceivedbythevegetation,orthepercentageofthehumanbodywarmedbytheheater.Thiscomponentwillevaluateviewfromthetestpointsobjectivelyinalldirections.-

Inputs

geometry[Required]

Geometryforwhichvisibilityanalysiswillbeconducted.GeometrymustbeeitheraBrep,aMesh,oralistofBrepsorMeshes.

context[Optional]

Contextgeometrythatcouldblocktheviewfromthe_viewTypeOrPointstothetest_geometry.ConextgeometrymustbeeitheraBrep,aMesh,oralistofBrepsorMeshes.

gridSize[Default]

AnumberinRhinomodelunitsthatrepresentstheaveragesizeofagridcellforvisibilityanalysisonthetest_geometry.Thisvalueshouldbesmallerthanthesmallestdimensionofthetest_geometryformeaningfulresults.Notethat,thesmallerthegridsize,thehighertheresolutionoftheanalysisandthelongerthecalculationwilltake.


AnumberinRhinomodelunitsthatrepresentstheoffsetdistanceofthetestpointgridfromtheinputtest_geometry.Usually,thetestpointgridisoffsetbyasmallamountfromthetest_geometryinordertoensurethatvisibilityanalysisisdoneforthecorrectsideofthetest_geometry.Iftheresultingmeshofthiscomponentisoffsettothewrongsideoftest_geometry,youshouldusethe'Flip'Rhinocommandonthetest_geometrybeforeinputtingittothiscomponent.


Optionaloutputfromthe'OrientationStudyParameter'component.YoucanuseanOrientationStudyinputheretoanswerquestionslike'Whatorientationofmybuildingwillgivemethehighestorlowestvisibilityfromthestreet?'AnOrientationStudywillautomaticallyrotateyourinput_geometryaroundseveraltimesandrecordthevisibilityresultseachtimeinordertooutputalistofvaluesforaverageViewandagrafteddatastreamforviewStudyResult.

viewTypeOrPoints[Required]

LadybugPrimer

150View_Analysis

Anintegerrepresentingthetypeofviewanalysisthatyouwouldliketoconductoralistofpointstowhichyouwouldliketotesttheview.Forintegeroptions,choosefromthefollowingoptions:0-HorizontalRadial-Thepercentageofthe360horizontalviewbandvisiblefromeachtestpoint.Usethistostudyhorizontalviewsfrominteriorspacestotheoutdoors.1-Horizontal60DegreeConeofVision-Thepercentageofthe360horizontalviewbandboundedontopandbottombya30degreeoffsetfromthehorizontal(derivedfromthehumanconeofvision).Usethistostudyviewsfrominteriorspacestotheoutdoors.Notethatthiswilldiscountthe_geometryfromthecalculationandonlylookat_contextthatblocksthescene.2-Spherical-Thepercentageofthespheresurroundingeachofthetestpointsthatisnotblockedbycontextgeometry.Notethatthiswilldiscountthe_geometryfromthecalculationandonlylookat_contextthatblocksthescene.3-Skyview-Thepercentageoftheskythatisvisiblefromtheinput_geometry.

viewPtsWeights[Optional]

Alistofnumbersthatalignwiththetestpointstoassignweightsofimportancetotheseveral_viewTypeOrPointsthathavebeenconnected.Weightedvaluesshouldbebetween0and1andshouldbecloserto1ifacertainpointismoreimportant.Thedefaultvalueforallpointsis0,whichmeanstheyallhaveanequalimportance.Thisinputcouldbeusefulincasessuchastheradiativeheaterexamplewherepointsonthehumanbodywithexposedskincouldbeweightedatahighervalue.

legendPar[Optional]


parallel[Optional]

Setto'True'torunthevisibilityanalysisusingmultipleCPUs.Thiscandramaticallydecreasecalculationtimebutcaninterferewithotherintensecomputationalprocessesthatmightberunningonyourmachine.

runIt[Required]

Setto'True'torunthecomponentandperformvisibilityanalysisoftheinput_geometry.

bakeIt[Optional]

Setto'True'tobaketheanalysisresultsintotheRhinoscene.

Outputs

readMe!

LadybugPrimer

151View_Analysis

...

contextMesh

Anuncoloredmeshrepresentingthecontext_geometrythatwasinputtothiscomponent.Connectthisoutputtoa"Mesh"grasshoppercomponenttopreviewthisoutputseperatelyfromtheothersofthiscomponent.Notethatthismeshisgeneratedbeforetheanalysisisrun,allowingyoutobesurethattherightgeometrywillberunthroughtheanalysisbeforerunningthiscomponent.

analysisMesh


testPts

Thegridoftestpointsonthetest_geometrythatwillbeusedtoperformthevisibilityanalysis.Notethatthesepointsaregeneratedbeforetheanalysisisrun,allowingyoutopreviewtheresolutionoftheresultbeforeyourunthecomponent.

testVec

Vectorsforeachofthetestpointsonthetest_geometry,whichindicatethedirectionforwhichvisibilityanalysisisperformed.HookthisandthetestpointsuptoaGrasshopper"VectorDisplay"componenttoseehowanalysisisperformedonthetest_geometry.

viewVec

ScriptvariableviewAnalysis

viewStudyResult

Thepercentageof_viewTypeOrPointsvisiblefromeachofthetestpointsoftheinputtest_geometry.

viewStudyMesh

Acoloredmeshofthetest_geometryrepresentingthepercentageof_viewTypeOrPointsvisiblebyeachpartoftheinput_geometry.

viewStudyLegend

LadybugPrimer

152View_Analysis

AlegendforthevisibilityanalysisshowingthepercentageofvisiblepointsthatcorrespondtothecolorsoftheviewStudyMesh.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePt

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtotheviewstudymeshwiththegrasshopper"move"component.

averageView

Theaveragepercentageofthe_viewTypeOrPointsseenbyallofthetest_geometry.

ptIsVisible

Agrafteddatastreamforeach_geometrytestpointwitha"1"foreach_viewPointthatisvisiblebythetestpointanda"0"foreach_viewPointthatisblocked.

CheckHydraExampleFilesforViewAnalysis

LadybugPrimer

153View_Analysis

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_View Analysis

ViewFromSun

UsethiscomponenttoopenanewviewportinRhinothatshowstheviewfromthesun.ThisisusefulforunderstandingwhatpartsofRhinogeometryareshadedataparticularhouroftheday.-

Inputs

sunVector[Required]

AsunvectorfromwhichthetheRhinoviewwillbegenerated.UsetheLadybugsunPathcomponenttogeneratesunVectors.

LadybugPrimer

154View_From_Sun

cenPt[Default]

ThetargetpointofthecamerafortheRhinoviewthatwillbegenerated.ThispointshouldbeclosetoRhinogeometrythatyouareinterestedinviewingfromthesun.Ifnopointisprogived,theRhinooriginwillbeused(0,0,0).

sunViewPt[Optional]

Anoptionalpointforthecameraposition(orsunposition).Usethistomovethecameraclosertothegeometryyouwouldliketoviewiftheinitialviewistoofaraway..

width[Optional]

Anoptionalintergerthatrepresentsthewidth(inpixels)oftheRhinoviewportthatwillbegenerated.

height[Optional]

Anoptionalintergerthatrepresentstheheight(inpixels)oftheRhinoviewportthatwillbegenerated.

dispMode[Optional]

AnoptionaltextinputforthedisplaymodeoftheRhinoviewportthatwillbegenerated.Forexample:Wireframe,Shaded,Rendered,etc.

Outputs

readMe!

...

CheckHydraExampleFilesforViewFromSun

LadybugPrimer

155View_From_Sun

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_View From Sun

viewRose

Usethiscomponenttoseetheareavisiblefromagivenviewpointacrossa2Dplaneofvision.Thecomponentwillcreateacircularsurfaceinthisplaneofvisionthatisinterruptedbycontextgeometrytoshowtheplacesthatcanbeseenthroughthiscontextgeometry.-

Inputs

context[Required]

BrepsorMeshesrepresentingcontextgeometrythatcanblocktheviewaroundagivenviewPoint.

LadybugPrimer

156view_Rose

plane[Default]

TestPlane

radius[Required]

AradiustomaketheviewroseinRhinomodelunits.Notethat,iftheviewroseisnotextendingpastthe_contextgeometry,youshouldincreasethisvalue.

Outputs

readMe!

...

viewRose

Asurfacerepresentingthevisibleareafromtheviewpointpastthe_contextgeometry.

blocked

Asetofcurvesrepresentingtheviewsblockedbythe_contextgeometryfromtheviewpoint.

visibleAngle

Thetotalangleofvisibilityfromtheviewpointintheplaneofvisibility.

CheckHydraExampleFilesforviewRose

LadybugPrimer

157view_Rose

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_view Rose

ComfortShadeBenefitEvaluator

Thisisacomponentforvisualizingthedesirabilityofshadeintermsofcomforttemperaturebyusingsolarvectors,aseriesofhourlytemperatures(usuallyoutdoortemperatures),andanassumedbalancetemperature.Thebalancetemperaturerepresentsthemediantemperturethatpeoplefindcomfortable,whichcanvaryfromclimatetoclimatebutisusuallysomewherearound20C.Solarvectorsforhourswhenthetemperatureisabovethebalancepointcontributepositivelytoshadedesirabilitywhilesolarvectorsforhourswhenthetemperatureisbelowthebalancepointcontributenegatively.Thecomponentoutputsacoloredmeshoftheshadeillustratingtheneteffectofshadingeachmeshface.Ahighersaturationofblueindicatesthatshadingthecellisverydesirable.Ahighersaturationofredindicatesthatshadingthecellisharmful(blockingmorewintersunthansummersun).

LadybugPrimer

158Comfort_Shade_Benefit_Evaluator

Desaturatedcellsindicatethatshadingthecellwillhaverelativelylittleeffectonoutdoorcomfortorbuildingperformance.Theunitsforshadedesirabilityarenettemperturedegree-dayshelpedperunitareaofshadeifthetestcellisblue.Ifthetestcellisred,theunitsarenetheatingdegree-daysharmedperunitareaofshade.ThemethodusedbythiscomponentisbasedoffoftheShaderademethoddevelopedbyChristophReinhart,JonSargent,JeffreyNiemasz.ThiscomponentusesShaderade'smethodforevaluatingshadeandwindowgeometryintermsofsolarvectorsbutsubstitutesShaderade'senergysimulationforanevaluationofheatingandtemperturedegree-daysaboutabalancetemperature.Aspecialthanksgoestothemandtheirresearch.ApaperdetailingtheShaderademethodisavailableat:http://www.gsd.harvard.edu/research/gsdsquare/Publications/Shaderade_BS2011.pdfTheheating/temperturedegree-daycalculationusedhereworksbyfirstgettingthepercentageofsunblockedbythetestcellforeachhouroftheyearusingtheShaderademethod.Next,thispercentageforeachhourismultipliedbythetemperatureaboveorbelowthebalancepointforeachhourtogeta"degree-hour"foreachhouroftheyearforacell.Then,allthetemperture-degreehours(abovethebalancepoint)andheatingdegree-hours(belowthebalancepoint)aresummedtogivethetotalheatingortemperturedegree-hourshelpedorharmedrespectively.Thisnumberisdividedby24hoursofadaytogivedegree-days.Thesedegreedaysarenormalizedbytheareaofthecelltomakethemetricconsistentacrosscellsofdifferentarea.Lastly,thenegativeheatingdegree-daysareaddedtothepositivetemperturedegree-daystogiveaneteffectforthecell.-

Inputs

location[Required]

ThelocationoutputfromtheimportEPWorconstructLocationcomponent.Thisisessentiallyalistoftextsummarizingalocationontheearth.

temperatures[Required]

Astreamof8760temperaturevalues(includingaheader)representingthetemperatureateachhouroftheyearthatwillbeusedtoevaluateshadebenefit.ThiscanbethedryBulbTemperaturefromthe'ImportEPW'component,theuniveralThermalClimateIndex(UTCI)outputfromthe'OutdoorComfortCalculator'component,orthestandardEffectiveTemperature(SET)outputfromthe'PMVComfortCalculator'component.Ifyouareusingthiscomponenttoevaluateshadeforapassivebuildingwithnoheating/cooling,thisinputcanalsobetheindoortemperatureofthezonetobeshaded.

balanceTemperature[Optional]

LadybugPrimer


http://www.gsd.harvard.edu/research/gsdsquare/Publications/Shaderade_BS2011.pdf

Anestimatedbalancetemperaturerepresentingmediantemperturethatpeoplefindcomfortable,whichcanvaryfromclimatetoclimate.Thedefaultissetto17.5C,whichisthemedianoutdoorcomforttemperature(UTCI)thatdefinestheconditionsofnothermalstress(9<UTCI<26).

temperatureOffest[Optional]

AnnumberrepresetingtheoffsetfromthebalanceTemperature_indegreesCelciusatwhichpointtheshadeimportancebeginstohaveaneffect.Thedefaultissetto8.5C,whichistherangeofoutdoorcomforttemperature(UTCI)thatdefinestheconditionsofnothermalstress(9<UTCI<26).

testShades[Required]

ABreprepresentingtheshadetobeevaluatedforitsbenefit.

testRegion[Required]

Abreprepresentinganoutdoorareaforwhichshadingisbeingconsideredorthewindowofabuildingthatwouldbeaffectedbytheshade.Notethatonlybrepswithasinglesurfacearesupportednowandvolumetricbrepswillbeincludedatalaterpoint.

gridSize[Optional]

Thelengthofeachoftheshade'stestcellsinmodelunits.Pleasenotethat,asthisvaluegetslower,simulationtimeswillincreaseexponentiallyeventhoughthiswillgiveahigherresolutionofshadebenefit.

context[Optional]

ScriptvariableShadeBenefit

north[Optional]


skyResolution[Optional]

Anintergerequalto0orabovetosetthenumberoftimesthatthetergenzaskypatchesaresplit.Ahighernumberwillensureagreateraccuracybutwilltakelonger.Ataskyresolutionof4,eachhour'stemperatureisessentiallymatchedwithanindividualsunvectorforthathour.Ataresolutionof5,asunvectorisproducedforeveryhalf-hour,at6,everyquarterhour,andsoon.Thedefaultissetto4,whichshouldbehighenoughof

LadybugPrimer


aresolutiontoproduceameaningfulreaultinallcases.

delNonIntersect[Optional]

Setto"True"todeletemeshcellswithnointersectionwithsunvectors.Meshcellswhereshadingwillhavelittleeffectbecauseanequalamountofwarmandcooltemperaturevectorswillstillbeleftinwhite.

legendPar[Optional]

Legendparametersthatcanbeusedtore-colortheshade,changethehighandlowboundary,orsyncmultipleevaluatedshadeswiththesamecolorsandlegendparameters.

parallel[Optional]

Setto"True"torunthesimulationwithmultiplecores.Thiscanincreasethespeedofthecalculationsubstantiallyandisrecommendedifyouarenotrunningotherbigorimportantprocesses.

runIt[Required]

Setto'True'torunthesimulation.

Outputs

readMe!

...

sunVectors

Thesunvectorsthatwereusedtoevaluatetheshade(notethatthesewillincreaseastheskydesnityincreases).

regionTestPts

Pointsacrossthetestregionsurfacefromwhichsunvectorswillbeprojected

shadeMesh

Acoloredmeshofthe_testShadesshowingwhereshadingishelpful(insatuatedblue),harmful(insaturatedred),ordoesnotmakemuchofadifference(whiteordesaturatedcolors).

legend

LadybugPrimer


Legendshowingthenumericvaluesofdegree-daysthatcorrespondtothecolorsintheshademesh.

legendBasePoint

ScriptvariableShadeBenefit

shadeHelpfulness

Thecumulativetemperturedegree-days/squareRhinomodelunithelpedbyshadingthegivencell.(C-day/m2)*ifyourmodelunitsaremeters.

shadeHarmfulness

Thecumulativeheatingdegree-days/squareRhinomodelunitharmedbyshadingthegivencell.(C-day/m2)*ifyourmodelunitsaremeters.Notethatthesevaluesareallnegativeduetothefactthattheshadeisharmful.

shadeNetEffect

Thesumofthehelpfulnessandharmfulnessforeachcell.Thiswillbenegativeifshadingthecellhasanetharmfuleffectandpositiveiftheshadehasanethelpfuleffect.

CheckHydraExampleFilesforComfortShadeBenefitEvaluator

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Comfort Shade Benefit Evaluator

ShadingDesigner

Usethiscomponenttogenerateshadingbrepsforanyglazedsurfaceorlistofglazedsurfaces.Thecomponentsupportstwomethodsforshadinggeneration.Thefirstisasimpledepthmethod,whichwillgenerateanoverhangofthespeficieddepth(ormultipleoverhangsifthe_numOfShdsisincreased).ThesecondmethodistoinputasetofsolarvectorsfromtheSunpathcomponentthatshouldbeblockedbytheshade.-

Inputs

glzSrf[Required]

LadybugPrimer

163ShadingDesigner

ASurfaceorBreprepresentingawindowtobeusedforshadingdesign.ThiscanalsobealistofSurfacesofBreps.

depthOrVector[Required]

AnumberrepresentingthedepthoftheshadetobegeneratedorasunvectortobeshadedfromtheglzSrf.Youcanalsoinputlistsofdepths,whichwillassigndifferentdepthsbasedoncardinaldirection.Forexample,inputing4valuesfordepthswillassigneachvalueofthelistasfollows:item0=northdepth,item1=westdepth,item2=southdepth,item3=eastdepth.ListsofvectorstobeshadedcanalsobeinputandshadescanbejoinedtogetherwiththemergeVectorsinput.

numOfShds[Required]

Thenumberofshadestogeneratedforeachglazedsurface.

distBetween[Required]

Analternateoptionto_numOfShdswheretheinputhereisthedistanceinRhinounitsbetweeneachshade.

runIt[Required]

Setto'True'torunthecomponentandgenerateshades.

optionalShdSrf[Optional]

Anoptionalshadesurfacerepresentinga2Dareaunderconsiderationforshading.Thisinputcanonlybeusedwiththesunvectormethod.

optionalPlanes[Optional]

Anoptionalplane(orlistofplanes)representinga2Dareaunderconsiderationforshading.Thisinputcanonlybeusedwiththesunvectormethod.

mergeVectors[Optional]

Setto'True'tomergealltheshadesgeneratedfromalistofsunvectorsintoasingleshade.Thisinputcanonlybeusedwiththesunvectormethod.

horOrVertical[Default]

Setto'True'togeneratehorizontalshadesor'False'togenerateverticalshades.YoucanalsoinputlistsofhorOrVerticalinput,whichwillassigndifferentorientationsbasedoncardinaldirection.

LadybugPrimer

164ShadingDesigner

shdAngle[Default]

Anumberbetween-90and90thatrepresentsanangleindegreestorotatetheshades.Thedefaultissetto'0'fornorotation.Ifyouhaveverticalshades,usethistorotatethemtowardstheSouthbyacertainvalueindegrees.IfappliedtowindowsfacingEastorWest,tiltingtheshadeslikethiswillletinmorewintersunthansummersun.Ifyouhavehorizontalshades,usethisinputtoangleshadesdownward.Youcanalsoputinlistsofanglestoassigndifferentshadeanglestodifferentcardinaldirections.

north[Optional]

InputavectortobeusedasatrueNorthdirectionoranumberbetween0and360thatrepresentsthedegreesofffromthey-axistomakeNorth.ThedefaultNorthdirectionissettotheY-axis(0degrees).

Outputs

readMe!

...

shadingSrfs

Shadingsurfacesthatweregeneratedbasedontheinputs.

CheckHydraExampleFilesforShadingDesigner

LadybugPrimer

165ShadingDesigner

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_ShadingDesigner

SolarEnvelope

Usethiscomponenttogenerateasolarenvelopeforagiventestsurface,setofsolarvectors,andcontextgeometrythatyouwanttoensuresolaraccessto.Solarenvelopesaretypicallyusedtoillustratethevolumethatcanbebuiltwithininordertoensurethatanewdevelopmentdoesnotshadethesurroundingpropertiesforagivensetofsunvectors.-

Inputs

baseSrf[Required]

Asurfacerepresentingtheareaforwhichyouwanttocreatethesolarenvelope.

LadybugPrimer

166SolarEnvelope

obstacleCrvs[Required]

Listofcurvesindicatingthetopbordersofoursurroundingsthataretakenintoaccountincalculatingthesolarcollection.


SunvectorsrepresentinghoursoftheyearwhensunshouldbeaccessibletothepropertiessurroundingthebaseSrf.sunVectorscanbegeneratedusingtheLadybugsunPathcomponent.

gridSize[Optional]

AnumericvalueinidcatingthegirdsizeoftheanalysisinRhinomodelunits.Thesmallerthegridsize-themoretestpoints(moreaccuratebutslower).Defaultvalueisautomaticallysetbasedonthesizeoftheinput_baseSrf.

maxHeight[Optional]

Iftherearenoobstrucsionsthiswouldbethelowestvalueforthesolarcollectionpoints.Defaultvaluesetto20metersbelowtheaveragebaseSrfheight.

envelopeToRun[Optional]

Setto'True'ifyouwouldlikethecomponenttocalculateasolarrightsboundaryand'False'ifyouwouldlikeasolarcollectionboundary.Thedefaultissettosolarenvelope.

numOfCPUs[Default]

NumberofCPUstobeusedforthesimulation.Defaultvaluewouldbe1

runIt[Required]

Setto'True'torunthecomponentandgeneratesolarcollectionpoints.

Outputs

readMe!

Logofthecomponent.

envelopePts

Alistof3dpointsrepresentingtheheightstowhichthesolarcollectionreaches.PlugintoanativeGH'DelunayMesh'componenttovisualizethefullsolarcollectionboundary.

LadybugPrimer

167SolarEnvelope

envelopeBrep

TheclosedvolumeinwhichyoucanbuildabovewhichthebuildingwillhavedirectsolaraccesstotheinputsunVectors.

CheckHydraExampleFilesforSolarEnvelope

LadybugPrimer

168SolarEnvelope

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_SolarEnvelope

SolarFan

Usethiscomponenttogenerateasolarfanforagiventestsurfaceandsetofsolarvectors.Solarfansessentiallyillustratethevolumethatshouldbeclearofshadinginordertoprovidesolaraccesstoatestsurfaceforagivensetofsunvectors.Solarfansaretypicallyusedtoensuresolaraccessforparkvegetationinthemidstoflargedevelopmentsconstructedaroundit.Itcanbealsousedtoensuresolaraccessforwindowsthatmightwanttousethesunforheatingforceratinhoursoftheyear.-

Inputs

baseSrf[Required]

LadybugPrimer

169SolarFan

Asurfacerepresentingapieceofland(suchasapark)orawindowforwhichsolaraccessisdesired.


SunvectorsrepresentinghoursoftheyearwhensunshouldbeaccessibletothebaseSrf.sunVectorscanbegeneratedusingtheLadybugsunPathcomponent.

size[Default]

Inputanumberheretochangehowfarthesolarfanextendsfromthe_baseSrf.Thedefaultissetto1,whichwillproduceasolarfanthatishalfastallasthelongestsideofthe_baseSrf.Notethatincreasingtheheighttoohighcancausethefantobreakupintomultiplefansduetotheresolutionofthesolarvectors.

runIt[Required]

Setto"True"toruntheanalysisandgenerateasolarfan.Notethat,formorethan500sunVectors,calculationtimescantakemorethanahalf-minute.

Outputs

readMe!

...

solarFan

Breprepresentingasolarfanthatshouldbeclearofshadinginordertoensuresolaraccesstothe_baseSrfforthegiven_sunVectors.

CheckHydraExampleFilesforSolarFan

LadybugPrimer

170SolarFan

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_SolarFan

DCtoACderatefactor

UsethiscomponenttocalculateoverallDCtoACderatefactorforPhotovoltaicsSurface's"DCtoACderateFactor_"input.OverallDCtoACderatefactorcorrespondstovariouslocationsandinstancesinaPVsystemwherepowerislostfromDCsystemnameplatetoACpower.-ComponentfirstcalculatesPVWattsv5Totallosses,thenconvertsthemtoPVWattsv1overallDCtoACderatefactor.BasedonPVWattsv5Manual:http://www.nrel.gov/docs/fy14osti/62641.pdf-Ifnothingsuppliedtotheinputs,defaultvalueof0.85willbeused.-

Inputs

LadybugPrimer

171DC_to_AC_derate_factor

http://www.nrel.gov/docs/fy14osti/62641.pdf

annualShading[Optional]

Lossesduetobuildings,structures,trees,mountainsorotherobjectsthatpreventsolarradiationfromreachingthecells.Inputrange:0to100(%),0beingunshaded,and100beingtotallyshadedPVmodule.-Ifnotsupplieddefaultvalueof0(%)willbeused.

age[Optional]

LossesovertimeduetoweatheringofthePVmodules.Thelossinperformanceistypically1%peryear.Example:forthe20thyearofoperation,anagelossof19%wouldbeappropriate.Inputrange:0(newmodule)to100%(theoretically:101yearoldmodule)-Ifnotsupplieddefaultvalueof0(%)willbeused.

snow[Optional]

Lossesduetosnowcoveringthearray.Thedefaultvalueiszero,assumingeitherthatthereisneversnowonthearray,orthatthearrayiskeptclearofsnow.Inputrange:0(thereisneversnowonthearray,orthearrayiskeptclearofsnow)to100%(anarrayistheoreticallyalwayscoveredwithsnow)-Ifnotsupplieddefaultvalueof0(%)willbeused.

wiring[Optional]

ResistivelossesintheDCandACwiresconnectingmodules,inverters,andotherpartsofthesystem.Inputrange:0to100(%)-Ifnotsupplieddefaultvalueof2(%)willbeused.

soiling[Optional]

Lossesduetodust,dirt,leaves,otherwildlifedroppings,snow,andotherforeignmatteronthesurfaceofthePVmodulethatpreventsolarradiationfromreachingthecells.Soilingislocation-andweather-dependent.Therearegreatersoilinglossesinhigh-traffic,high-pollutionareaswithinfrequentrain.Inputrange:0to100(%)-Ifnotsupplieddefaultvalueof2(%)willbeused.

mismatch[Optional]

Electricallossesduetoslightdifferencescausedbymanufacturingimperfectionsbetweenmodulesinthearraythatcausethemodulestohaveslightlydifferentcurrent-voltagecharacteristics.Inputrange:0to100(%)-Ifnotsupplieddefaultvalueof2(%)willbeused.

availability[Optional]

Lossesduetoscheduledandunscheduledsystemshutdownformaintenance,grid

LadybugPrimer


outages,andotheroperationalfactors.Inputrange:0to100%-Ifnotsupplieddefaultvalueof3(%)willbeused.

connections[Optional]

Resistivelossesinelectricalconnectorsinthesystem.Inputrange0to100(%)-Ifnotsupplieddefaultvalueof0.5(%)willbeused.

nameplateRating[Optional]

Lossesduetoaccuracyofthemanufacturer'snameplaterating.Fieldmeasurementsoftheelectricalcharacteristicsofphotovoltaicmodulesinthearraymayshowthattheydifferfromtheirnameplaterating.Example:anameplateratinglossof5%indicatesthattestingyieldedpowermeasurementsatSTCthatwere5%lessthanthemanufacturer'snameplaterating.Inputrange0to100(%)-Ifnotsupplieddefaultvalueof1(%)willbeused.

lightInducedDegradation[Optional]

Effectofthereductioninthearray'spowerduringthefirstfewmonthsofitsoperationcausedbylight-induceddegradationofphotovoltaiccells.Inputrange0to100(%)-Ifnotsupplieddefaultvalueof1.5(%)willbeused.

Outputs

readMe!

...

totalLosses

PVWattsv5representationofDCtoACderateFactorfactor.Inpercent(%).

DCtoACderateFactor

FactorwhichaccountsforvariouslocationsandinstancesinaPVsystemwherepowerislostfromDCsystemnameplatetoACpower.Unitless.

CheckHydraExampleFilesforDCtoACderatefactor

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_DC to AC derate factor

PhotovoltaicsPerformanceMetrics

UsethiscomponenttocalculatevariousPhotovoltaicsperformancemetrics-

Inputs

PVsurface[Required]

InputplanarGrasshopper/RhinoSurface(notapolysurface)onwhichthePVmoduleswillbeapplied.Ifyouhaveapolysurface,explodeit(using"DeconstructBrep"component)andthenfeeditsFaces(F)outputto_PVsurface.Surfacenormalshouldbefacedtowardsthesun.

LadybugPrimer

174Photovoltaics_Performance_Metrics

OrcreatetheSurfacebasedoninitialPVsystemsizebyusing"PVSWHsystemsize"component.

PVsurfacePercent[Optional]

ThepercentageofsurfacewhichwillbeusedforPVmodules(range0-100).-Somecountriesandstates,havelocalcodeswhichlimittheportionoftheroof,whichcanbecoveredbycrystallinesiliconmodules.Forexample,thismayincludehavingsetbacks(distances)ofapproximatelly90cmfromsideandtopedgesofaroof,asafiresafetyregulation.-Ifnotsupplied,defaultvalueof100(allsurfaceareawillbecoveredinPVmodules)isused.

PVmoduleSettings[Optional]

ScriptvariablePhotovoltaicsPerformanceMetrics

ACenergyPerHour[Required]

Import"ACenergyPerYear"outputdatafrom"Photovoltaicssurface"component.InkWh.

totalRadiationPerHour[Required]

Import"totalRadiationPerHour"outputdatafrom"Photovoltaicssurface"component.InkWh/m2.

cellTemperaturePerHour[Required]

Import"cellTemperaturePerHour"outputdatafrom"Photovoltaicssurface"component.In°C.

ACenergyDemandPerHour[Optional]

Requiredelectricalenergyusedforanykindofload:heating,cooling,electriclights,solarwaterheatingcirculationpumpetc.Forexample,anyoftheHoneybee's"ReadEPResult"outputscanbeinputtedinhere.Eitherseparatelyorsummed.-Ifnothinginputted,thisinputwillbeneglected(thereisnorequiredelectricalenergy).InkWh.

energyCostPerKWh[Optional]

Thecostofonekilowatthourinanycurrencyunit(dollar,euro,yuan...)-Ifnotsupplied,0.15$/kWhwillbeusedasdefaultvalue.

embodiedEnergyPerM2[Optional]

Energynecessaryforanentireproductlife-cycleofPVmodulepersquaremeter.In

LadybugPrimer


MJ/m2(megajoulespersquaremeter).-Ifnotsupplieddefaultvalueof4410(MJ/m2)willbeused.

embodiedCO2PerM2[Optional]

CarbonemissionsproducedduringPVmodule'slife-cyclepersquaremeter..InkgCO2/m2(kilogramofCO2persquaremeter).-Ifnotsupplieddefaultvalueof225(kgCO2/m2)willbeused.

lifetime[Optional]

LifeexpectancyofaPVmodule.Inyears.-Ifnotsupplieddefaultvalueof30(years)willbeused.

gridEfficiency[Optional]

Anaverageprimaryenergytoelectricityconversionefficiency.-Ifnotsupplieddefaultvalueof29(%)willbeused.

optimal[Optional]

Setto"True"tocalculateoptimalPVsurfacearea.AnoptimalPVsurfaceareawillcover100%oftheoftheannualelectricityload("ACenergyDemandPerHour_").

runIt[Required]

...

Outputs

readMe!

...

optimalSystemSize

OptimalPVsystemsize(optimaltotalsizeofthePVarray)foragivenPVsurface'stilt,arrayand"ACenergyDemandPerHour".Minimumsystemsizeis0.01kW.Inputitto"systemSize"inputof"PVSWHsystemsize"componenttoseehowmuchareaitwouldrequire.-Tocalculateit,setthe"optimal_"inputto"True".-InthermalkiloWatts(kWt).

CUFperYear

CapacityUtilizationFactor(orCapacityFactororsometimesevancalledPlantLoadFactor(PLF))-ratiooftheannualACpoweroutputandmaximumpossibleoutputunderidealconditionsifthesunshonethroughoutthedayandthroughouttheyear.Itis

LadybugPrimer


sometimesusedbyinvestorsordevelopersforFinancialandMaintenanceanalysisofthePVsystems,insteadof"basicPRperYear".-Inpercent(%).

basicPRperYear

BasicPerformanceRatio-ratiooftheactualandtheoreticallypossibleannualenergyoutput.ItisworldwideacceptedstandardmetricformeasuringtheperformanceofthePVsystem,thereforitisusedforMaintenanceanalysisofPVsystems.UsedforMaintenanceanalysisofPVsystems.-basicPRismoreprecisethanupper"CUF"andshouldbeusedinsteadofit,unless"CUF"isspecificallyrequired.-Inpercent(%).

temperatureCorrectedPRperMonth

TemperaturecorrectedPerformanceRatio-ratiooftheactualandtheoreticallypossibleenergyoutputforeachmonthduringayear,correctedforPVmodule'sCelltemperature.Mid-dayhours(solarRadiation>0.6kWh/m2)onlytakenintoaccount.UsedforMaintenanceanalysisofPVsystems.-Inpercent(%).

temperatureCorrectedPRperYear

TemperaturecorrectedPerformanceRatio-ratiooftheactualandtheoreticallypossibleannualenergyoutput,correctedforPVmodule'sCelltemperature.Mid-dayhours(solarRadiation>0.6kWh/m2)onlytakenintoaccount.UsedforMaintenanceanalysisofPVsystems.-Itismoreprecisethanupper"basicPR"andshouldbeusedinsteadofit,unless"basicPR"isspecificallyrequired.-Inpercent(%).

energyOffsetPerMonth

PercentageoftheelectricitydemandcoveredbyPhotovoltaicssystemforeachmonthduringayear.-ItisusedforFinancialandMaintenanceanalysisofthePVsystem.-Inpercent(%).

energyOffsetPerYear

PercentageofthetotalannualelectricitydemandcoveredbyPhotovoltaicssystemforawholeyear.-ItisusedforFinancialandMaintenanceanalysisofthePVsystem.-Inpercent(%).

energyValue

TotalEnergyvalueforthewholeyearincurrencyunit(dollars,euros,yuans...)-ItisusedforFinancialanalysisofthePVsystem.

Yield

LadybugPrimer


RatioofannualACpoweroutputandnameplateDCpowerrating.ItisusedforFinancialanalysisofthePVsystems.-Inhours(h).

EROI

EnergyReturnOnInvestment-acomparisonofthegeneratedelectricitytotheamountofprimaryenergyusedthroughoutthePVmodule'sproductlife-cycle.-ItisusedforFinancialanalysisofthePVsystem.-Unitless.

embodiedEnergy

Totalenergynecessaryforanentireproductlife-cycleofPVmodules.-ItusedfortheLifeCycleanalysisofthePVsystem.-InGJ(gigajoules).

embodiedCO2

TotalcarbonemissionsproducedduringPVmodule'slife-cycle.-ItusedfortheLifeCycleanalysisofthePVsystem.-IntCO2(tonsofCO2).

CO2emissionRate

AnindexwhichshowshoweffectiveaPVsystemisintermsofglobalwarming.Itisusedincomparisonwithotherfuelsandtechnologies(Hydroelectricity(15),Wind(21),Nuclear(60),Geothermalpower(91),Naturalgas(577),Oil(893),Coal(955)...)-ItispartoftheLifeCycleanalysisofthePVsystem.-IngCO2/kWh.

EPBT

EnergyPayBackTime-timeittakesforPVmodulestoproducealltheenergyusedthrough-outitsproductlife-cycle.Afterthatperiod,theystartproducingzero-emissionsenergy.-ItisusedforLifeCycleanalysisofthePVsystem.-Inyears.

CheckHydraExampleFilesforPhotovoltaicsPerformanceMetrics

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Photovoltaics Performance Metrics

PhotovoltaicsSurface

UsethiscomponenttocalculateamountofelectricalenergythatcanbeproducedbyasurfaceifacertainpercentageofitiscoveredwithPhotovoltaics.ComponentbasedonNRELPVWattsv1fixedtiltcalculatorforcrystallinesilicon(c-Si)photovoltaics.-Sources:http://www.nrel.gov/docs/fy14osti/60272.pdfhttps://pvpmc.sandia.gov-

Inputs

epwFile[Required]

Input.epwfilepathbyusingthe"FilePath"parameter,orLadybug's"OpenEPWAnd

LadybugPrimer

179Photovoltaics_Surface


https://pvpmc.sandia.gov

STATWeatherFiles"component.

PVsurface[Required]

InputplanarGrasshopper/RhinoSurface(notapolysurface)onwhichthePVmoduleswillbeapplied.Ifyouhaveapolysurface,explodeit(using"DeconstructBrep"component)andthenfeeditsFaces(F)outputto_PVsurface.Surfacenormalshouldbefacedtowardsthesun.

OrcreatetheSurfacebasedoninitialPVsystemsizebyusing"PVSWHsystemsize"component.

PVsurfacePercent[Optional]

ThepercentageofsurfacewhichwillbeusedforPVmodules(range0-100).-Somecountriesandstates,havelocalcodeswhichlimittheportionoftheroof,whichcanbecoveredbycrystallinesiliconmodules.Forexample,thismayincludehavingsetbacks(distances)ofapproximatelly90cmfromsideandtopedgesofaroof,asafiresafetyregulation.-Ifnotsupplied,defaultvalueof100(allsurfaceareawillbecoveredinPVmodules)isused.-Inpercent(%).

DCtoACderateFactor[Optional]

FactorwhichaccountsforvariouslocationsandinstancesinaPVsystemwherepowerislostfromDCsystemnameplatetoACpower.Itrangesfrom0to1.ItcanbecalculatedwithLadybug's"DCtoACderatefactor"component.-Ifnotsupplied,defaultvalueof0.85willbeused.

PVmoduleSettings[Optional]

AlistofPVmodulesettings.Usethe"Photovoltaicsmodule"componenttogeneratethem.-Ifnotsupplied,thefollowingPVmodulesettingswillbeusedbydefault:

moduleType:Close(flush)roofmountmoduleEfficiency:15%temperatureCoefficient:-0.5%/°CmoduleActiveAreaPercent:90%

north[Optional]

InputavectortobeusedasatrueNorthdirection,oranumberbetween0and360thatrepresentstheclockwisedegreesofffromtheY-axis.-Ifnotsupplied,defaultNorthdirectionwillbesettotheY-axis(0degrees).

albedo[Optional]

LadybugPrimer


Alistof8767(withheader)or8760(withouttheheader)albedovaluesforeachhourduringayear.Albedo(orReflectioncoefficient)isanaverageratiooftheglobalincidentsolarradiationreflectedfromtheareasurroundingthePVsurface.Itrangesfrom0to1.-Itdependsonthetimeoftheyear/day,surfacetype,temperature,vegetation,presenceofwater,iceandsnowetc.-Ifnolistsupplied,defaultvalueof0.20willbeused,corrected(increased)forthepresenceofsnow(ifany).-Unitless.


AnoptionallistofhourlydatafromLadybug's"Importepw"component(e.g.dryBulbTemperature),whichwillbeusedfor"conditionalStatement_".


ThisinputallowsuserstocalculatethePhotovoltaicssurfacecomponentresultsonlyforthoseannualHourlyDatavalueswhichfitspecificconditionsorcriteria.Tousethisinputcorrectly,hourlydata,suchasdryBulbTemperatureorwindSpeed,mustbepluggedintothe"annualHourlyData"input.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<3"(without=""the=""quotation=""marks).=""conditionalStatement_=""accepts="""and"=""and="""or"=""operators.=""To=""visualize=""hourly=""data,=""English=""letters=""should=""be=""used=""as=""variables,=""each=""letter=""alphabetically=""corresponds=""to=""of=""lists=""(in=""their=""respective=""order):="""a"=""always=""represents=""1st=""list,="""b"=""2nd=""etc.=""-=""For=""example,=""if=""you=""have=""an=""dryBulbTemperature=""connected=""first=""windSpeed=""second=""list=""(both=""annualHourlyData_=""input),=""want=""plot=""data=""for=""time=""period=""when=""temperature=""is=""between=""18°C=""23°C,=""larger=""than=""3m=""s,=""written="""183"(withoutthequotationmarks).

runIt[Required]

...

Outputs

readMe!

...

ACenergyPerHour

ACpoweroutputforeachhourduringayear.-InkWh.

ACenergyPerYear

LadybugPrimer


TotalACpoweroutputforawholeyear.-InkWh.

averageDailyACenergyPerYear

AnaverageACpoweroutputperdayforawholeyear.-InkWh/day.

DCenergyPerHour

DCpoweroutputofthePVarrayforeachhourduringayear.-InkWh.

totalRadiationPerHour

TotalIncidentPOA(Planeofarray)irradianceforeachhourduringayear.-InkWh/m2.

moduleTemperaturePerHour

Module'sbacksurfacetemperatureforeachhourduringyear.-In°C.

cellTemperaturePerHour

Celltemperatureforeachhourduringyear.-In°C.

PVsurfaceTiltAngle

TheanglefromhorizontaloftheinclinationofthePVsurface.Example:0=horizontal,90=vertical.Itrangesfrom0-180.-Indegrees.

PVsurfaceAzimuthAngle

Theorientationangle(clockwisefromthetruenorth)ofthePVsurfacenormalvector.Itrangesfrom0-360.-Indegrees.

systemSize

DCratingofthePVsystem.-InkW.

CheckHydraExampleFilesforPhotovoltaicsSurface

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Photovoltaics Surface

SunpathShading

Thiscomponentcalculatestheshadingof:

PhotovoltaicmodulesSolarWaterHeatingcollectorsanyotherpurpose(shadingofpoints)-Use"annualShading","Sep21toMar21Shading"and"Mar21toSep21Shading"outputsforPhotovoltaicmodulesshading.Use"beamIndexPerHour"and"skyViewFactor"outputsforSolarWaterHeatingcollectorsshading,oranyotherpurpose.-"annualShading"outputisbasedon"UsingsunpathchartstoestimatetheeffectsofshadingonPVarrays",UniversityofOregon,FrankVignola:

LadybugPrimer

183Sunpath_Shading

http://solardat.uoregon.edu/download/Papers/UsingSunPathChartstoEstimatetheEffectofShadingonPVArrays.pdf-

Inputs

epwFile[Required]

Input.epwfilepathbyusingthe"FilePath"parameter,orLadybug's"OpenEPWAndSTATWeatherFiles"component.

analysisGeometry[Required]

Inputsurface(a)orpoint(b)(asingleoneormoreofthem).-a)InputplanarSurface(notpolysurface)onwhichthePVmodules/Solarwaterheatingcollectorswillbeapplied.Ifyouhaveapolysurface,explodeit(using"DeconstructBrep"component)andthenfeeditsFaces(F)outputtoanalysisGeometry.Surfacenormalshouldbefacedtowardsthesun.-b)Youcanalsosupplypoint(s)anditsshadingwillbecalculated.-Geometryinputtedto"_analysisGeometry",willbeaccountedforself-shading,sothereisnoneedtoinputittothe"context"also.

context[Optional]

Buildings,structures,mountainsandotherpermanentobstructions.-Ifyousuppliedsurface(s)tothe"analysisGeometry",inputthemintothe"context"too,toaccountforself-shading.Ifyouinputtedpoint(s)intothe"analysisGeometry",there'snoneedtoinputthemintothe"context".-Inputpolysurfaces,surfaces,ormeshes.

coniferousTrees[Optional]

Thisinputallowsforpartialshadingfromconiferous(evergreen)contexttrees.-Inputpolysurfaces,surfaces,ormeshes.

deciduousTrees[Optional]

Thisinputallowsforpartialshadingduringin-leafandleaf-lessperiodsfromdeciduouscontexttrees.In-leafbeingaperiodfrom21stMarchto21stSeptemberinthenorthernhemisphere,andfrom21stSeptemberto21stMarchinthesouthernhemisphere.Leaf-lessbeingaperiodfrom21stSeptemberto21stMarchinthenorthernhemisphere,andfrom21stMarchto21stSeptemberintheinthesouthernhemisphere.-Inputpolysurfaces,surfaces,ormeshes.

coniferousAllyearIndex[Optional]

Allyearroundtransmissionindexforconiferous(evergreen)contexttrees.Itrangesfrom

LadybugPrimer

184Sunpath_Shading

http://solardat.uoregon.edu/download/Papers/UsingSunPathChartstoEstimatetheEffectofShadingonPVArrays.pdf

0to1.0.0representsdeciduoustreeswhichdonotallowsolarradiationtopassthroughthem(100%shading).1representsallsolarradiationpassingthroughdeciduoustrees,likethetreesdonotexist(0%shading).-Ifnotsupplieddefaultvalueof0.30(equals70%shading)willbeused.-Unitless.

deciduousInleafIndex[Optional]

Deciduouscontexttreestransmissionindexforin-leafperiod.In-leafbeingaperiodfrom21stMarchto21stSeptemberinthenorthernhemisphere,andfrom21stSeptemberto21stMarchinthesouthernhemisphere.Itrangesfrom0to1.0.0representsdeciduoustreeswhichdonotallowsolarradiationtopassthroughthem(100%shading).1representsallsolarradiationpassingthroughdeciduoustrees,likethetreesdonotexist(0%shading).-Ifnotsupplieddefaultvalueof0.23(equals77%shading)willbeused.-Unitless.

deciduousLeaflessIndex[Optional]

Deciduouscontexttreestransmissionindexforleaf-lessperiod.Leaf-lessbeingaperiodfrom21stSeptemberto21stMarchinthenorthernhemisphere,andfrom21stMarchto21stSeptemberintheinthesouthernhemisphere.Itrangesfrom0to1.0.0representsdeciduoustreeswhichdonotallowsolarradiationtopassthroughthem(100%shading).1representsallsolarradiationpassingthroughdeciduoustrees,likethetreesdonotexist(0%shading).-Ifnotsupplieddefaultvalueof0.64(equals36%shading)willbeused.-Unitless.

leaflessPeriod[Optional]

DefinetheleaflessperiodfordeciduoustreesusingLadybug's"AnalysisPeriod"component.IMPORTANT!ThisinputaffectsonlytheskyViewFactor,beamIndexPerHour,shadedSolarRadiationPerHouroutput.Duetolimitationsoftheusedsunpathdiagram,itdoesnotaffecttheSep21toMar21Shading,Mar21toSep21Shading,annualShadingoutputs,wheredefaultleaflessperiods(seethelinebellow)willalwaysbeused.-Ifnotsuppliedthefollowingdefaultperiodswillbeused:from21stSeptemberto21stMarchinthenorthernhemisphere,andfrom21stMarchto21stSeptemberintheinthesouthernhemisphere.

ACenergyPerHour[Optional]

ThisinputisnecessatyonlyifyouarecalculatingtheshadingofthePVmodules.Ifthatisso,inputthe"ACenergyPerHour"outputdatafrom"Photovoltaicssurface"component.-Ifyouarecalculatingshadinganalysisfor"Solarwaterheatingsurface"component(insteadof"Photovoltaicssurface"component),leavethisinputempty.-Ifyouarecalculatingshadinganalysisforanyotherpurpose(ofpoint(s)forexample)

LadybugPrimer

185Sunpath_Shading

leavethisinputemptytoo.

north[Optional]


albedo[Optional]

Alistof8767(withheader)or8760(withouttheheader)albedovaluesforeachhourduringayear.Albedo(orReflectioncoefficient)isanaverageratiooftheglobalincidentsolarradiationreflectedfromtheareasurroundingthe_analysisGeometry.Itrangesfrom0to1.-Itdependsonthetimeoftheyear/day,surfacetype,temperature,vegetation,presenceofwater,iceandsnowetc.-Ifnolistsupplied,defaultvalueof0.20willbeused,corrected(increased)forthepresenceofsnow(ifany).-Unitless.

outputGeometryIndex[Optional]

Anindexofthesurfaceinputtedinto"_analysisGeometry"if"_analysisGeometry"wouldbeflattened..Itdeterminesthesurfaceforwhichoutputgeometrywillbegenerated.-Ifnotsupplied,geometryforthefirstsurface(index:0)willbegeneratedasadefault.

scale[Optional]

Scaleoftheoverallgeometry(sunPathcurves,sunWindowmesh).Usethescalenumberwhichenablesencompassingallofyourcontext,coniferousTrees,deciduousTrees_objects.-Ifnotsupplied,defaultvalueof1willbeused.

hoursPositionScale[Optional]

Scalefactorforpositioningofsolartimehourpoints(that's"hoursPositions"output).-Ifnotsupplied,defaultvalueof1willbeused.

precision[Optional]

Overallshadingprecision.Rangesfrom1-100.Itrepresentsthesquarerootnumberofshadinganalysispointspersunwindowquadrant.Example-precisionof20wouldbe400shadinganalysispointspersinglesunwindowquadrant.CAUTION!!!Higherprecisionnumbers(50>)requirestrongerperformancePCs.Ifyour"context"containsonlystraightshapebuildings/objects,andyouhavejustacoupleoftreessuppliedtothe"coniferousTrees"and"deciduousTrees_"inputs,theprecisionof<50willbejustfine.-Ifnotsupplied,defaultvalueof2willbeused.

legendPar[Optional]

LadybugPrimer

186Sunpath_Shading

OptionallegendparametersfromtheLadybug"LegendParameters"component.

bakeIt[Optional]

Setto"True"tobaketheSunpathshadingresultsintotheRhinoscene.-Ifnotsupplieddefaultvalue"False"willbeused.

runIt[Required]

...

Outputs

readMe!

...

skyViewFactor

ContinuousSkyViewFactor-portionofthevisiblesky(dome).Itdefinestheshadingofthepartsofdiffuseirradiance.Itrangesfrom0to1.0meansthattheskydomeiscompetelyobstructedbyobstaclesandallincomingdiffuseskyirradianceisblocked(100%shading).1meansthatskydomeiscompetelyfreeofobstacles(0%shading).-Thisoutputissimilarto"skyView"outputofLadybug's"ShadingMask"component.Unlike"skyView"ittakesintoaccounttransparencyoftrees.Butitdoesnotvisuallypresenttheshading,whichiswhat"ShadingMask"componentdoes.-UseitasaninputforLadybug"SolarWaterHeatingSystem"or"SolarWaterHeatingSystemDetailed"component's"skyViewFactor_"inputtoaccountfordiffuseirradianceshadingofSWHsurface.-Unitless.

beamIndexPerHour

Transmissionindexofbeam(direct)irradianceforeachhourduringayear.Itrangesfrom0-1.Transmissionindexof0means100%shading.Transmissionindexof1means0%shading.ItiscalculatedforeachanalysisGeometryvertexandthenaveraged.-UseitasaninputforLadybug"SolarWaterHeatingSystem"or"SolarWaterHeatingSystemDetailed"component's"beamIndexPerHour_"inputtoaccountfordiffusedirectbeamshadingofSWHsurface.-Unitless.

shadedSolarRadiationPerHour

Totalshadedincidenceforeachhourduringayear.-InkW/m2.

Sep21toMar21Shading

LadybugPrimer

187Sunpath_Shading

Weightedshadingoftheactivesunwindowquadrants,forperiodbetween21stSeptemberto21stMarch.ActivesunwindowquadrantsareonlythosewhichproduceACenergy.ItiscalculatedforeachanalysisGeometryvertexandthenaveraged.Itrangesfrom0-100(%).-Inpercent(%).

Mar21toSep21Shading

Weightedshadingoftheactivesunwindowquadrants,forperiodbetween21stMarchto21stSeptember.ActivesunwindowquadrantsareonlythosewhichproduceACenergy.ItiscalculatedforeachanalysisGeometryvertexandthenaveraged.Itrangesfrom0-100(%).-Inpercent(%).

annualShading

Annualweightedshadingoftheactivesunwindowquadrants.Tocalculateit,inputthehourlydatato"ACenergyPerHour"input.ActivesunwindowquadrantsareonlythosewhichproduceACenergy.ItiscalculatedforeachanalysisGeometryvertexandthenaveraged.Itrangesfrom0-100(%).-UseitasaninputforLadybug"DCtoACderatefactor"component's"annualShading"inputtoaccountforshadingofPVsurface.-Inpercent(%).

annalysisPts

Eachvertexoftheinputted_analysisGeometryforwhichaseparateshadinganalysiswasconducted.-ConnectthisoutputtoaGrasshopper's"Point"parameterinordertopreviewthe"annalysisPts"geometryintheRhinoscene.

sunWindowCenPt

Thecenterpointofthe"sunWindowCrvs"and"sunWindowMesh"geometry.ItiscalculatedforanalysisGeometryareacentroid.Usethispointtomove"sunWindowCrvs"and"sunWindowMesh"geometryaroundintheRhinoscenewiththegrasshopper's"Move"component.-ConnectthisoutputtoaGrasshopper's"Point"parameterinordertopreviewthe"annalysisPts"geometryintheRhinoscene.

sunWindowCrvs

Geometryofthesunwindowbasedon3Dpolarsunpathdiagram.Perpendicalcurvesrepresentsolartimehours.Horizontalarccurvesrepresentsunpathsfor:21stDecember,21stNovember/January,21stOctober/February,21stSeptember/March,21stAugust/April,21stJuly/May,21stJune.ThewholesunWindowCrvsgeometryoutputiscalculatedforanalysisGeometryareacentroid.

sunWindowMesh

LadybugPrimer

188Sunpath_Shading

Sunwindowmeshbasedon3Dpolarsunpathdiagram.ItiscalculatedforanalysisGeometryareacentroid.Blackareasrepresent100%shadedportionsofthesunwindow(ofbothactiveandinactivequadrants).Darkergreenandgreenareasrepresentpartiallyshadedportionsfromtheconiferousanddeciduoustrees,respectively.-ItiscalculatedONLYifdataissuppliedtothe"ACenergyPerHour_"input".

legend

AlegendofthesunWindowMesh.ConnectthisoutputtoaGrasshopper's"Geo"parameterinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePt

Legendbasepoint,whichcanbeusedtomovethe"legend"geometrywithgrasshopper's"Move"component.-ConnectthisoutputtoaGrasshopper's"Point"parameterinordertopreviewthe"annalysisPts"geometryintheRhinoscene.

quadrantCentroids

Centroidforeachsunwindowactivequadrantabovethehorizon.-Usegrasshopper's"Texttag"componenttovisualizethem.

quadrantShadingPercents

Shadingingpercentpereachsunwindowactivequadrantabovethehorizon.Activequadrantswithlessthan0.01%areneglected.-Usegrasshopper's"Texttag"componenttovisualizethem.

quadrantACenergyPercents

ACenergypercentpereachsunwindowactivequadrantabovethehorizon.-Usegrasshopper's"Texttag"componenttovisualizethem.

hoursPositions

Solartimehourpointpositions.-Usegrasshopper's"Texttag"componenttovisualizethem.

hours

Solartimehourstrings.-Usegrasshopper's"Texttag"componenttovisualizethem.

CheckHydraExampleFilesforSunpathShading

LadybugPrimer

189Sunpath_Shading

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Sunpath Shading

TiltAndOrientationFactor

ThiscomponentcalculatestheOptimalTilt,OptimalOrientationandTOF(TiltandOrientationFactor)forPVmodulesorSolarwaterheatingcollectors.TOFisasolarradiationattheactualtiltandorientationdividedbythesolarradiationattheoptimumtiltandorientation.-

Inputs

epwFile[Required]

Input.epwfilepathbyusingthe"FilePath"parameter,orLadybug's"OpenEPWAnd

LadybugPrimer

190Tilt_And_Orientation_Factor

STATWeatherFiles"component.

PV_SWHsurface[Required]

InputplanarGrasshopper/RhinoSurface(notapolysurface)onwhichthePVmodules/SWHcollectorswillbeapplied.Ifyouhaveapolysurface,explodeit(using"DeconstructBrep"component)andthenfeeditsFaces(F)outputto_PV_SWHsurface.Surfacenormalshouldbefacedtowardsthesun.

OrcreatetheSurfacebasedoninitialPV/SWHsystemsizebyusing"PVSWHsystemsize"component.

annualShading[Optional]

Lossesduetobuildings,structures,trees,mountainsorotherobjectsthatpreventsolarradiationfromreachingthePVmodule/Solarwaterheatingcollector.Inputrange:0to100(%),0beingunshaded,and100beingtotallyshadedPVmodule/SWHcollector.-Ifnotsupplieddefaultvalueof0(%)willbeused.

north[Optional]


albedo[Optional]


precision[Optional]

Representsthesquarerootnumberofanalysisfieldfortheoutput"geometry"mesh.Rangesfrom1-100.Example-precisionof4,wouldmeanthat4fieldsinXdirection(Azimuth)and4fieldsinYdirection(Tilt)=16fields,willbeusedtocalculatethefinal"geometry"mesh.Forlowerprecisionnumbers(say<20)evenprecisionnumbersaremoreaccurate.-CAUTION!!!Precisionnumbers(10>)requirestrongerperformancePCs.IfyourPCissomewhat"weaker",theprecisionof<10willbejustfine.-Ifnotsupplied,defaultvalueof2willbeused.

scale[Optional]

LadybugPrimer


Scaleoftheoverallgeometry.-Ifnotsupplied,defaultvalueof1willbeused.

origin[Optional]

Originforthefinal"geometry"output.-Ifnotsupplied,defaultpointof(-15,0,0)willbeused.

legendPar[Optional]

OptionallegendparametersfromtheLadybug"LegendParameters"component.

bakeIt[Optional]

Setto"True"tobaketheTiltandorientationfactorresultsintotheRhinoscene.-Ifnotsupplieddefaultvalue"False"willbeused.

runIt[Required]

...

Outputs

readMe!

...

TOF

TiltandOrientationFactor-solarradiationattheactualtiltandazimuthdividedbythesolarradiationattheoptimumtiltandazimuth.Inpercent(%).

TSRF

TotalSolarResourceFraction-theratioofsolarradiationavailableaccountingforbothannualshadingandTOF,comparedtothesolarradiationavailableatagivenlocationattheoptimumtiltandazimuthandwithnoshading.Calculatedaccordingtothefollowingequation:TSRF=TOF*(100-annualShading)/100SomeUSAstates,likeOregonandWashingtonrequireTSRFtobeminimum75%inorderforthePVsystemtobeapplicableforincentiveprograms.-Inpercent(%).

PVsurfaceTilt

TiltangleoftheinputtedPV_SWHsurface.Indegrees(°).

PVsurfaceAzimuth

LadybugPrimer


OrientationangleoftheinputtedPV_SWHsurface.Indegrees(°).

optimalTilt

OptimaltiltofthePV_SWHsurfaceforagivenlocation.Optimaltiltbeingtheonethatreceivesthemostannualsolarradiation.Indegrees(°).

optimalAzimuth

OptimalorientationofthePV_SWHsurfaceforagivenlocation.Optimalazimuthbeingtheonethatreceivesthemostannualsolarradiation.Indegrees(°).

optimalRoofPitch

OptimalsteepnessofthePV_SWHsurfaceforagivenlocation.Optimalsteepnessbeingtheonethatreceivesthemostannualsolarradiation.Ininches/inches

optimalRadiation

TotalsolarradiationpersquaremeterforawholeyearreceivedonaPV_SWHsurfaceofoptimaltiltandazimuth,atgivenlocation.InkWh/m2

geometry

GeometryofthewholeTOFmeshchart.ConnectthisoutputtoaGrasshopper's"Geo"parameterinordertopreviewthe"geometry"separatelyintheRhinoscene.

originPt

Theoriginpointofthe"geometry"output.Usethispointtomove"geometry"outputaroundintheRhinoscenewiththegrasshopper's"Move"component.

analysisPt

ApointindicatinginputtedPV_SWHsurface'sTilt/Azimuthpositiononthesolarradiationtable.

legend

Alegendfortheannualtotalsolarradiation(inkWh/m2).ConnectthisoutputtoaGrasshopper's"Geo"parameterinordertopreviewthelegendseparatelyintheRhinoscene.

legendBasePt

Legendbasepoint,whichcanbeusedtomovethe"legend"geometrywithgrasshopper's"Move"component.

LadybugPrimer


CheckHydraExampleFilesforTiltAndOrientationFactor

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Tilt And Orientation Factor

ForwardRaytracing

Usethiscomponenttogetasenseofhowsunlightisreflectedbyasetofcontextgeometriesbytracingsunraysforwardsthroughthisgeometry.Exampleswherethiscomponentmightbeusefulincludetheevaluationofthediffusionoflightbyalightshelf,ortestingtoseewhetheraparabolicbuildinggeometry(likeaGherybuilding)mightfocussunlighttodangerouslevelsatcertaintimesoftheyear.Notethatthiscomponentassumesthatallsunlightisreflectedoffofthesegeometriesspecularly(asiftheywereamirror)and,formoredetailedraytraceanalysis,theHoneybeedaylightcomponentsshouldbeused.-

Inputs

LadybugPrimer

195Forward_Raytracing

startPts[Required]

Pointsfromwhichthesunrayswillbecasttowardsthe_contextgeometry.Youmaywanttoconnectagridofpointsheretomimicthefactthatdirectsunwillbestreamingevenlyfromthesky.

startVectors[Required]

AsunvectorfromthesunPathcomponentoralistofsunvectorstobeforwardray-traced.

context[Required]

Brepsormeshesofconextgeometrythatwillreflectthesunrays.Notethat,forcurvedsurfaces,smoothmeshesofthegeometrywillbemoreaccuratethaninputingaBrep.

numOfBounce[Default]

Anintergerrepresentingthenumberofraybouncestotracethesunraysforward.

lastBounceLen[Default]

AfloatnumberrepresentingthelengthinRhinomodelunitsofthelightrayafterthelastbounce.

Outputs

rays

Aseriesoflinecurvesrepresentinglightraystracedforwardthroughthegeometry.

CheckHydraExampleFilesforForwardRaytracing

LadybugPrimer

196Forward_Raytracing

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Forward Raytracing

SolarEnvelopeBasic

Usethiscomponenttogenerateasolarenvelopeforaclosedboundarycurvewithminimuminputs.Thiscomponentpredefinesmonthlyandhourlyrangesinordertosimplifythecreationofusefulenvelopegeometry.Thesolarenvelopeisusedtoensurethatitsadjacentneighbors(definedasanythingoutsideofthechosenboundarycurve)willreceiveaspecifiedminimumhoursofdirectsolaraccessforeachdayinaspecifiedmonthrangeoftheyear.Anygeometrybuiltwithinthesolarenvelopeboundarieswillthereforenotcastanyshadowonadjacentpropertyforthegivenhourandmonthrange.Thestartandenddatesthatdeterminethemonthrangeforsolaraccesscanbechosenfromthefollowingoptions:0)Mar21-Jun211)Mar21-Sep212)Mar21-Dec213)Jun21-Sep214)Jun21-Dec215)Sep21-Dec21Thedefault

LadybugPrimer

197SolarEnvelopeBasic

setto4)June21toDecember21.Reference:Niemasz,J.,Sargent,J.,ReinhartD.F.,"SolarZoningandEnergyinDetachedResidentialDwellings,"ProceedingsofSIMAUD2011,Boston,April2011.-

Inputs

boundary[Required]

Aclosedboundarycurverepresentingapieceofland(suchasapropertytobedeveloped)forwhichsolaraccessofthesurroundinglandisdesired.

location[Required]


requiredHours[Required]

Thenumberofhoursofdirectsolaraccessthatthepropertysurroundingtheboundarycurveshouldreceiveduringthe_monthRange.Forexampleaninputof4willdefinethehourrangeroughlybetween10AMand2PM.Thecomponentwillcomputethehourrangethatwillmaximizetheenvelopevolume.

north[Optional]


monthRange[Required]

Anoptionalintergervaluetochangethemonthrangeforwhichsolaraccessisbeingconsidered.ThedefaultmonthrangeisJun21-Dec21.

Integersinputheremustbebetween0-5andcorrespondtothefollowing:0=Mar21-Jun211=Mar21-Sep212=Mar21-Dec213=Jun21-Sep214=Jun21-Dec21

5=Sep21-Dec21

LadybugPrimer


Where,intheNorth/SouthHemispheres,thesedatesrepsectivelysignify:Mar21=Vernal/AutumnalEquinoxJun21=Summer/WinterSolsticeSep21=Autumnal/VernalEquinoxDec21=Winter/SummerSolstice

Outputs

readMe!

...

solarEnvelope

ABreprepresentingasolarenvelope.Thisvolumeshouldbebuiltwithininordertoensurethatthesurroundingpropertyisnotshadedforthegivennumberofhours.

CheckHydraExampleFilesforSolarEnvelopeBasic

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_SolarEnvelopeBasic

SolarFanBasic

Usethiscomponenttogenerateasolarfanwithminimumalinputdata.Thiscomponentpredefinesmonthlyandhourlyrangesinordertosimplifythecreationofusefulfangeometry.Thesolarfanisusedtoensurethatagivenpropertywithinaboundarycurveisguarenteedaspecifiedminimumhoursofdirectsolaraccessforeachdayinaspecifiedmonthrangeoftheyear.Thus,contextgeometriessurroundingthisboundarycurvethatdonotpenetratethesolarfanwillnotcastshadowsontotheboundaryareaforthespecifiedhourandmonthrange.Thestartandenddatesthatdeterminethemonthrangeforsolaraccesscanbechosenfromthefollowingoptions:0)Mar21-Jun211)Mar21-Sep212)Mar21-Dec21

LadybugPrimer

200SolarFanBasic

3)Jun21-Sep214)Jun21-Dec215)Sep21-Dec21Thedefaultsetto3)June21toSeptember21.Notethatextremelycomplicatedconcaveshapeswilltakealongtimetocalculateasolarfanfor.-

Inputs

boundary[Required]

closedboundarycurverepresentingapieceofland(suchasapark)orawindowforwhichsolaraccessisdesired.

location[Required]


requiredHours[Required]

Thenumberofhoursofdirectsolaraccessthatthepropertyinsidetheboundarycurveshouldreceiveduringthe_monthRange.Forexampleaninputof4willdefinethehourrangeroughlybetween10AMand2PM.Thecomponentwillcomputethehourrangethatwillmaximizethefanvolume.

height[Required]

ThenumberofRhinomodelunitsthatthesolarfanshouldbeextendedabovetheboundarycurve.

north[Optional]


monthRange[Required]

Anoptionalintergervaluetochangethemonthrangeforwhichsolaraccessisbeingconsidered.ThedefaultmonthrangeisJun21-Sep21.

Integersinputheremustbebetween0-5andcorrespondtothefollowing:0=Mar21-Jun211=Mar21-Sep212=Mar21-Dec213=Jun21-Sep214=

LadybugPrimer

201SolarFanBasic

Jun21-Dec21

5=Sep21-Dec21Where,intheNorth/SouthHemispheres,thesedatesrepsectivelysignify:Mar21=Vernal/AutumnalEquinoxJun21=Summer/WinterSolsticeSep21=Autumnal/VernalEquinoxDec21=Winter/SummerSolstice

Outputs

out

...

solarFan

Breprepresentingasolarfan.Thisvolumeshouldbeclearofshadinginordertoensuresolaraccesstotheareainsidetheboundarycurveforthegivennumberofhours.

CheckHydraExampleFilesforSolarFanBasic

LadybugPrimer

202SolarFanBasic

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_SolarFanBasic

Componentlist:

Mesh-To-Hatch

North

Recolor_Mesh

True_North

Adaptive_Comfort_Parameters

Body_Characteristics

Gradient_Library

Legend_Parameters

PMV_Comfort_Parameters

Passive_Strategy_List

Real_Time_Radiation_Analysis

Capture_View

Orient_to_Camera

Set_the_View

fly

C2F

DOY_HOY

Day_Month_Hour

F2C

Activities_Met_List

BTU2Wh


Comfort_Mannequin

Construct_Time

Create_Legend

L2G

Orientation_Study_Parameters

Passive_Strategy_Parameters

Shading_Parameters_List

Wh2BTU

LadybugPrimer

2034|Extra

Wh2kWh

kWh2Wh

ms2mph

rIP2rSI

uIP2uSI

LadybugPrimer

2044|Extra

Mesh-To-Hatch

UsethiscomponenttobakeacloredmeshintotheRhinosceneasaseriesofcoloredhatches.ThisisparticularlyusefulifyouaretryingtoexportladybuggraphicsfromRhinotovector-basedprogramslikeInkscapeorIllustrator.-

Inputs

mesh[Required]

Acoloredmesh(orlistofcoloredmeshes)thatyouwouldliketobakeintotheRhinosceneasaseriesofcoloredhatches.

LadybugPrimer

205Mesh-To-Hatch

runIt[Required]

Setto'True'toruntorunthecomponentandbakethemeshintothesceneasaseriesofhatches.

Outputs

readMe!

...

CheckHydraExampleFilesforMesh-To-Hatch

LadybugPrimer

206Mesh-To-Hatch

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Mesh-To-Hatch

North

UsethiscomponenttocreateacompasssignthatindicatesthedirectionofNorthintheRhinoscene.-

Inputs

north[Default]

InputavectortobeusedasaNorthdirectionoranumberbetween0and360thatrepresentsthedegreesofffromthey-axistomakeNorth.ThedefaultNorthdirectionissettotheY-axis(0degrees).

LadybugPrimer

207North

centerPt[Default]

InputapointheretochangethelocationoftheNorthsignintheRhinoscene.ThedefaultissettotheRhinomodelorigin(0,0,0).

scale[Default]

Inputanumberheretochangethescaleofthesunpath.Thedefaultissetto1.

Outputs

northSign

AsetofsurfacesandcurvesthatindicatethedirectionofNorthinRhino.

CheckHydraExampleFilesforNorth

LadybugPrimer

208North

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_North

RecolorMesh

Usethiscomponenttore-colorameshwithnewanumericaldatasetwhoselengthcorrespondstothenumberoffacesinthe_inputMesh.Thiscomponentisusefulifyouhavepost-processedanyofthenumericaldataoutoftheLadybugcomponentsusingGrasshoppermathcomponents.ItisalsonecessarytoviewresultsfromtheLadybugRealTimeRadiationAnalysis.-

Inputs

analysisResult[Required]

LadybugPrimer

209Recolor_Mesh

Anumericaldatasetwhoselengthcorrespondstothenumberoffacesinthe_inputMesh.Thisdatawillbeusedtore-colorthe_inputMesh.

inputMesh[Required]

Analready-coloredmeshfromoneoftheLadybugcomponentswhichyouwouldliketore-colorbasedondatainthe_analysisResult.

heightDomain[Optional]

Optionalheightdomaintocreatea3Dmeshresult.UseConstructDomaincomponenttocreateadomain

legendPar[Optional]

OptionallegendparametersfromtheLadybugLegendParameterscomponent.LegendParameterscanbeusedtochangethecolors,numericalrange,and/ornumberofdivisionsofanyLadybuglegendalongwiththecorrespondingcoloredmesh.

analysisTitle[Optional]

Textrepresentinganewtitleforthere-coloredmesh.Ifnotitleisinputhere,thedefaultwillread"unnamed."

legendTitle[Optional]

Textrepresentinganewlegendtitleforre-coloredmesh.Legendsareusuallytitledwiththeunitsofthe_analysisResult.Ifnotextisprovidedhere,thedefaulttitlewillread"unkownunits."

bakeIt[Optional]

Setto"True"tobaketheresultingmeshandlegendintotheRhinoscene.

layerName[Optional]

IfbakeIt_issetto"True",inputTextherecorrespondingtotheRhinolayerontowhichtheresultingmeshandlegendshouldbebaked.

Outputs

readMe!

...

newMesh

LadybugPrimer

210Recolor_Mesh

Anewmeshthathasbeenre-coloredbasedonthe_analysisResultdata.

newLegend

AnewlegendthatthatcorrespondstothecolorsofthenewMesh.Connectthisoutputtoagrasshopper"Geo"componentinordertopreviewthislegendseparatelyintheRhinoscene.

legendBasePt

Thelegendbasepoint,whichcanbeusedtomovethelegendinrelationtothenewMeshwiththegrasshopper"move"component.

meshColors

ScriptvariablereColorMesh

legendColors

ScriptvariablereColorMesh

CheckHydraExampleFilesforRecolorMesh

LadybugPrimer

211Recolor_Mesh

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Recolor Mesh

TrueNorth

UsethiscomponenttocalculateEarth'struenorthfrommagneticnorth.-IfyouareworkingwithlocationplangeneratedbyGoogleMapsoranyotherwebmappingservice,NorthwillalwaysbepositionedindirectionofRhino'sYaxis.IncaseyouimportedalocationplantoRhino,whichhasaNorthdirectionassignedinaformofmagneticNorth,thenyouneedtocorrectthatNorthdirectionfortheinfluenceofEarth'smagneticvariation.Whichiswhatthiscomponentdoes.-AllcreditgoestoChristopherWeiss([email protected]),theauthoroftheWorldMagneticModelpythoncode.source:https://pypi.python.org/pypi/geomag-BasedonWorldMagneticModeloftheNOAA:http://www.ngdc.noaa.gov/geomag/WMM/DoDWMM.shtml-

LadybugPrimer

212True_North

https://pypi.python.org/pypi/geomag

http://www.ngdc.noaa.gov/geomag/WMM/DoDWMM.shtml

Inputs

location[Required]

InputdatafromLadybug's"Importepw""location"output,orcreateyourownlocationdatawithLadybug's"ConstructLocation"component.

magneticNorth[Optional]

InputavectortobeusedasamagneticNorthdirection,oranumberbetween0and360thatrepresentstheclockwisedegreesofffromtheY-axis.Magneticnorthdirectionisdirectionacompass-needlepointsto.-Ifnotsupplied,defaultNorthdirectionwillbesettotheY-axis(0degrees).

date[Optional]

Dateforwhichmagneticnorthshouldbecalculated.Inputadateinthefollowingorder:month,day,year.Example"5,24,2016"(24ndMay2016).-Ifnotsupplied,presentdatewillbeused.

COFfile[Optional]

Bydefault"Magneticnorth"componentalreadyhas2015-2020integratedWMMcoefficientsdata.Incaseyouwouldliketoanalysisperiodsoftimebeforetheyear2015,inputanappropriateWMM.COFfilepathinhere.-Ifnotsupplied,integratedWMM.COF2015-2020coefficientsdatawillbeused.

Outputs

readMe!

...

trueNorth

Geographicnorth(directiontowardstheNorthPole)-magneticnorthcorrectedforthevalueofmagneticdeclination.Rangesfrom0-360.-Indecimaldegrees(°).

trueNorthVec

Vectorrepresentationoftheupper"trueNorth".

magneticDeclination

Ananglebetweenmagneticnorthandtruenorth.Itispositiveeastoftruenorthandnegativewestoftruenorth.-Indecimaldegrees(°).

LadybugPrimer

213True_North

magneticFieldVec

Earth'smagneticfieldvectoratchosenlocation.Vector'sintensityrepresentsthestrengthinnanoTeslas(nT).

CheckHydraExampleFilesforTrueNorth

LadybugPrimer

214True_North

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_True North

AdaptiveComfortParameters

UsethiscomponenttosetAdaptivecomfortparametersfortheAdaptiveComfortCalculatorortheAdaptiveComfortChart.ParametersincludetheabilitytouseeitherUS(ASHRAE)orEuropean(EN)standardsaswellassettheacceptabilitythresholdforthepercentoftheoccupantsthatarecomfortable(whichvariesfordifferentbuildingtypesbetweenthetwostandards).Thiscomponentalsoincludestheabilitytosetacustomcorrelationbetweenoutdoortemperatureandindoordesiredtemperatureusinga'levelOfConditioning'variableandresearchthatisnotanofficialpartoftheASHRAEorENstandardsbutisendorsedbymanyofthescientistswhohelpedcreatethesestandards.Detailedinformationonalloftheseparametersisdescribedinthisbook:FergusNicol,MichaelHumphreys,SusanRoaf.AdaptiveThermalComfort:Principles

LadybugPrimer

215Adaptive_Comfort_Parameters

andPractice.Routledge,2012.(https://books.google.com/books?id=vE7FBQAAQBAJ&dq=adaptive+thermal+comfort)Usersarealsoencouragedtousethe'Ladybug_AdaptiveComfortChart'componentortheCenterfortheBuiltEnvironment's(CBE)comforttooltohelpvisualizethedifferencesbetweentheseparameters:SpecialthanksgoestotheauthorsoftheonlineCBEThermalComfortToolwhofirstcodedthejavascript:HoytTyler,SchiavonStefano,PiccioliAlberto,MoonDustin,andSteinfeldKyle.http://cbe.berkeley.edu/comforttool/-

Inputs

ASHRAEorEN[Optional]

Setto'True'tohavetheAdpativecomponentsusetheUS(ASHRAE552013)adaptivestandardandsetto'False'tohavetheAdaptivecomponentsusetheEuropean(EN-15251)standard.ThedefaultissettousetheUS(ASHRAE552013)standard.Notethatchangingthestandardwillalsochangesomeoftheinputsbelow.TheASHRAEstandardwillusetheaveragemonthlytemperaturebydefaultandtheEuropeanstandardwillusearunningmeantemperaturebydefault.Also,theEuropeanstandardusesbuildingclassesinsteadof80/90percentacceptability.

eightyOrNinetyComf[Optional]

Setto'True'tohavethecomfortstandardbe80percentofoccupantscomfortableandsetto'False'tohavethecomfortstandardbe90percentofalloccupantscomfortable.Thedefaultissetto'False'for90percent,whichiswhatmostmembersofthebuildingindustryseemtoaimforintoday'sworld.Howeversomeprojectswilloccasionallyuse80%asthiswasoriginallythebenchmarkthatengineerssetaroundthedawnofairconditioning.

avgMonthOrRunMean[Optional]

Setto'True'tohavetheAdpativecomponentscomputetheprevailingoutdoortemperaturefromtheaveragemonthlytemperature(theofficialmethodusedbytheUS'sASHRAE552013)andsetto'False'computetheprevailingoutdoortemperaturefromaweightedrunningmeanofthelastweek(theofficialmethodusedbyEurope'sEN-15251).Thedefaultissettoalignwiththechosencomfortstandardabove(eitherASHRAE552013orEN-15251)butthisoptionisincludedtoallowuserstoexploredifferencesandvariationsbetweenthetwostandards.

levelOfConditioning[Optional]

Anoptionalnumberbetween0and1thatrepresentshow'airconditioned'aspaceis.Bydefault,thisvalueisalwayssetto0becauseboththeASHRAE552013andEN-

LadybugPrimer


https://books.google.com/books?id=vE7FBQAAQBAJ&dq=adaptive+thermal+comfort


15251standardsarestrictlymeanttobeusedforbuildingswithoutanyinstalledairconditioningwhatsoever.However,theresearcherswhodevelopedtheoriginalAdaptivemodelsalsosurveyedmanypeopleinconditionedbuildingstoshowthattheadaptivemodeldidnotcontradictthePMVmodelwhenitwasappliedtobuildingsthatresembledtheconditionedclimatechamberusedtovalidatethePMVmodel.Fromthesesurveysoffully-conditionedbuildings,researchersproducedacorrelationbetweenprevailingoutdoortemperatureanddesiredindoortemperaturethathadamuchshallowerslopethanthatforfullynaturally-ventilatedbuildings.Thisinputallowsyoutousethisfullyconditionedcorrelation(bysettingthisinputto1)orcreateanycustomcorrelationinbetweenthesetwo(arguablyrepresentativeofmixed-modeorhybridAC/naturallyventilatedbuildings).TheconditionedbuildingcorrelationusedintheLadybugAdaptivemodelcanbefoundinthebookrefencedinthecomponentdescriptionandspecificallycomesfromthisstudy:CIBSE(2006)EnvironmentalCriteriaforDesign,Chapter1:EnvironmentalDesign:CIBSEGuideA.London:CharteredInstitutionofBuildingServicesEngineers.

Outputs

comfortPar

Comfortparametersthatyoucanplugintoeitherthe"Ladybug_AdaptiveComfortCalculator"orthe"Ladybug_AdaptiveComfortChart."

CheckHydraExampleFilesforAdaptiveComfortParameters

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Adaptive Comfort Parameters

BodyCharacteristics

UsethiscomponenttocalculatetheBasalMetabolicRate,BodyMassIndexindicesandtocreatethe"bodyCharacterstics_"inputforthe"Thermalcomfortindices"component.-BasalMetabolicRateformulabyMifflin-St.Jeor.BodyMassIndexformulabyAdolpheQuetelet.-Formulasfrom:"ComparisonofpredictiveequationsforrestingMetabolicrateinhealthynonobeseandobeseadults:asystematicreview",Frankenfield,Roth-Yousey,Compher,AmericanDieteticAssociation,2005.:https://www.andeal.org/files/Docs/Frankenfield_et_al_2005%5B1%5D.pdf-

Inputs

LadybugPrimer

218Body_Characteristics

https://www.andeal.org/files/Docs/Frankenfield_et_al_2005%5B1%5D.pdf

age[Optional]

Anageoftheperson.-Ifnotsupplied,defaultvalueof35willbeused.-Inyears.

sex[Optional]

Person'ssex.-1or"male"2or"female".-Ifnotsupplied,"male"willbeusedasadefaultvalue.

height[Optional]

Person'sheight.-Ifnotsupplieddefaultvalueof175cmwillbeused.-Incentimetres.

weight[Optional]

Person'sweight.-Ifnotsupplieddefaultvalueof75kgwillbeused.-Inkilograms.

bodyPosition[Optional]

Positionofperson'sbody.-1or"sitting"forsittingposition.2or"standing"forstandingposition.3or"crouching"forcrouchingposition.-Ifnotsupplied,2(standing)willbeusedasadefaultvalue.

clothingInsulation[Optional]

Clothinginsulationofapersonin"clo"units.Itrangesfrom0(nudeperson)to4(polaroutfit).Overallclovaluecanbedeterminedbyaddingindividualclovaluesforeachtypeofclothes,basedonaclovaluestable(http://www.engineeringtoolbox.com/clo-clothing-thermal-insulation-d_732.html)Amoresimplifiedapprochwouldbe:-0.20-verylightsummerclothes(shorts/skirt,t-shirt,slippers,nosocks)0.55-summerclothes(lighttrousers,shortsleevesorblouse)1-street-businesssuitorTypicalindoorwinterclothing1.5-suitandcottoncoat2-wintersuitandcoat2.58-firefightingclothes4-heavypolaroutfit(furpants,coat,hood,gloves...)-Ifnotsupplieditwillbecaclulatedforeachhourbasedonairtemperature,withminimal0.5andmaximal4.1clovalues.-Inclo.

clothingAlbedo[Optional]

Averageclothingandskinalbedoofaperson.Rangesfrom0to100%.Intheoryclothes-skinalbedoof0wouldabsorb,while100%willreflectallsolarradiation.Someoftheexamples:-lightcolored(whiteandbrightclothes)-57%darkcolored(blackandgrayclothes)-21%mediumcolored(anyclothescolorsbetweenuppertwo)-37%protectivepolyethylene/aluminiumsuits-95%-Ifnotsupplied37%(mediumcolored)willbeusedasadefault.-Inpercent.

LadybugPrimer


http://www.engineeringtoolbox.com/clo-clothing-thermal-insulation-d_732.html

acclimated[Optional]

Determinewhetherthetestpersonhadpreviouslyexperiencedheat/coldstress.-"acclimated"orTrueifpersoninsubjectisacclimatized,"unacclimated"orFalseifit'snot.-Ifnovalueissupplied,True(acclimated)willbeusedbydefault.


Activity'smetabolicrateinmets.Ifnotsupplied2.32willbeusedasdefaultvalueHerearesomeoftheexamplesofmetabolicratesmetsbasedonactivity:

Activity-metReclining-0.8Seating-1.0Cardriving-1.2Sedentaryactivity(office,dwelling,school,laboratory)-1.2Standing-1.2Standing(lightactivity:shopping,laboratory,lightindustry)-1.6Standing(mediumactivity:shopassistant,domesticwork)-2.0Walking(4km/h)-2.32Walking(5km/h)-3.4...Washingdishesstanding-2.5Domesticwork(rakingleavesonthelawn)-2.9Domesticwork(washingbyhandandironing)-2.9Ironandsteel(rammingthemouldwithapneumatichammer)-3.0Buildingindustry(bricklaying)-2.2Buildingindustry(formingthemould)-3.1Buildingindustry(loadingawheelbarrowwithstonesandmortar)-4.7Forestry(cuttingwithchainsaw)-3.5Forestry(workingwithanaxe)-8.5Agriculture(diggingwithaspade)-6.5...Volleyball-4.0Golf-5.0Softball-5.0Gymnastics-5.5AerobicDancing-6.0Swimming-6.0Iceskating-6.2Bicycling(15km/h)-4.0Bicycling(20km/h)-6.2Skiing(9km/h)-7.0Backpacking-7.0Basketball-7.0Handball-8.0Hockey-8.0Racquetball-8.0Soccer-8.0Running(8km/h)-8.5Running(15km/h)-9.5-Ifnotsupplieddefaultvalueof2.32(walking4km/hor1.1m/s)metswillbeused.-Inmets.

activityDuration[Optional]

Durationoftheactivitysequence.Itshouldnotbelowerthan180minutes(3hours)anditshouldbedividablewith60(meaningonlyfullhourvaluesareaccepted:180,240,300,360,420,480,540...)-Ifnotsupplied,defaultvalueof480minutes(8hours)willbeused.-Inminutes.

Outputs

readMe!

...

BMR

LadybugPrimer


BasalMetabolicRate-representstheminimumdailyamountofenergyneededtokeepyourbodyfunctioning,includingbreathingandkeepingyourheartbeating,withoutlossingweight.Itdoesnotincludethethecaloriesyouburnfromnormaldailyactivitiesorexercise.Toaccountfordailyactivitiesandexercises,thisBMRvalueneedstobemultipliedwith:-1.2-Lightornoexerciseanddeskjob1.375-Lightexerciseorsports1-3daysaweek1.55-Moderateexerciseorsports3-5daysaweek1.725-Hardexerciseorsports6-7daysaweek1.9-Harddailyexerciseorsportsandphysicaljob-Oncethepersonknowsthenumberofdailycaloriesneededtomaintainitsweight,itcaneasilycalculatethenumberofcaloriesitneedstoeatinordertogainorloseweight.Incalories/day.

BMI

BodyMassIndex-istheratioofthepersonsweighttosquareofheight.Itisgenerallyusedasamethodofscreeningforweightcategory.Inkg/m2.

BMILevel

LevelofBMIforadult(18yearsandolder)malesandfemales:

formales:BMI<17.5-Anorexia17.5<BMI<20.7-Underweight20.7<BMI<26.4-Normalweight26.4<BMI<27.8-Marginallyoverweight27.8<BMI<31.1-Overweight31.1<BMI<40-ObeseBMI>40-Extremeobesity-forfemales:BMI<17.5-Anorexia17.5<BMI<19.1-Underweight19.1<BMI<25.8-Normalweight25.8<BMI<27.3-Marginallyoverweight27.3<BMI<32.3-Overweight32.3<BMI<40-ObeseBMI>40-Extremeobesity-Incalories/day.

bodyCharacteristics

Alistofinputtedvalues(age,sex,height,weight,bodyPosition,clothingInsulation,acclimated,metabolicRate,activityDuration).-Useitforthe"Thermalcomfortindices"component's"bodyCharacteristics_"input.

CheckHydraExampleFilesforBodyCharacteristics

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Body Characteristics

GradientLibrary

UsethiscomponenttoaccessalibraryoftypicalgradientsusefulthroughoutLadybug.TheoutputfromthiscomponentshouldbepluggedintothecustomColorsinputofthe"Ladybug_LegendParameters"component.Foranimageofeachofthegardientsinthelibrary,checkhere:https://github.com/mostaphaRoudsari/ladybug/blob/master/resources/gradients.jpg-

Inputs

gradIndex[Required]

LadybugPrimer

222Gradient_Library

https://github.com/mostaphaRoudsari/ladybug/blob/master/resources/gradients.jpg

Anindexreferingtooneofthefollowingpossiblegradients:0-OrignalLadybug1-NuancedLadybug2-Multi-coloredLadybug3-ViewAnalysis14-ViewAnalysis2(Red,Green,Blue)5-SunlightHours6-Ecotect7-ThermalComfortPercentage8-ThermalComfortColors9-ThermalComfortColors(UTCI)10-HotHours11-ColdHours12-ShadeBenefit/Harm13-ThermalComfortColorsv2(UTCI)14-ShadeHarm15-ShadeBenefit16-BlacktoWhite17-CFDColors118-CFDColors219-EnergyBalance20-THERM21-CloudCover

Outputs

customColors

Aseriesofcolorstobepluggedintothe"Ladybug_LegendParameters"component.

CheckHydraExampleFilesforGradientLibrary

LadybugPrimer

223Gradient_Library

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Gradient Library

LegendParameters

Usethiscomponenttochangethecolors,numericalrange,and/ornumberofdivisionsofanyLadybuglegendalongwiththecorrespondingcoloredmeshthatthelegendrefersto.Thiscomponentcanalsomovealegendandchangeitsscale.AnyLadybugcomponentthatoutputsacoloredmeshandalegendwillhaveaninputthatcanacceptLegendParametersfromthiscomponent.ThiscomponentparticularlyhelpfulinmakingthecolorsofLadybuggraphicsconsistentforapresentationorforsynchonizingthenumericalrangeandcolorsbetweenLadybuggraphics.-

Inputs

LadybugPrimer

224Legend_Parameters

lowBound[Optional]

Anumberrepresentingthelowerboundaryofthelegend'snumericalrange.Thedefaultissettothelowestvalueofthedatastreamthatthelegendrefersto.

highBound[Optional]

Anumberrepresentingthehigherboundaryofthelegend'snumericalrange.Thedefaultissettothehighestvalueofthedatastreamthatthelegendrefersto.

numSegments[Optional]

Anintergerrepresentingthenumberofstepsbetweenthehighandlowboundaryofthelegend.Thedefaultissetto11andanycustomvaluesputinhereshouldalwaysbegreaterthanorequalto2.

customColors[Optional]

Alistofcolorsthatwillbeusedtore-colorthelegendandthecorrespondingcoloredmesh(es).ThenumberofcolorsinputhereshouldmatchthenumSegments_valueinputabove.AneasywaytogeneratealistofcolorstoinputhereiswiththeGrasshopper"Gradient"componentandaGrasshopper"Series"componentconnectedtotheGradientcomponent's"t"input.AbunchofGrasshopper"Swatch"componentsisanotherwaytogeneratealistofcustomcolors.Thedefaultcolorsareagradientspectrumfrombluetoyellowtored.

legendLocation[Optional]

InputapointheretochangethelocationofthelegendintheRhinoscene.Thedefaultisusuallysettotherightofthelegend'scorrespondingLadybuggraphic.

legendScale[Optional]

InputanumberheretochangethescaleofthelegendinrelationtoitscorrespondingLadybuggraphic.Thedefaultissetto1.

font[Optional]

Anoptionaltextstringthatsetsthefontofthetext.Examplesinclude"Arial","TimesNewRoman"or"Courier"(allwithoutquotations).ThetextinputherecanbeanyfontthatisonyourcomputerbutthefontmustbeofanEditablefiletype(asseeninthefontfolderoffofyourcontrolpanel).FontfilesthatarePrintandPreviewwillnotwork.IfyouwishtouseaBoldedversionofthefont,includea",Bold"attheendofthefontname(example:"Arial,Bold").

LadybugPrimer


fontSize[Optional]

AnoptionalnumbertosetthesizeofthetextinRhinomodelunits.

decimalPlaces[Optional]

Anintergerrepresentingthenumberofdecimalplacestomakethelegendvalues.Thedefaultissetto2decimalplaces.

removeLessThan[Optional]

Setto'True'tohavethe"<="and">="symbolsremovedfromthelegend.Thedefaultissetto'False'tohavethesesymbolsincluded.

Outputs

legendPar

AlistoflegendparameterstobepluggedintoanyoftheLadybugcomponentswithalegend.

CheckHydraExampleFilesforLegendParameters

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Legend Parameters

PMVComfortParameters

UsethiscomponenttosetPMVcomfortparametersforthePMVcomfortcalculatororthePsychrometricChart.Parametersincludewhethercomfortisdefinedby80or90percentoftheoccupantscomfortableaswellasmaximumandminimumacceptablehumidityratios.Notethattheappliedscienceandengineeringcommunitydifferswidelyonitsinderstandingoftheseparameters.Theairconditioningindustysetoutwiththegoalofsatisfying80%oftheoccupants(assumingtheyallhadsimilarclothingandmetabolicrates)butmanytodayset90%astheirbenchmark.Alsonotethat,ifyoutrytorestricteveryone'sclothingand

LadybugPrimer

227PMV_Comfort_Parameters

metabolicrateasthePMVmodelassumed,youcannevermake100%ofthepeoplecomfortable._Furthernotethatculturesdifferwidelyintermsoftheirtreatmentofhumidityatcoolertemperaturesandlackofhumidity.-

Inputs

PPDComfortThreshold[Optional]

Anumberbetween5and100thatrepresentsthepercentofpeopledissatisfied(PPD)atwhichpointagivensetofconditionsareoutsideofacomfortablerange.Thedefaultissetto10percent,whichisthetypicalcriteriaforbothUSandEuropean(ISO)standards.However,bothofthesestandardsallowanexpandedrangeforinfrequenlty-occupiedbuildings(20%intheUSand15%inEurope)andtheEuropeanstandardrequires6%for'ClassI'buildings.Notethat,ifyoutrytorestricteveryone'sclothingandmetabolicrateasthePMVmodelassumes,youcannevermake100%ofthepeoplecomfortable.Thisiswhythesmallestacceptableinputhereis5%.

humidRatioUpBound[Optional]

Anoptionalnumberbetween0.012and0.030thatlimitsthemaximumhumidityratioacceptableforcomfort.Inmanyculturesandtomanypeople,humidityinconditionsofnothermalstressisnotconsideredasourceofdiscomfortand,accordingly,thiscomponentdoesnotsetanupperlimitonhumiditybydefault.However,forsomepeople,stickynessfromhumidityincoolconditonsisconsidereduncomfortableand,ifyouwanttoaccountforsuchasituation,youmaywanttosetanupperlimitontheacceptablehumidityratiohere.TheASHRAE55PMVcomfortstandardrecommendsamaximumhumidityof0.012kgwater/kgair.

humidRatioLowBound[Optional]

Anoptionalnumberbetween0.000and0.005thatlimitstheminimumhumidityratioacceptableforcomfort.Inmanycultures,alackofhumidityisnotconsidreduncomfortablesincepeoplecompensateforitseffectsbyusingchapstickandlotions.Accordingly,thiscomponentdoesnotsetalowerlimitonhumiditybydefault.However,insomemoretropicalwherepeoplearenotaccustomedtoverydryenvironments,chapingoflipsanddryingofskincanoccurmoreeasilyand,ifyouwanttoaccountforsuchasituation,youmaywanttosetalowerlimitontheacceptablehumidityratiohere.TheASHRAE55PMVcomfortrecommendsnolowerlimitonhumidity.

Outputs

comfortPar

LadybugPrimer


Comfortparametersthatyoucanplugintoeitherthe"Ladybug_PMVComfortCalculator"orthe"Ladybug_PsychrometricChart."

CheckHydraExampleFilesforPMVComfortParameters

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_PMV Comfort Parameters

PassiveStrategyList

ProvidesalistofpassivethermalstrategiestobepluggedintotheLadybug_PsychrometricChart

Inputs

CheckHydraExampleFilesforPassiveStrategyList

LadybugPrimer

230Passive_Strategy_List

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Passive Strategy List

RealTimeRadiationAnalysis

UsethiscomponenttoscrollthroughtheresultsofaLadybugRadiationAnalysisonanhour-by-hour,day-by-day,ormonth-by-monthbasisinrealtime!Thecomponentusesaskymatrix(SkyMxt)fromtheselectSkyMxtcomponentandtheintersectionmatrix(intersectionMxt)fromtheRadiationAnalysiscomponenttocalculaterealtimeradiationresults.Oncethecorrectinputshavebeenhookeduptothiscomponent,youshouldusetheinputsoftheconnectedselectSkyMxtcomponenttoscrollthroughresults.-

Inputs

selectedSkyMatrix[Required]

LadybugPrimer

231Real_Time_Radiation_Analysis

TheoutputfromaLadybugselectedSkyMtxcomponent.Thismatrixbasicallycarriesalloftheradiationvaluesthatdefineaskyandincludesaradiationvalueforeachskypatchontheskydome.YoushouldusetheselectSkyMxtcomponentconnectedheretoscrollthroughradiationresults.

intersectionMatrix[Required]

TheintersectionMxtoutputfromaLadybugRadiationAnalysiscomponentthathasbeenrunfortestgeometry.ThismatrixisbasicallyapythonlistthatincludestherelationbetweeneachtestpointintheRadiationAnalysisandalltheskypatchsontheskydome.

Outputs

radiationResult

NewradiationvaluesforeachtestpointintheoriginalRadiationAnalysis.Valuesindicateradiationforthetheconnectedskymatrix.TovisualizethesenewradiationvaluesintheRhinoscene,connectthesevaluestotheLadybugRe-ColorMeshcomponenttore-colorthemeshfromtheoriginalRadiationAnalysiswiththesenewvalues.

CheckHydraExampleFilesforRealTimeRadiationAnalysis

LadybugPrimer

232Real_Time_Radiation_Analysis

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Real Time Radiation Analysis

CaptureView

UsethiscomponenttocaptureRhinoviewsandsavethemtoyourharddriveasasa.pngfiles.ThisisparticularlyusefulifyouaretryingtocreateanimationsofGrasshoppergeometryandwanttoautomatethecapturingofviews.NotethatyourimageswillhaveaRhinoworldaxesiconinthelowerleftoftheimageunlessyougotoOptions>Grid>anduncheck"Showworldaxesicon"inRhino.-

Inputs

fileName[Required]

LadybugPrimer

233Capture_View

Thefilenamethatyouwouldliketheimagetobesavedas.Notethat,foranimations,youwanttomakesurethateachsavedimageshasadifferentfilenameotherwisethepreviousimagewillbeoverwrittenbyeachsuccessiveimage.

folder[Optional]

Thefolderintowhichyouwouldliketowritetheimagefile.Thisshouldbeacompletefilepathtothefolder.Ifnofolderisprovided,theimageswillbewrittentoC:/Ladybug/Capturedviews/.

viewNames[Optional]

TheRhinoviewportnamewhichyouwouldliketotakeasnapshotof.Acceptableinputsinclude"Perspective","Top","Bottom","Left","Right","Front","Back"oranyviewnamethatyouhavealreadysavedwithintheRhinofile(notethatyoudonotneedtoinputquotations).Ifnotextisinputhere,thedefaultwillbeanimageoftheactiveviewport(orthelastviewportinwhichyounavigated).

imageWidth[Optional]

Thewidthoftheimagethatyouwouldliketotakeinpixels.Ifnovalueisprovidedhere,thecomponentwillsetthewidthtothatoftheactiveRhinoviewportonyourscreen.

imageHeight[Optional]

Theheightoftheimagethatyouwouldliketotakeinpixels.Ifnovalueisprovidedhere,thecomponentwillsettheheighttothatoftheactiveRhinoviewportonyourscreen.

displayMode[Optional]

Thedisplaymodeoftheviewportthatyouwouldliketotakeanimageof.Acceptableinputsinclude"Wireframe","Shaded","Rendered","Ghosted","X-Ray","Technical","Atristic",and"Pen".Ifnotextisinputhere,thedefaultwillbethedisplaymodeoftheactiveviewport(orthelastviewportinwhichyounavigated).

keepAspectR[Optional]

Setto"True"tokeeptheaspectratiooftheviewportintheimagesthatyousave.Bydefault,thisissetto"False"ifyouhaveconnectedanimageHeight_butwilloverridethisinputtoensurecorrectaspectratioifsetto"True".

capture[Required]

Setto"True"tocapturetheimageoftheRhinoviewportandsaveittoyourharddrive.

LadybugPrimer

234Capture_View

Outputs

imagePath

Thefilepathoftheimagetakenwiththiscomponent.

CheckHydraExampleFilesforCaptureView

LadybugPrimer

235Capture_View

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Capture View

OrienttoCamera

UsethiscomponenttogenerateaplanethatisorientedperpendiculartotheactiveRhinoviewportcameradirectionandcenteredataninputinitPositionpoint.ThisisusefulfororientinggeometryGrasshoppertotheRhinoviewportcamera,whichmayhelpinpresentingcertainLadybugvisualizationsinRhino.ConnectaGrasshopper"Timer"componenttotherefreshinputofthiscomponentinordertogetarealtimeupdateoftheorientedplanebasedontheRhinoviewportcameradirection.-

Inputs

initPosition[Required]

LadybugPrimer

236Orient_to_Camera

Apointorlistofpointsthatwillactastheorigin9s0oftheplane(s)thatwillbegenerated.

refresh[Optional]

ConnecteitheraGrasshopper"button"componentthatwillallowyoutorefreshtheplaneorientationuponhittingthebuttonoraGrasshopper"Timer"componenttoseetheplaneupdateinrealtimeasyounavigatethroughtheRhinoviewport.

Outputs

orientedToCam

Aplane(orlistofplanes)foreach_initPositionconnected.AllplanesareorientedperpendiculartotheactiveRhinoviewportcameradirectionandarecenteredatinitPositionpoints.

CheckHydraExampleFilesforOrienttoCamera

LadybugPrimer

237Orient_to_Camera

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Orient to Camera

SettheView

UsethiscomponenttosetthecameralocationanddirectionfortheRhino"Perspective"viewport.Hereisthevideothatshowshowitworks:http://www.youtube.com/watch?v=7Mmhz867zY8-

Inputs

cameraLocation[Required]

Apointrepresentingthelocationoftheviewportcamera.

LadybugPrimer

238Set_the_View

http://www.youtube.com/watch?v=7Mmhz867zY8

cameraDirection[Required]

Avectorthatrepresentsthedirectionthattheviewportcamerashouldface.

uvLookAround[Optional]

OptionalUVcoordinatestotilttheviewportcameraofffromfromtheinput_cameraDirection.ValuesforUVcoordinatesmustbebetween-1and1andthesecorrespondtoatiltof180degreesineitherdirection.ItisrecommendedthatyouuseaGrasshoppersliderMDcomonentforinput.

lensLength[Optional]

Anoptionalfloatnumberthatsetsthelenslengthoftheviewportcamera.

Outputs

CheckHydraExampleFilesforSettheView

LadybugPrimer

239Set_the_View

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Set the View

fly

UseFlytocyclethroughallconnectedsliders.Ifnosliderisconnectsitwillcyclethroughalltheslidersinthedocument!FlyisoriginallypostedasacodesnippetbyDavidRutten.ThecodehasbeenmodifiedbyJamesRamsednandMostaphaSadeghipourRoudsari.

-

Inputs

inputSliders[Required]

LadybugPrimer

240fly

ScriptVariable_inputSliders

fly[Required]

ScriptVariable_fly

Outputs

Vviiiiiiiiiizzz

OutputparameterVviiiiiiiiiizzz

CheckHydraExampleFilesforfly

LadybugPrimer

241fly

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_fly

C2F

UsethiscomponenttoconverttemperaturesfromCelciustoFahrenheit.-

Inputs

C[Required]

AtemperatureorlistoftemperaturesinCelcius.

Outputs

LadybugPrimer

242C2F

F

TheinputtemperaturesconvertedtoFahrenheit.

CheckHydraExampleFilesforC2F

LadybugPrimer

243C2F

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_C2F

DOY_HOY

Usethiscomponenttocalculatethedayoftheyearandhouroftheyearfromaninputdatewithadayofthemonth,monthoftheyearandhouroftheday.-

Inputs

days[Default]

Anumber(orlistofnumbers)between1and31thatrepresentstheday(s)ofthemonth.

months[Default]

LadybugPrimer

244DOY_HOY

Anumber(orlistofnumbers)between1and12thatrepresentsthemonth(s)oftheyear.

hours[Default]

Anumber(orlistofnumbers)between1and24thatrepresentsthehour(s)oftheday.

Outputs

HOY

Thehouroftheyearonwhichtheinputdateandtimefall.

DOY

Thedayoftheyearonwhichtheinputdatefalls.

date

Theinputinformationwrittenoutasafulldateandtimetextstring.

CheckHydraExampleFilesforDOY_HOY

LadybugPrimer

245DOY_HOY

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_DOY_HOY

Day_Month_Hour

Usethiscomponenttocalculatedateinformationfromanhouroftheyear.Dateinformationincludesthedayofthemonth,themonthoftheyearandthehouroftheday.-

Inputs

HOY[Required]

Houroftheyear

Outputs

LadybugPrimer

246Day_Month_Hour

day

ThedayofthemonthonwhichtheinputHOYfalls.

month

ThemonthoftheyearonwhichtheinputHOYfalls.

hour

ThehourofthedayonwhichtheinputHOYfalls.

date

Theinputinformationwrittenoutasafulldateandtimetextstring.

CheckHydraExampleFilesforDay_Month_Hour

LadybugPrimer

247Day_Month_Hour

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Day_Month_Hour

F2C

UsethiscomponenttoconverttemperaturesfromFahrenheittoCelcius.-

Inputs

F[Required]

AtemperatureorlistoftemperaturesinFahrenheit.

Outputs

LadybugPrimer

248F2C

C

TheinputtemperaturesconvertedtoCelcius.

CheckHydraExampleFilesforF2C

LadybugPrimer

249F2C

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_F2C

ActivitiesMetList

ProvidesalistofavailableactivitesandoutputsthemetabolicrateofthatactivityforuseintheLadybugPMVcomfortcalculator.

Inputs

CheckHydraExampleFilesforActivitiesMetList

LadybugPrimer

250Activities_Met_List

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Activities Met List

BTU2Wh

UsethiscomponenttoconvertenergyvaluesinBTUtoWh,kBTUtokWh,BTU/ft2toWh/m2,orkBTU/ft2tokWh/m2.-

Inputs

BTU[Required]

AnenergyvalueorlistofenergyvaluesinBTU,kBTU,BTU/ft2,orkBTU/ft2.Notethat,forthecomponenttorecognizeflux(divisionbyft2),theinputmusthaveaLadybugheader.

LadybugPrimer

251BTU2Wh

Outputs

Wh

TheinputenervyvaluesconvertedtoWh,kWh,Wh/m2,orkWh/m2(depedingoninput).

CheckHydraExampleFilesforBTU2Wh

LadybugPrimer

252BTU2Wh

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_BTU2Wh


UsethiscomponenttocombinetwoormoresolarenvelopesfromLadybug_SolarEnvelopecomponent-

Inputs

baseSrf[Required]

Asurfacerepresentingtheareaforwhichyouwanttocreatethesolarenvelope(couldalsobeaclosedplanercurve).Mustbethesameasthe_BaseSrfconnectedtothesolarEnvelopecomponent.

LadybugPrimer

253CombineSolarEnvelopes

envelopePts[Required]

Alistof3dpointsrepresentingtheheightstowhichthesolarenvelopereaches.UsetheenvelopePtsoutputfromthesolarenvelopecomponent.

HighestEnv[Optional]

ifHighestEnv_isTruewe'lltakethehighestpointsandifit'sFalsewe'lltakethelowestones.DefaultvalueisTrue

gridSize[Required]

AnumericvalueinidcatingthegirdsizeoftheanalysisinRhinomodelunits.MusebethesameasthegridSize_valueconnectedtothesolarEnvelopecomponent.

Outputs

newEnvPoints

Alistof3dpointsrepresentingtheheightstowhichthesolarenvelopereaches.PlugintoanativeGH'DelunayMesh'componenttovisualizethefullsolarenvelope.

envelopeBrep

Breprepresentingtheenvelope.

CheckHydraExampleFilesforCombineSolarEnvelopes

LadybugPrimer

254CombineSolarEnvelopes

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_CombineSolarEnvelopes

ComfortMannequin

Usethiscomponenttocoloramannequinbasedontheirrelationtoacomforttemperature.-

Inputs

ambientTemperature[Required]

Thetemperturearoundthemannequin,whichcanbeeitherUTCI(outdoorcomfort),StandardEffectiveTemperature(PMVcomfort),orOperativeTemperature(AdaptiveComfort).

LadybugPrimer

255Comfort_Mannequin

targetTemperature[Optional]

Thetargetcomforttemperaturethatthemannequinwantstobeat.Thedefaultissetto20C

comfortRange[Optional]

Thenumberofdegreesaboveandbelowthetargettemperturethatthesubjectwillstillfindcomfortable.Thedefaultissetto3C,whichisprettycommonformanycomfortmetrics.

bodyPosture[Optional]

Anintergertosetthepostureofthecomfortmannequin,whichcanhavealargeeffectontheradiationstrikingthemannequin.0=Standing,1=Sitting,and2=LyingDown.Thedefaultissetto1forsitting.

rotationAngle[Optional]

Anoptionalrotationangleindegrees.Usethisnumbertoadjusttheangleofthecomfortmannequininspace.Theangleofthemannequininrelationtothesuncanhavealargeeffectontheamountofradiationthatfallsonitandthuslargelyaffecttheresultingmeanradianttemperature.

bodyLocation[Optional]

Anoptionalpointthatsetsthepositionofthecomfortmannequininspace.UsethistomovethecomfortmannequinaroundinrelationtocontextShading_connectedbelow.ThedefaultissettotheRhinoorigin.

legendPar[Optional]


Outputs

mannequinMesh

Acoloredmeshofacomfortmannequinshowingtheamountofradiationfallingoverthemannequin'sbody.

legend

AlegendthatcorrespondstothecolorsonthemannequinMeshandshowstherelativeW/m2.

LadybugPrimer


legendBasePt


CheckHydraExampleFilesforComfortMannequin

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Comfort Mannequin

ConstructTime

Usethiscomponenttoconstructaspecifichourfromcorrespondingtimeinhours,minutesandseconds.TheoutputcanbepluggedintotheanalysisPeriodorsunPathcomponents.-

Inputs

hour[Default]

Anumberbetween1and23representingthehouroftheday.

minutes[Default]

LadybugPrimer

258Construct_Time

Anumberbetween1and60representingtheminuteofthehour.

seconds[Default]

Anumberbetween1and60representingthesecondoftheminute.

Outputs

hour

AnoutputhourthatanbepluggedintotheanalysisPeriodorsunPathcomponents.

CheckHydraExampleFilesforConstructTime

LadybugPrimer

259Construct_Time

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Construct Time

CreateLegend

Usethiscomponenttocreateacustomlegendforanysetofdataortocreateamoreflexiblelegendforanyladybugcomponentwithalegend.Specifically,thiscomponentoutputsdatathatcanbepluggedintothegrasshopper"TextTag3D"componentsothatthelegendtextcanbebakedintotheRhinosceneasactualtextinsteadofsurfacesrepresentingtext.-

Inputs

valuesOrRange[Required]

LadybugPrimer

260Create_Legend

Thelistofnumericaldatathatthelegendrefersto(orjusttheminimumandmaximumnumericalvaluesofthisdata).Iftheoriginalnumericaldataishookedup,thelegend'smaximumandminimumvalueswillbesetbythemaxandminofthedataset.

legendBasePt[Optional]

Anoptionalpointtosetthelocationofthelegend.ThiscanbetheoutputlegendBasePtofanyoftheLadybugcomponentsthathavealegend.IfapointishookeduphereandanotherpointishookedupatalegendParcomponentthatisconnectedtothisone,thepointonthelegendParcomponentwilloverridetheinputpointhere.

legendTitle[Optional]

Atextstringrepresentingalegendtitle.Legendsareusuallytitledwiththeunitsofthedata.Ifnotextisprovidedhere,thedefaulttitlewillread"unkownunits."

legendSize[Optional]

Theinitialsizeofasinglecoloredcellofthelegendmesh,whichdeterminesthesizeofthewholelegend.ThisshouldbeanumericalvaluecorrespondingtothelengthofalegendcellinRhinomodelunits.Thedefaultissetto10Rhinounits.

legendPar[Optional]


Outputs

legendMesh

Acoloredmeshthatcorrespondstotheinput_valuesOrRange.Connectthisoutputtoagrasshopper"Mesh"componentinordertopreviewthisseparatelyintheRhinoscene.

legendTextSrf

Alistofsurfacesrepresentingthetextlabelsofthelegend.ThesesurfaceswillreflectthefontandsizeinputtothelegendPar.

legendBasePt

Thelegendbasepoint,whichcanbeusedtomovethelegendwiththegrasshopper"move"component.

textValuesBasePts

Thebasepointsthatcorrespondtothetitletextandnumericalvaluetextofthelegend.

LadybugPrimer

261Create_Legend

Plugthisintothe"Location"inputofthegrasshopper"TextTag3D"componentinordertodisplayastextinRhino.

legendTextValues

Thetextstringsthatcorrespondtothetitleandnumericalvaluesofthelegend.Plugthisintothe"Text"inputofthegrasshopper"TextTag3D"componentinordertodisplayastextinRhino.

recommendedTextSize

Valuesrepresentingrecommendedtextsizesthatcorrespondtothetitleandnumericalvaluesofthelegend.Thesevaluesaregeneratedbasedonthelegendsizeandscale.Plugthisintothe"Size"inputofthegrasshopper"TextTag3D"componentinordertodisplayastextinRhino.

CheckHydraExampleFilesforCreateLegend

LadybugPrimer

262Create_Legend

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Create Legend

L2G

UsethiscomponenttoconverttheliquidvolumefromLiterstoU.S.Gallons(notImperialGallons).-

Inputs

L[Required]

AvalueorlistofvaluesinLiters.

Outputs

LadybugPrimer

263L2G

G

InputvolumeconvertedtoU.S.Gallons.

CheckHydraExampleFilesforL2G

LadybugPrimer

264L2G

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_L2G

OrientationStudyParameters

UsethiscomponentwiththeLadybug"RadiationAnalysis","SunlightHoursAnalysis",or"ViewAnalysis"componenttosetuptheparametersforanOrientationStudy.YoucanuseanOrientationStudytoanswerquestionslike"Whatorientationofmybuildingwillgivemethehighestorlowestradiationgainformyanalysisperiod?"Anotherquestionmightbe"WhatdirectionshouldIorientmystaticsolarpaneltogetthemaximumradiationduringmyanalysisperiod?"AnOrientationStudywillautomaticallyrotateyourgeometryaroundseveraltimesbasedontheinputsmadetothiscomponentandtheresultswillberecordedinthecorrespondingAnalysiscomponentthatthisoneishookedupto.-

Inputs

LadybugPrimer

265Orientation_Study_Parameters

divisionAngle[Required]

Anumberbetween0and180thatrepresentsthedegreestorotatethegeometryforeachstepoftheOrientationStudy.

totalAngle[Required]

Anumberbetween0and360thatrepresentsthedegreesofthetotalrotationthatthegeometrywillundergooverthecourseoftheOrientationStudy.This_totalAngleshouldbelargerthanthe_divisionAngleanddivisiblebythe_divisionAngle.

basePoint[Optional]

InputapointheretochangethecenteraboutwhichtheOrientationStudywillrotatethegeometry.Ifnopointisconnected,thedefaultpointofrotationwillbethecenterofthetestgeometry.

rotateContext[Optional]

InputeitheraBooleanvalueorasetofcontextBrepsthatshouldberotatedalongwiththetestgeometry.Ifsetthisinputto"True",allcontextBrepswillberotatedwiththetestgeometry.Thedefaultissetto"False"toonlyrotatethetestgeometry.

runTheStudy[Required]

[BooleanorGeometryBase]Sinceorientationstudymaytakealongtime,thisisanextraconfirmationrequesttomakesurethatyoureallywanttoruntheoriantationstudy![courtesyofWindowsVista...;)]Ifyouwantpartofthecontexttoroatatewiththetestgeometrytheconnectithere!

Outputs

orientationStudyPar

AlistofOrientationStudyparametersthatcanbepluggedintotheLadybug"RadiationAnalysis","SunlightHoursAnalysis",or"ViewAnalysis"component.

CheckHydraExampleFilesforOrientationStudyParameters

LadybugPrimer

266Orientation_Study_Parameters

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Orientation Study Parameters

PassiveStrategyParameters

UsethiscomponenttoadjusttheassumptionsofthepassivestrategiesthatcanbeoveralidontheLadybugthePsychrometricChart.Thedefaultassumptionsofeachofthestrategiesareasfollows:EvaporativeCooling-Thispolygonrepresentstheconditionsunderwhichdirectevaporativecoolingwouldbehelpful.Assuch,ittakesasitsupperlimitthelineofconstantenthalpyfromtheedgeofthecomfortpolygonandincludesallwarmtemperaturesbelowit.Iftheuserhassetaminimumhumiditytolerance,thepolygonwillalsoincludethepointsbeneaththecomfortpolygonasitisassumedthattheevaporationofwaterwillbothhumidifyandcooltheair.Nothethatthisdirectevaporativecoolingpolygonisslightlydifferentthan2-stageevaporativecooling.ThermalMass+NightFlush-Thepolygonrepresentstheconditionsunderwhichshaded,night-flushedthermalmasscankeep

LadybugPrimer

267Passive_Strategy_Parameters

occupantscool.Bydefault,thispolygonassumesthattemperaturescangetashighas16.7Cabovethemaxtemperatureofthecomfortpolygonaslongtemperatures12hoursbeforethehotperiodare2.8Clowerthanthemaxtempertureofthecomfortpolygon.Thisparametercomponentcanbeusedtoadjustthesetwonumbers.Thethermalmasspolygonislimitedintermsofhumidityinthatitobeysanylimitsonabsolutehumiditythatthecomfortpolygondies.OccupantUseofFans-Thispolygonismadebyassumingthatawindspeedof1.5m/sisthemaximumspeedtolerablebeforeitstartsblowingpapersandbecomesannoyingtooccupants.Thisstrategyparameterscomponentcanbeusedtoadjustthismaximumacceptablewindspeed.Assuch,thepolygonisdeterminedbyrunningaPMVmodelwiththiswindspeedandtheinputradtemp,metrateandclolevelofthepsychchart.Thiscomponentobeysanylimitsonhumiditythatthecomfortpolygondoes.Notethatthispolygonassumesthatyouarealreadynaturallyventilatingandthatyournaturalventilationperiodisdefinedbyyourcomfortpolygon.InternalHeatGain-Thecomponentassumesaminimumbuildingbalancepointof12.8Candanyconditionsthatarewarmerthanthat(uptothecomfortpolygon)willkeepoccupantscomfortable.Itisassumedthat,abovethisoutdoortemperature,thebuildingisfree-runningandoccupantsareabletoopenwindowsastheywish.Notethatthisbalancetemperatureof12.8isfairlylowandassumesalargenumberofinsideheatsourcesorpeopleaswellasininsulatedenvelope.ThisbalancetemperaturecanbeadjustedwiththisstrategyParcomponent._DessicantDehumidification-Thispolygonrepresentstheconditionsunderwhichdessicantdehumidificationwouldbehelpful.Assuch,ittakesasitsupperlimitthelineofconstantenthalpyfromtheedgeofthecomfortpolygonandincludesallhumidconditionsbelowit.Notethatthispolygondoesnotappearifthereisnoupperhumiditylimitonthecomfortpolygon.-

Inputs

maxTempAboveComf[Optional]

AnoptionalnumberindegreesCrepresentingthemaximumdailytemperatureabovethecomfortrangewhichcanstillbecountedintheThermalMass+NightFlushpolygon.Thedefaultissetto16.7Cabovethehighestcomforttemperature.

minNightDiffBelowComf[Optional]

AnoptionalnumberindegreesCrepresentingtheminimumtemperaturebelowthemaximumcomforttemperaturethattheoutdoortemperaturemustdropatnightinordertocounttowardstheThermalMass+NightFlushpolygon.Thedefaultissetto2.8C.

maxComfortableAirSpeed[Optional]

Anoptionalnumberinm/sthatrepresentsthemaximumwindsspeedtolerablebeforeitstartsblowingpapersandbecomesannoyingtooccupants.Thisisusedtoshapethe

LadybugPrimer


"OccupantUseofFans"Polygonandthedefaultissetot1.5m/s.

lowestBldgBalancePt[Optional]

Anoptionalnumberrepresentingthebuildingbalancepoint,whichwillbeusedtoshapethe"InternalHeatGain"strategypolygon.Thedefaultissetto12.8Canditisassumedthat,abovethisoutdoortemperature,thebuildingisfree-runningandoccupantsareabletoopenwindowsastheywish.Notethatthisdefaultbalancetemperatureof12.8isfairlylowandassumesalargenumberofinsideheatsourcesorpeopleaswellasininsulatedenvelope.

Outputs

strategyPar

Passivestrategyparametersthatcanbepluggedintothe"Ladybug_PsychrometricChart"toadjusttheassumptionsofthepassivestrategypolygons.

CheckHydraExampleFilesforPassiveStrategyParameters

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Passive Strategy Parameters

ShadingParametersList

Usethiscomponenttogenerateshadingdepths,numbersofshades,horizontalorverticalbooleanvalues,andshadeanglesfordifferentcardinaldirectionstobepluggedintothe"Ladybug_ShadingDesigner"componentorthe"Honeybee_EnergyPlusWindowShadeGenerator".-

Inputs

northShdParam[Default]

Shadingparameterfornorth-facingglazing.

LadybugPrimer

270Shading_Parameters_List

westShdParam[Default]

Shadingparameterforwest-facingglazing.

southShdParam[Default]

Shadingparameterforsouth-facingglazing.

eastShdParam[Default]

Shadingparameterforeast-facingglazing.

Outputs

shdParamList

Alistofshadingparametersfordifferentcardinaldirectionstobepluggedintoeithertheinputofthe"ShadingDesigner"componentorthe"HoneybeeEnergyPlusWindowShadeGenerator".Dependingonthetypeofvaluesthatyouinput,thesecangointoeitheroftheseinputs:_depth,_numOfShds,_distBetween,_horOrVertical,shdAngle.

CheckHydraExampleFilesforShadingParametersList

LadybugPrimer

271Shading_Parameters_List

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Shading Parameters List

Wh2BTU

UsethiscomponenttoconvertenergyvaluesinWhtoBTU,kWhtokBTU,Wh/m2toBTU/ft2,orkWh/m2tokBTU/ft2.-

Inputs

Wh[Required]

AnenergyvalueorlistofenergyvaluesinWh,kWh,Wh/m2,kWh/m2.Notethat,forthecomponenttorecognizeflux(divisionbym2),theinputmusthaveaLadybugheader.

LadybugPrimer

272Wh2BTU

Outputs

BTU

TheinputenervyvaluesconvertedtoBTU,kBTU,BTU/ft2,orkBTU/ft2(depedingoninput).

CheckHydraExampleFilesforWh2BTU

LadybugPrimer

273Wh2BTU

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Wh2BTU

Wh2kWh

UsethiscomponenttoconvertenergyvaluesinWtokW,W/m2tokW/m2,WhtokWh,Wh/m2tokWh/m2,BTUtokBTU,orBTU/ft2tokBTU/ft2.-

Inputs

Wh[Required]

AnenergyvalueorlistofenergyvaluesinW,W/m2,Wh,Wh/m2,BTU,orBTU/ft2.

Outputs

LadybugPrimer

274Wh2kWh

kWh


CheckHydraExampleFilesforWh2kWh

LadybugPrimer

275Wh2kWh

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Wh2kWh

kWh2Wh

UsethiscomponenttoconvertenergyvaluesinkWtoW,kW/m2toW/m2,kWhtoWh,kWh/m2toWh/m2,kBTUtoBTU,orkBTU/ft2toBTU/ft2.-

Inputs

kWh[Required]

AnenergyvalueorlistofenergyvaluesinWh,kWh,Wh/m2,kWh/m2.Notethat,forthecomponenttorecognizeflux(divisionbym2),theinputmusthaveaLadybugheader.

LadybugPrimer

276kWh2Wh

Outputs

Wh


CheckHydraExampleFilesforkWh2Wh

LadybugPrimer

277kWh2Wh

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_kWh2Wh

ms2mph

Convertfromm/stomile/h-

Inputs

ms[]

Inputwindspeedinmeterspersecond

Outputs

LadybugPrimer

278ms2mph

mph

Outputwindspeedinmilesperhour

CheckHydraExampleFilesforms2mph

LadybugPrimer

279ms2mph

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_ms2mph

rIP2rSI

UsethiscomponenttoconvertR-ValuesinIP(h·ft2·°F/BTU)toR-ValuesinSI(K·m2/W)toplugintoanyoftheHoneybeematerialcomponents.-

Inputs

R_IP[Required]

AR-ValueinIP(h·ft2·°F/BTU).

Outputs

LadybugPrimer

280rIP2rSI

R_SI

TheR-ValueinSI(K·m2/W).

CheckHydraExampleFilesforrIP2rSI

LadybugPrimer

281rIP2rSI

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_rIP2rSI

uIP2uSI

UsethiscomponenttoconvertU-ValuesinIP(BTU/h·ft2·°F)toU-ValuesinSI(W/K·m2)toplugintoanyoftheHoneybeematerialcomponents.-

Inputs

U_IP[Required]

AnR-ValuesinIP(h·ft2·°F/BTU).

Outputs

LadybugPrimer

282uIP2uSI

U_SI

TheR-ValueinSI(K·m2/W).

CheckHydraExampleFilesforuIP2uSI

LadybugPrimer

283uIP2uSI

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_uIP2uSI

Componentlist:

Export_Ladybug

Update_Ladybug

LadybugPrimer

2845|Developers

ExportLadybug

CodeDevelopersofLadybugandHoneybeecanusethiscomponenttoexportLadybug/HoneybeeuserobjectsandsourcecodethattheycreatetotheGithubfolderontheircomputer.ThiseasesandautomatesthestepsbeforecommitingnewcomponentstotheGithub.ThiscomponentwaswrittenthankstoGiulioPiacentinoareallyhelpfulexample.-

Inputs

components[Required]

LadybugPrimer

285Export_Ladybug

AnyoutputfromanewLadybug(orHoneybee)componentthatyouwishtoexport.Rightnow,onlyonecomponentcanbeconnectedatatimebutyoucaninputa"*"(withoutquotationmarsk)tosearchallchangedLadybugcomponentsonagrasshoppercanvas.

targetFolder[Required]

Afilepathonyoursystemwhichyouwouldliketoexporttheuserobjectandsourcecodeto.Formostcodedevelopers,thisfilepathwillleadtotheirGithubfolderforLadybug(orHoneybee),whichisusuallyinstalledin"MyDocuments"bydefault.Exportedsourcecodewillbesavedat.\srcandexporteduserObjectswillbesavedat.\userObjectsinthis_targetFolder.

export[Required]

Setto"True"toexportLadybug(orHoneybee)componentstothe_targerFolder.

Outputs

readMe!

...

CheckHydraExampleFilesforExportLadybug

LadybugPrimer

286Export_Ladybug

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Export Ladybug

UpdateLadybug

CodeDevelopersandBetaTestersofnewLadybugcomponentscanusethiscomponenttoremoveoldLadybugcomponents,addnewLadybugcomponents,andupdateexistingLadybugcomponentsfromasyncedGithubfolderontheircomputer.ThiscomponentcanalsoupdateoutdatedLadybugcomponentsinanoldGrasshopperfilesolongastheupdatestothecomponentsdonotinvolvenewinputsoroutputs.-

Inputs

sourceDirectory[Optional]

LadybugPrimer

287Update_Ladybug

AnoptionaladdresstoafolderonyourcomputerthatcontainstheupdatedLadybuguserObjects.Ifnoinputisprovidedhere,thecomponentwilldownloadthelatestversionfromGitHUB.

updateThisFile[Required]

Setto"True"ifyouwantthiscomponenttosearchthroughthecurrentGrasshopperfileandupdateLadybugcomponentsthathavechanged.

updateAllUObjects[Required]

Setto"True"tosyncalltheLadybugandHoneybeeuserObjectsinyourGrasshopperfolderwiththeGitHUB.

Outputs

readMe!

...

CheckHydraExampleFilesforUpdateLadybug

LadybugPrimer

288Update_Ladybug

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Update Ladybug

Componentlist:

Bioclimatic_Chart

Shadow_Study

PV_SWH_System_Size

Photovoltaics_Module

Cold_Water_Temperature

Commercial_Public_Apartment_Hot_Water

Residential_Hot_Water

Solar_Water_Heating_Performance_Metrics

Solar_Water_Heating_Surface

Solar_Water_Heating_System

Solar_Water_Heating_System_Detailed

Shading_Mask

Shading_Mask_II

LadybugPrimer

2896|WIP

BioclimaticChart

ThisistheBioclimacticChart.ItisbasedintheoriginallyproposedchartbyV.Olgyayandtheninthechartpresentedinthebook"Sun,ClimateandArchitecture"byBrown.UsethiscomponenttodrawaBioclimaticchartintheRhinosceneandevaluateasetoftemperaturesandhumidityratiosintermsofindoorcomfort.ConnecteddatacanincludeeitheroutdoortemperatureandhumidtyratiosfromimportedEPWweatherdata,indoortemperatureandhumidityratiosfromanenergysimulation,orindivdualnumericalinputsoftemperatureandhumidity.Theinputdatawillbeplottedalongsidepolygonsonthechartrepresentingcomfortaswellaspolygonsrepresentingtheefectsofpassivebuildingstrategiesoncomfort.References:

LadybugPrimer

290Bioclimatic_Chart

1.Olgyay,V.,1963.DesignwithClimate.BioclimaticApproachtoArchitecturalRegionalism.VanNostrandreinhold,NewYork.

2.GivoniB.,1976.Man,ClimateandArchitecture.AppliedSciencePublishers,Ltd.,London.

3.MurrayM.andGivoniB.,1979.ArchitecturalDesignBasedonClimateinWatsonD.(ed),1979.EnergyCOnservationThroughBuildingDesign.McGrawHillBookCompany.

4.Yezioro,A.&E.Shaviv.1996.AKnowledgeBasedCADSystemforDeterminingThermalComfortDesignStrategies.RenewableEnergy,8:(1-4),(pp.133-138).

5.BrownG.Z.andDeKayM.,2001.Sun,WInd&Light.ArchitecturalDesignStrategies(2ndedition).JohnWIley&Sons,Inc.

-

Inputs


AnumberrepresentingthedrybulbtemperatureoftheairindegreesCelcius.ThisinputcanalsoacceptalistoftemperaturesrepresentingconditionsatdifferenttimesorthedirectoutputofdryBulbTemperaturefromtheImportEPWcomponent.IndoortemperaturesfromHoneybeeenergysimulationsarealsopossibleinputs.




Anumberrepresentingthemetabolicrateofthehumansubjectinmet.Thisinputcanalsoaccepttextinputsfordifferentactivities.AcceptabletextinputsincludeSleeping,Reclining,Sitting,Typing,Standing,Driving,Cooking,HouseCleaning,Walking,Walking2mph,Walking3mph,Walking4mph,Running9mph,Lifting10lbs,Lifting100lbs,Shoveling,Dancing,andBasketball.Ifnovalueisinputhere,thecomponentwillassumeametabolicrateof1met,whichisthemetabolicrateofaseatedhumanbeing.


Anumberrepresentingtheclothinglevelofthehumansubjectinclo.Ifnovalueisinputhere,thecomponentwillassumeaclothinglevelof1clo,whichisroughlytheinsulationprovidedbya3-piecesuit.ApersondressedinshortsandaT-shirthasaclothinglevelofroughly0.5cloandapersoninathickwinterjacketcanhaveaclothinglevelashighas2to4clo.

passiveStrategy[Optional]

LadybugPrimer


AnoptionaltextinputofpassivestrategiestobelaidovertheBioclimaticchartaspolygons.Textinputsinclude"PassiveSolarHeating","EvaporativeCooling","ThermalMass+NightVent"and"NaturalVentilation".NOTWORKINGRIGHTNOW!!

cullMesh[Optional]

Setto"True"tocullthecoloredmeshtowheretheyhaveclimaticdataonthem.SeechartMeshoutput.Deafult"False"

calculateCharts[Optional]

Setto"True"tocalculateandshowacolumntypegraphshowingthepercentageoftimeeachstrategyiscapableofprovidingcomfortconditions.SeeresultsChartoutput.Deafult"False"

analysisPeriodWinter[Optional]

AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.IfnoAnalysisperiodisgivenandepwdatafromtheImportEPWcomponenthasbeenconnected,theanalysiswillberunfortheenitreyear.ONLYWORKSFORTHEWHOLEYEARRIGHTNOW!!

analysisPeriodSummer[Optional]

AnoptionalanalysisperiodfromtheAnalysisPeriodcomponent.IfnoAnalysisperiodisgivenandepwdatafromtheImportEPWcomponenthasbeenconnected,theanalysiswillberunfortheenitreyear.ONLYWORKSFORTHEWHOLEYEARRIGHTNOW!!

basePoint[Optional]

AnoptionalbasepointthatwillbeusedtoplacetheBioclimaticChartintheRhinoscene.Ifnobasepointisprovided,thebasepointwillbetheRhinomodelorigin.

scale[Optional]

AnoptionalnumbertochangethescaleoftheBioclimaticchartintheRhinoscene.Bydefault,thisvalueissetto1.

legendPar[Optional]


runIt[Required]

Setto"True"torunthecomponentandcalculatetheadaptivecomfortmetrics.

Outputs

LadybugPrimer


readMe!

...

comfortResults

Thenumberofhoursandpercentoftheinputdatathatareinsideallcomfortandpassivestrategypolygons.

totalComfortOrNot

Alistof0'sand1'sindicating,foreachhouroftheinputdata,ifthehourisinsideacomfortand/orstrategypolygon(1)ornot(0).

strategyOrNot

Alistof0'sand1'sindicating,foreachhouroftheinputtemperatureandhumidityratio,ifthehourisinside(1)ornot(0),foreachpassivestrategyandcomfortpolygons.IftherearemultiplecomfortpolyognsorpassivestrategiesconnectedtothepassiveStrategy_input,thisoutputwillbeagraftedlistforeachpolygon.

chartGridAndTxt

ThegridandtextlabelsoftheBioclimaticchart.

chartMesh

AcoloredmeshshowingthenumberofinputhourshappenineachpartoftheBioclimaticchart.

legendChartMesh

ScriptvariableBioclimacticChart

chartHourPoints

Pointsrepresentingeachofthehoursofinputtemperatureandhumidityratio.Bydefault,thisouputishiddenand,toseeit,youshouldconnectittoaGrasshopperpreviewcomponent.

hourPointColorsByComfort

ColorthechartHourPointsaboveaccordingtoComfortresults.Theycanbehookeduptothe"Swatch"inputofaGrasshopperPreviewcomponentthathasthehourpointsaboveconnectedasgeometry.Bydefault,pointsarecoloredrediftheylieinsidecomfortorstrategypolygonsandarecoloredblueiftheydonotmeetsuchcomfort

LadybugPrimer


criteria.

hourPointColorsByMonth

ColorsthatthechartHourPointsaboveaccordingtoeachmonth.Theycanbehookeduptothe"Swatch"inputofaGrasshopperPreviewcomponentthathasthehourpointsaboveconnectedasgeometry.Bydefault,pointsarecoloredrediftheylieinsidecomfortorstrategypolygonsandarecoloredblueiftheydonotmeetsuchcomfortcriteria.

min_maxPoints

Ploteachmonth'sMinimal/MaximalvaluesforTemperatureandRelativeHumidity.Bydefault,thisouputishiddenand,toseeit,youshouldconnectittoaGrasshopperpreviewcomponent.

comfort_strategyPolygons

Atreeofpolygonsrepresentingthecomfortandpassivestrategiesareasofthechartmadecomfortable.

legendComfortStrategies

AcoloredlegendshowingthenumberofhoursthatcorrespondtoeachcolorforthechartMeshoutput.

legendBasePt


resultsChart

Acolumntypegraphshowingthepercentageoftimeeachstrategyiscapableofprovidingcomfortconditions.Theseresultsaresummarizingthewholeyearandeachmonth.Eachcolumnshowsthreeareas:ComfortZone(black),PassiveSolarHeating(yellow),astheonlyheatingstrategyforwintertimeEvaporativeCoolingorHighTermalMasswithNightVentilationorNaturalVentilation(green,red,blue)asthepossiblecoolingstrategiesforsummertime.

CheckHydraExampleFilesforBioclimaticChart

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Bioclimatic Chart

ShadowStudy

Usethiscomponenttogenerateoutlinecurvesrepresentingshadowscastbyinput_geometryforagiven_sunVector.Notethat,toseeshadowscastontoaground,asurfacerepresentingthegroundplanemustbeincludedintheinput_geometry.Also,pleasenotethat,foralistofinput_geometrythatislargerthan4or5breps,thecalculationtimeofthiscomponentcanbeverylong.Pleasekeeptheinputgeometrytosmalllistsorbepreparedtowaitalongtime.WARNING:Thiscomponentisaproofofconceptthatwillnotworkineverysituation.Itisnotidealforanalyzingcurvedsurfacesanditisnotabletocalculateshadowsforgeometriesthatareintersectingeachother.-

Inputs

LadybugPrimer

295Shadow_Study

geometry[Required]

Brepsrepresentigtestgeometriesthatwillcastshadowsoneachother.

sunVector[Required]

AsunvectorfromtheLadybugsunPathcomponent.

Outputs

readMe!

...

shadow

OutlinecurvesrepresentingtheshadowscastbytheindividualinputBrepsonotherinputBreps.Notethat,ifallinput_geometryisplanar,thisoutputcanbehookeduptoaGrasshopper"Brep"componenttogiveBrepsrepresentingshadowscast.

shade

OutlinecurvesrepresentingthethepartsofindividualinputBrepsthatarenotinthesun.Inotherwords,thisistheself-shadedpartoftheBreps.Notethat,ifallinput_geometryisplanar,thisoutputcanbehookeduptoaGrasshopper"Brep"componenttogiveBrepsrepresentingself-shadedareas.

CheckHydraExampleFilesforShadowStudy

LadybugPrimer

296Shadow_Study

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Shadow Study

PVSWHSystemSize

UsethiscomponenttogeneratethePVsurfaceorSWHsurfacefor"Photovoltaicssurface"or"SolarWaterHeatingsurface"components,basedoninitialPVorSWHsystemsizes.-

Inputs

location[Required]

Theoutputfromthe"importEPW"or"constructLocation"component.Thisisessentiallyalistoftextsummarizingalocationontheearth.

LadybugPrimer

297PV_SWH_System_Size

PVmoduleSettings[Required]

AlistofPVmodulesettings.Usethe"PhotovoltaicsModule"componenttogeneratethem.

SWHsystemSettings[Required]

AlistofallSWHsystemsettings.Usethe"SolarWaterHeatingSystem"or"SolarWaterHeatingSystemDetailed"componentstogeneratethem.

systemSize[Optional]

1)IncaseofPVarray:DC(Directcurrent)powerratingofthephotovoltaicarrayinkilowatts(kW)atstandardtestconditions(STC).2)IncaseofSWHarray:Capacityofthecollectorsarrayinthermalkilowatts(kw)atglobalorlocaltestingconditions(ISO9806,EN12975,ASHRAE93...)-Ifnotsupplied,4kWwillbeusedasadefault.-InkiloWatts(kW)orthermalkiloWatts(kWt).

arrayTiltAngle[Optional]

AnanglefromhorizontaloftheinclinationofthePV/SWHarrayplane.Example:0=horizontal,90=vertical.(range0-180)-Togetthemaximalamountofenergy,inputthe"optimalTilt"outputfrom"TiltAndOrientationFactor"'scomponent.-Ifnotsupplied,location'slatitudewillbeusedasdefaultvalue.-Indegrees(°).

arrayAzimuthAngle[Optional]

Theorientationangle(clockwisefromthetruenorth)ofthePV/SWHarrayplane'snormalvector.(range0-360)-Togetthemaximalamountofenergy,inputthe"optimalAzimuth"outputfrom"TiltAndOrientationFactor"'scomponent.-Ifnotsupplied,thefollowingvalueswillbeusedasdefault:180(duesouth)fornorthernhemisphere,0(duenorth)forsouthernhemisphere.-Indegrees(°).

tiltedArrayHeight[Optional]

Theheightofthearray,measuredinthetiltedplane.Itisdependsontheheight/widthofthePVmodule/SWHcollector.Italsodependsonthewaymodules/collectorsarepositionedinPV/SWHarray(verticallyorhorizontally).Itcanvaryfrom1to2.3metersxnumberofmodules/collectorsinasinglePV/SWHcolumn.-Ifnotsupplied,defaultvalueof1.6meters(withasinglePVmodule/SWHcollectorperrow)willbeused.-Inmeters.

numberOfRows[Optional]

NumberofrowstowhichPVorSWHarraywillbedividedto.-Ifnotsupplied,1willbe

LadybugPrimer


usedasadefaultvalue(PV/SWHarraywillhaveonly1row).

skewRowsDistance[Optional]

DistanceinmetersbywhichPV/SWHrowswillbeskewed.Usepositivedistancetoskewtherowstotheleft.Andnegativedistancetoskewtherowstotheright.-Itrequiresthe"numberOfRows_"tobelargerthan1inordertobeabletoskewtherows.-Ifnotsupplied,0willbeusedasadefault(norowsskewing).

minimalSpacingPeriod[Optional]

AnalysisperiodforwhichtheminimalspacingdistancebetweenPVmodules/SWHcollectorrowswillderivedof.Ingeneralthisanalysisperiodistakenfrom9to15houronadayatwhichsunisatitslowestpositionduringayear.Thatis21thDecemberinNorthernand21thJuneinSouthernhemisphere(winterandsummersolstice).However,thismaynotbeeconomicalforlocationswithhigherlatitudesduetolowelectricitygenerationduringDecember/June.-Sothefollowing"minimalSpacingPeriod_"shouldbeusedbasedonlocation'slatitude:

latitude<=44:21.December(northernhemisphere)/21.June(southernhemisphere).9-15hourslatitude44-53:15.Novemberor15.January(northernhemisphere)/15.Mayor15.July(southernhemisphere).9-15hourslatitude53-57:15.Octoberor15.February(northernhemisphere)/15.Aprilor15.August(southernhemisphere).9-15hourslatitude>57:15.Septemberor15.March(forbothnorthernandsouthernhemisphere).9-15hours-Itrequiresthe"numberOfRows_"tobelargerthan1inordervisualizetheminimalspacingbetweenrows.-Ifnotsupplied,itwillbecalculatedbasedonuppermentionedcriteria.

baseSurface[Optional]

SurfaceonwhichPV/SWHarraywillbelaidonto.Thiscanbeasurfaceofanangledorflatroof.Oranangledorflatterrain.Afacadeofabuildingetc.-Ifnotsupplied,aregularhorizontalsurfaceinRhino'sXYplanewillbeused,asadefault.

arrayOriginPt[Optional]

UVcoordinateofbaseSurface_atwhichPV_SWHarraywillstart.Itrangesfrom0to1.0forbothUandVcoordinate.Usegrasshopper's"ConstructPoint"or"MDslider"componentstoinputit.-Ifnotsupplied,(0.5,0,0)willbeusedasadefaultvalue.

arrayOriginCorner[Optional]

CorneratwhichthePV/SWHarraybegins:-0-centerbottom1-leftbottom2-right

LadybugPrimer


bottom-Ifnotsupplied,0willbeusedasadefault(bottomcenter).

north[Optional]


energyLoadPerHour[Optional]

Alistofenergyloadvaluesforeachhour,duringayear.1)IncaseofPVarray:Electricalenergyusedforanykindofload:heating,cooling,electriclights,solarwaterheatingcirculationpumpetc.UseHoneybee"ReadEPResult"componentoranyotheronetogenerateit.-2)IncaseofSWHarray:Thermalheatingenergy(orelectricalenergy)requiredtoheatdomestichotwaterand/orspaceheatingloadand/orspacecoolingload.UseLadybug"Domestichotwater"or"Hotwater"componentstocalculateit.-ThepurposeofthisinputistodividetheenergyloadstoeachPV/SWHarrayrows.-Ifnotinputted,"energyLoadPerRowPerHour"outputwillnotbecalculated.

Outputs

readMe!

...

PV_SWHsurface

SurfacesonwhichPVmodules/SWHcollectorswillbelaidon.

PV_SWHsurfacesArea

TotalareaofthePV_SWHsurfaces.-InRhinodocumentsunits(meters,centimeters,feets...).

minimalSpacingDate

Exactdatetakenfrom"minimalSpacingPeriod_"inputforwhichminimalspacingbetweenrowshasbeencalculated.

arrayOriginPt

OriginpointofthePV/SWHarray.

energyLoadPerRowPerHour

"energyLoadPerHour_"input'sdatadividedtorows.

LadybugPrimer


CheckHydraExampleFilesforPVSWHSystemSize

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_PV SWH System Size

PhotovoltaicsModule

UsethiscomponenttodefinethePhotovoltaicsmodulesettings.-Ifnothinginputed,thefollowingPVmodulesettingswillbeusedbydefault:

moduleType:Close(flush)roofmountmoduleEfficiency:15%temperatureCoefficient:-0.5%/°CmoduleActiveAreaPercent:90%-

Inputs

LadybugPrimer

302Photovoltaics_Module

moduleType[Optional]

Moduletypeandmountingconfiguration:-0=Glass/cell/polymersheet,Insulatedback(pvcurtainwall,pvskylights)1=Glass/cell/glass,Close(flush)roofmount(pvarraymountedparallelandrelativelyclosetotheplaneoftheroof(between5and15centimenters))2=Glass/cell/polymersheet,Openrack(groundmountarray,flat/slopedroofarraythatistilted,pole-mountsolarpanels,solarcarports,solarcanopies)3=Glass/cell/glass,Openrack(thesameasupper"2"type,justwithaglassonthebackpartofthemodule).-Ifnotsupplied,defaulttype:"Glass/cell/glass,Close(flush)roofmount"(1)isused.

moduleEfficiency[Optional]

TheratioofelectricalenergyoutputfromthePVmoduletoinputsolarenergyfromthesun.Currenttypicalmoduleefficienciesforcrystallinesiliconmodulesrangefrom14-20%-Ifnotdefined,defaultvalueof15(%)willbeused.-Inpercent(%).

temperatureCoefficient[Optional]

Acoefficientwhichaccountsforthepercentagethesolarmodule'sDCoutputpowerdecrease/increaseforeverydegreeCelsiusthesolarcellstemperaturerisesabove/below25°C.-Ingeneralitrangesfrom-0.44to-0.5forcrystalinesiliconmodules.-Ifnotsupplied,-0.5willbeusedasadefault.-In%/°C.

moduleActiveAreaPercent[Optional]

Percentageofthemodule'sareaexcludingmoduleframingandgapsbetweencells.-Ifnotsupplied,defaultvalueof90(%)willbeused.-Inpercent(%).

Outputs

readMe!

...

PVmoduleSettings

AlistofPVmodulesettings.Plugitto"Photovoltaicssurface"component's"PVmoduleSettings_"input.

CheckHydraExampleFilesforPhotovoltaicsModule

LadybugPrimer

303Photovoltaics_Module

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Photovoltaics Module

ColdWaterTemperature

Usethiscomponenttocalculatethecold(inlet,mains)watertemperature,ifwaterpipesareburriedundeground.Sources:http://www.energy.ca.gov/2013publications/CEC-400-2013-003/CEC-400-2013-003-CMF-REV.pdfhttp://www.nrel.gov/docs/fy04osti/35917.pdfhttp://www.retscreen.net/download.php/ang/120/0/Textbook_SWH.pdf-

Inputs

method[Optional]

Amethodbywhichthecoldwatertemperaturewillbecalculated:-0-Carslawand

LadybugPrimer

304Cold_Water_Temperature

http://www.energy.ca.gov/2013publications/CEC-400-2013-003/CEC-400-2013-003-CMF-REV.pdf


http://www.retscreen.net/download.php/ang/120/0/Textbook_SWH.pdf

Jaeger(usedbyDOE-2)1-ChristensenandBurch(usedbyEnergyPlus)2-usedbyRETScreen-Ifnotsupplied,method"1"(ChristensenandBurch)willbeusedbydefault.


HourlyDryBulbTemperature(airtemperature).ImportitfromLadybug"ImportEPW"component.-In°C.

minimalTemperature[Optional]

Theminimumcoldtemperaturevalue.Forexamplethisinputcanbeusedtopreventthewaterinyourpipesfromfreezing,bylimitingitto1°C(33.8F).-Ifnotsupplied,defaultvalue1(°C)willbeused.-In°C.

soilThermalDiffusivity[Optional]

Theabilityofasoiltoconductthermalenergyrelativetoitsabilitytostorethermalenergy.-Thisinputisonlyimportantformethod"0"!!!Soiltypeformethod"1"isunknown,andcannotbechanged.The"1"formulaisderivedfromvariousfieldandsoildataaccrossUSA.Soiltypeformethod"2"isfixedto:wetclaysoil,andcannotbechanged.-Soilthermaldiffusivityforparticulartypesofsoil(m2/s10^(-7)):2.4-drysand7.4-wetsand2.5-dryclay5.1-wetclay1.0-drypeat1.2-wetpeat12.9-denserock-Ifnotsupplied,defaultvalue2.5(dryclay)willbeused.-Inm2/s10^(-7).

pipesDepth[Optional]

Thesoildepthatwhichcoldwaterpipesareburriedat.-Thisinputisonlyimportantformethod"0"!!!Pipesdepthrangeformethod"1"isfixedfrom0.3to1meters(1to3.5feet),andcannotbechanged.Pipesdepthformethod"2"isfixedto2meters,andcannotbechanged.-Ifnotsupplied,defaultvalueof1(m)willbeused.-Inmeters.

Outputs

readMe!

...

coldWaterTemperaturePerHour

ColdwatertemperatureforpickedpipesDepthandsoilThermalDiffusivity,foreachhourduringayear.-In°C.

avrJanuaryColdWaterTemperature

LadybugPrimer


AverageJanuarycoldwatertemperatureforpickedpipesDepthandsoilThermalDiffusivity.Useitfor"SWHsystem"component's"avrJanuaryColdWaterTemperature_"input.-In°C.

avrColdWaterTemperaturePerYear

AverageannualcoldwatertemperatureforpickedpipesDepthandsoilThermalDiffusivity.-In°C.

CheckHydraExampleFilesforColdWaterTemperature

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Cold Water Temperature

CommercialPublicApartmentHotWater

Usethiscomponenttocalculatedomestichotwaterconsumptionforeachhourduringayear,forCommercial,PublicandApartmentbuildings.Thefollowingtypesofbuildingsaresupported:-

officeapartmenthouseormultifamilybuildinghotel/motelrestaurants,cafeteriasdrive-ins,grilles,luncheonettes,sandwich,snackshopsprimaryschool

LadybugPrimer

307Commercial_Public_Apartment_Hot_Water

juniorandseniorhighschoolmen'sdormitorywomen'sdormitoryhospitalnursinghomefactory-Componentbasedonpaper:ASHRAE2003ApplicationsHandbook(SI),Chapter49,Servicewaterheating:https://cours.etsmtl.ca/mec735/Documents/Notes_de_cours/2012/Hiver_2012/Service_Water_heating_ASHRAE.pdf-

Inputs

epwFile[Required]

Input.epwfilepathbyusinggrasshopper's"FilePath"component.

buildingType[Required]

Choosethebuildingtypeforwhichhotwaterconsumptionwillbecalculated:-0-office1-apartmenthouse,with20orlessapartments2-apartmenthouse,from21to49apartments3-apartmenthouse,from50to74apartments4-apartmenthouse,from75to99apartments5-apartmenthouse,from100to199apartments6-apartmenthouse,morethan200apartments7-hotel/motelwith20orlessrooms8-hotel/motelfrom21to60rooms9-hotel/motelfrom61to99rooms10-hotel/motelmorethan100rooms11-(fullmeal)restaurants,cafeterias12-drive-ins,grilles,luncheonettes,sandwich,snackshops13-primaryschool14-juniorandseniorhighschool15-men'sdormitory16-women'sdormitory17-hospital18-nursinghome19-factory

numberOfUnits[Required]

Numberofunitsforupperchosen"_buildingType".Representsthenumberof:-apartmentunits:apartmenthousesoccupants:offices,elementary,junior,seniorhighschools,dormitories,hospitals,factoriesmealsperday:(fullmeal)restaurants,cafeterias;drive-ins,grilles,luncheonettes,sandwich,snackshopsbeds:nursinghomes

litersPerUnitPerDay[Optional]

Numberoflitersforasingleunitandday,basedon_buidlingType-office-3.8l/day/occupantapartmenthouse,with20orlessapartments-170l/day/apartmentapartmenthouse,from21to49apartments-159.2l/day/apartmentapartmenthouse,

LadybugPrimer


https://cours.etsmtl.ca/mec735/Documents/Notes_de_cours/2012/Hiver_2012/Service_Water_heating_ASHRAE.pdf

from50to74apartments-151.6l/day/apartmentapartmenthouse,from75to99apartments-144l/day/apartmentapartmenthouse,from100to199apartments-140.2l/day/apartmentapartmenthouse,morethan200apartments-132.7l/day/apartmenthotel/motelwith20orlessrooms-98l/day/roomhotel/motelfrom21to59rooms-75.8l/day/roomhotel/motelfrom60to99rooms-53.1l/day/roomhotel/motelmorethan100rooms-37.9l/day/room(fullmeal)restaurants,cafeterias-9.1l/day/mealdrive-in,grille,luncheonette,sandwich,snackshop-2.6l/day/mealprimaryschool-2.3l/day/pupiljuniorandseniorhighschool-6.8l/day/pupilmen'sdormitory-49.7l/day/studentwomen'sdormitory-46.6l/day/studenthospital-160l/day/patientnursinghome-69.7l/day/bedfactory-45l/day/worker-Ifnotsupplied,itwillbepickedbasedonchosen"_buildingType"and"_numberOfUnits"inputs.

occupancyStartingHour[Optional]

Anhour(from1to24)duringadayatwhichtheoccupancyofthechosen_buildingTypestarts:-office-9apartmenthouse7hotel/motel7(fullmeal)restaurant,cafeteria-7drive-in,grill,luncheonette,sandwich,snackshop-7primaryschool-9juniorandseniorhighschool-9men'sdormitory-8women'sdormitory-8hospital-1nursinghome-1factory-1-Ifnotsupplied,itwillbepickedbasedonchosen"_buildingType"input.

occupancyDuration[Optional]

Numberofadults(14yearsandolder)inhousehold.-office-9apartmenthouse-15hotel/motel-8(fullmeal)restaurant,cafeteria-12drive-in,grill,luncheonette,sandwich,snackshop-17primaryschool-7juniorandseniorhighschool-7men'sdormitory-15women'sdormitory-15hospital-24nursinghome-24factory-24-Ifnotsupplied,itwillbepickedbasedonchosen"_buildingType"input.

firstWeekStartDay[Optional]

Weekdayonwhichayearstarts(1-Monday,2-Tuesday,3-Wednesday...)-Ifnotsupplied,defaultvalue:1willbeused(yearstartsonMonday,1stJanuary).

weekendDays[Optional]

Definealistoftwoweekend(nonworking)days.ThroughouttheWorld,countrieshavedifferentdaysastheirweekenddays:-ThursdayandFriday(4,5)FridayandSaturday(5,6)SaturdayandSunday(6,7)-Ifnotsupplied,SaturdayandSunday(6,7)willbetakenasadefaultweekenddays.

holidayDays[Optional]

Listofdays(1to365)whichareholiday(nonworking)days.-Ifnotsupplied,noholiday

LadybugPrimer


dayswillbeused,withexceptionof"school"(_buildingType:13and14)wheresummer,winterandspring/autumnholidayswillbeapplied.Fornorthernhemisphere,USAschoolholidaysscheduleshavebeentakenasadefault.Forsouthernhemisphere,Australianschoolholidaysschedulehavebeentakenasadefault.

deliveryWaterTemperature[Optional]

Requiredwatertemperature.InCelsiusItisrecommendedfordeliverywatertemperaturetonotbelowerthan60°C(140°F)toavoidtheriskofLegionellapneumophilabacteriaappearance.-Ifnotsupplied,defaultvalue:60°C(140°F)willbeused.-InCelsiusdegrees.

coldWaterTemperaturePerHour[Optional]

Cold(inlet)watertemperaturesuppliedfrompublicwatersystem,foreachhourduringayear.InCelsius.Tocalculateit,usethe"coldWaterTemperaturePerHour"outputoftheLadybug"ColdWaterTemperature"component.-Ifnotsupplied,itwillbecalculatedbasedonChristensenandBurchmethod(method1from"ColdWaterTemperature"component),withpipesdepthfrom0.3to1meters,andunknownsoiltype.-InCelsiusdegrees.

runIt[Required]

...

Outputs

readMe!

...

heatingLoadPerHour

Thermalenergy(orelectricalenergy)requiredtoheatthedomestichotwaterconsumptionforeachhourduringayear.-InkWh.

hotWaterPerHour

Domestichotwaterconsumptionforeachhourduringayear.-InL/h(Liters/hour).

hotWaterPerYear

Domestichotwaterconsumptionforawholeyear.-InL(Liters).

averageDailyHotWaterPerYear

LadybugPrimer


Averagedailyhotwaterconsumptionforawholeyear.-InL/day(Liters/day).

maximumDailyConsumption

Maximalhotwaterconsumptionperdayduringayear.-In(L/day)Liters/day.

maximumConsumptionDay

Daywithmaximalhotwaterconsumption.

minimumDailyConsumption

Minimalhotwaterconsumptionperdayduringayear.-In(L/day)Liters/day.

minimumConsumptionDay

Daywithminimalhotwaterconsumption.

CheckHydraExampleFilesforCommercialPublicApartmentHotWater

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Commercial Public Apartment Hot Water

ResidentialHotWater

Usethiscomponenttocalculatedomestichotwaterconsumptionforeachhourduringayear,forasinglefamilyhousehold(house).-Componentbasedonpaper:"Modelingpatternsofhotwateruseinhouseholds",ErnestOrlandoLawrenceBerkeleyNationalLaboratory;Lutz,Liu,McMahon,Dunham,Shown,McGrue;Nov1996:http://ees.lbl.gov/sites/all/files/modeling_patterns_of_hot_water_use_in_households_lbl-37805_rev.pdf-

Inputs

epwFile[Required]

LadybugPrimer

312Residential_Hot_Water

http://ees.lbl.gov/sites/all/files/modeling_patterns_of_hot_water_use_in_households_lbl-37805_rev.pdf


totalNumberOfPersons[Required]

Totalnumberofpersonsinahousehold.

numberOfPreSchoolChildren[Optional]

Numberofpreschoolchildren(0-5)inhousehold.-Ifnotsupplied,defaultvalue:0(nopreschoolchildren)willbeused.

numberOfSchoolChildren[Optional]

Numberofschoolage(6-13)childreninhousehold.-Ifnotsupplied,defaultvalue:0(noschoolchildren)willbeused.

numberOfAdults[Optional]

Numberofadults(14yearsandolder)inhousehold.-Ifnotsupplied,itwillbeequalto_totalNumberOfPersons.

numberOfAdultsAtHome[Optional]

Numberofadultsthatstayathomeduringaday.-Ifnotsupplied,defaultvalue:0(noadultsathome)willbeused.

seniorOnly[Optional]

Senioronlyhousehold.-Ifnotsupplied,defaultvalue:False(notsenioronlyhousehold)willbeused.

dishWasher[Optional]

Ahouseholdownsadishwasher.-Ifnotsupplied,defaultvalue:True(ahouseholdownsadishwasher)willbeused.

clothsWasher[Optional]

Ahouseholdownsaclothswasher.-Ifnotsupplied,defaultvalue:True(ahouseholdownsaclothswasher)willbeused.

payUtilityBill[Optional]

Householdoccupantspayautilitybill.Tenantswhopaytheirownutilitybillsingeneral,tendtospendless,thenthosewhodonot.-Ifnotsupplied,defaultvalue:True(householdoccupantspaytheirutilitybill)willbeused.

LadybugPrimer


firstWeekStartDay[Optional]

Adayofweekonwhichayearstarts(1-Monday,2-Tuesday,3-Wednesday...)-Ifnotsupplied,defaultvalue:1willbeused(yearstartsonMonday,1stJanuary).

weekendDays[Optional]

Definealistoftwoweekend(nonworking)days.ThroughouttheWorld,countrieshavedifferentdaysastheirweekenddays:-ThursdayandFriday(4,5)FridayandSaturday(5,6)SaturdayandSunday(6,7)-Ifnotsupplied,SaturdayandSunday(6,7)willbetakenasadefaultweekenddays.

holidayDays[Optional]

Listofdays(1to365)whichareholiday(nonworking)days.-HereisanexampleholidaydayslistforAugust:213,214,215,216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243-Ifnotsupplied,noholidaydayswillbeused.


Required(set)watertemperature.Itisrecommendedfordeliverywatertemperaturetonotbelowerthan60°C(140°F)toavoidtheriskofpropagationofLegionellapneumophilabacteria.-Electricwaterheaterusedasadefault.-Ifnotsupplied,defaultvalue:60°C(140°F)willbeused.-InCelsiusdegrees.

coldWaterTemperaturePerHour[Optional]

Cold(inlet)watertemperaturesuppliedfrompublicwatersystem,foreachhourduringayear.InCelsius.Tocalculateit,usethe"coldWaterTemperaturePerHour"outputoftheLadybug"ColdWaterTemperature"component.-Ifnotsupplied,itwillbecalculatedbasedonChristensenandBurchmethod(method1from"ColdWaterTemperature"component),withpipesdepthfrom0.3to1meters,andunknownsoiltype.-InCelsiusdegrees.

runIt[Required]

...

Outputs

readMe!

...

LadybugPrimer


heatingLoadPerHour

Thermalenergy(orelectricalenergy)requiredtoheatthedomestichotwaterconsumptionforeachhourduringayear.-InkWh.

hotWaterPerHour

Domestichotwaterconsumptionforeachhourduringayear.-InL/h(Liters/hour).

hotWaterPerYear

Domestichotwaterconsumptionforawholeyear.-InL(Liters).

averageDailyHotWaterPerYear

Averagedailyhotwaterconsumptionforawholeyear.-InL/day(Liters/day).

maximumDailyConsumption

Maximalhotwaterconsumptionperdayduringayear.-In(L/day)Liters/day.

maximumConsumptionDay

Daywithmaximalhotwaterconsumption.

minimumDailyConsumption

Minimalhotwaterconsumptionperdayduringayear.-In(L/day)Liters/day.

minimumConsumptionDay

Daywithminimalhotwaterconsumption.

CheckHydraExampleFilesforResidentialHotWater

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Residential Hot Water

SolarWaterHeatingPerformanceMetrics

UsethiscomponenttocalculatevariousSolarwaterheatingperformancemetrics.AlsouseittocalculatetheoptimalSWHsystemsizeandtankstoragevolume.-

Inputs

SWHsurface[Required]

Usethesame"_SWHsurface"yousuppliedtothe"SolarWaterHeatingSurface"component.

LadybugPrimer

316Solar_Water_Heating_Performance_Metrics

SWHsurfacePercent[Optional]

ThepercentageofsurfacewhichwillbeusedforSWHcollectors(range0-100).-Therearenogeneralrulesorcodeswhichwouldlimitthepercentageoftheroof(surface)coveredwithSWHcollectors.-Ifnotsupplied,defaultvalueof100(allsurfaceareawillbecoveredinSWHcollectors)isused.-Inpercent(%).

SWHsystemSettings[Optional]

AlistofallSolarwaterheatingsystemsettings.Usethesame"SWHsystemSettings_"yousuppliedtothe"SolarWaterHeatingSurface"component.-Ifnotsupplied,thefollowingswhsystemsettingswillbeusedbydefault:

glazedflatplatecollectorsactiveclosedlooppipelength:20metersunshaded

heatingLoadPerHour[Required]

Usethesame"_heatingLoadHour"yousuppliedtothe"SolarWaterHeatingSurface"component.-InkWh.

heatFromTankPerHour[Required]

Import"heatFromTankPerHour"outputdatafrom"Solarwaterheatingsurface"component.-InkWh.

heatFromAuxiliaryHeaterPerHour[Required]

Import"heatFromAuxiliaryHeaterPerHour"outputdatafrom"Solarwaterheatingsurface"component.-InkWh.

pumpEnergyPerHour[Required]

Import"pumpEnergyPerHour"outputdatafrom"Solarwaterheatingsurface"component.-InkWh.

energyCostPerKWh[Optional]

Thecostofonekilowatthourinanycurrencyunit(dollar,euro,yuan...)-Ifnotsupplied,0.15$/kWhwillbeusedasdefaultvalue.-Incurrency/kWh.

collectorEmbodiedEnergyPerM2[Optional]

Energynecessaryforproductlife-cycleofSWHcollectorpersquaremeter.-Ifnot

LadybugPrimer


supplieddefaultvalueof1135(MJ/m2)forunglazedorglazedflatplatecollectorwillbeused.-InMJ/m2(megajoulespersquaremeter).

tankEmbodiedEnergyPerL[Optional]

Energynecessaryforproductlife-cycleofstoragetankperliter.-Ifnotsupplieddefaultvalueof20(MJ/l)willbeused.-InMJ/l(megajoulesperliter).

collectorEmbodiedCO2PerM2[Optional]

CarbonemissionsproducedduringSWHcollector'slife-cyclepersquaremeter..-Ifnotsupplieddefaultvalueof65.5(kgCO2/m2)forunglazedorglazedflatplatecollectorwillbeused.-InkgCO2/m2(kilogramofCO2persquaremeter).

tankEmbodiedCO2PerL[Optional]

Carbonemissionsproducedduringstoragetank'slife-cycleperliter.-Ifnotsupplieddefaultvalueof0.14(kgCO2/l)forunglazedorglazedflatplatecollectorwillbeused.-InkgCO2/l(kilogramofCO2perliter).

collectorLifetime[Optional]

LifeexpectancyofaSWHcollector.-Ifnotsupplieddefaultvalueof15(years)willbeused.-Inyears.

tankLifetime[Optional]

Lifeexpectancyofastoragetank.-Ifnotsupplieddefaultvalueof10(years)willbeused.-Inyears.

optimal[Optional]

Setto"True"tocalculateoptimalsystemsizeandtankstoragevolume.-Largersystemsizesandtankvolumesproducemoreenergy,thereforcovermoreinitialheatingload,whichresultsinlessusageofauxiliaryenergy.However,thelargerthesystemsizeandtankvolume,moreembodiedenergyisspent.Inordertofindanoptimalsystemsize(totalsizeofallcollectors)andstoragetankvolume,life-cycleenergyanalysisisusedtoacheivethemaximalnetenergysavingoftheswhsystem.ThenetenergysavingofswhsystemistheenergysavinginkWhremainedafteranannualizedembodiedenergy(ofcollectorsorstoragetank)hasbeendeductedfromtheoperatingenergysavingofswhsystem.Thismethodofoptimizationissuperiorincomparisonwithothersimulation-basedmethodsduetoconsiderationofallenergyperformancestages(production,operation,maintenance...).-Thisoptimizationmethodcanbeusedtoaccountforcapitalcosts,insteadofembodiedenergy.Thiswouldaccountonlyfor

LadybugPrimer


operationperformancestage.Inthiscasecapitalcostsofcollector/persquaremeter,andtank/perliterwouldneedtobeinputtedinto:"collectorEmbodiedEnergyPerM2"and"tankEmbodiedEnergyPerL"inputs.-Optimizationanalysisbasedonthelawofdiminishingmarginalutility:"Asimplifiedmethodforoptimaldesignofsolarwaterheatingsystemsbasedonlife-cycleenergyanalysis",RenewableEnergyjournal,Yan,Wang,Ma,Shi,Vol74,Feb2015www.sciencedirect.com/science/article/pii/S0960148114004807

runIt[Required]

...

Outputs

readMe!

...

optimalSystemSize

OptimalSWHsystemsize(optimaltotalsizeofSWHcollector'sarray)foragivenSWHsurface'stilt,arrayand"heatingLoadHour".MinimumSWHsystemsizeis0.15kWt.Inputitto"systemSize"inputof"PVSWHsystemsize"componenttoseehowmuchareaitwouldrequire.-Tocalculateit,setthe"optimal_"inputto"True".-InthermalkiloWatts(kWt).

optimalTankSize

Solarwaterheatingstoragetankoptimalsize(volume).Minimumsizeis100liters.Tocalculateit,setthe"optimal_"inputto"True".-Inliters.

SEF

SolarEnergyFactor-ratiooftotalenergyprovidedbytheswhsystemtoauxiliaryplusparasitic(circulationpump)energyforawholeyear.-Unitless.

SolarFractionPerMonth

SolarFraction(orSolarSavingsFraction)-percentageoftheheatingloadrequirementthatisprovidedbyaswhsystemforeachmonthduringayear.Itrangesfrom0to100%.-Inpercent(%).

SolarFractionPerYear

SolarFraction(orSolarSavingsFraction)-percentageofthetotalheatingload

LadybugPrimer


requirementthatisprovidedbyaswhsystemforawholeyear.Itrangesfrom0to100%.-Inpercent(%).

energyValue

TotalEnergyvaluegeneratedbySWHsystemforawholeyearincurrencyunit(dollars,euros,yuans...)

EROI

EnergyReturnOnInvestment-acomparisonofthegeneratedelectricitytotheamountofprimaryenergyusedthroughouttheSWHcollector'sproductlife-cycle.-Unitless.

embodiedEnergy

Totalenergynecessaryforanentireproductlife-cycleofSWHcollectorsandstoragetank.-InGJ(gigajoules).

embodiedCO2

TotalcarbonemissionsproducedduringSWHcollectorandstoragetanklife-cycle.-IntCO2(tonsofCO2).

CO2emissionRate

AlsocalledEmbodiedGHGemissionsorGHGEmissions.AnindexwhichshowshoweffectiveaSWHsystemisintermsofglobalwarming.Itisusedincomparisonwithotherfuelsandtechnologies(Hydroelectricity(15),Wind(21),Nuclear(60),Geothermalpower(91),Naturalgas(577),Oil(893),Coal(955)...)-IngCO2/kWh.

EPBT

EnergyPayBackTime-timeittakesforSWHsystemtoproducealltheenergyusedthrough-outitscollector'sproductlife-cycle.-Inyears.

CheckHydraExampleFilesforSolarWaterHeatingPerformanceMetrics

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Solar Water Heating Performance Metrics

SolarWaterHeatingSurface

UsethiscomponenttocalculateamountofthermalenergythatcanbeproducedbyasurfaceifacertainpercentageofitiscoveredwithSolarwaterheatingliquidcollectors.Thethermalenergycanthenbeusedfordomestichotwater,spaceheatingorspacecooling.-Componentbasedon:"SolarEngineeringofThermalProcesses",JohnWileyandSons,J.Duffie,W.Beckman,4thed.,2013."TechnicalManualfortheSAMSolarWaterHeatingModel",NREL,N.DiOrio,C.Christensen,J.Burch,A.Dobos,2014."Asimplifiedmethodforoptimaldesignofsolarwaterheatingsystemsbasedonlife-cycleenergyanalysis",RenewableEnergyjournal,Yan,Wang,Ma,Shi,Vol74,Feb2015-http://www.wiley.com/WileyCDA/WileyTitle/productCd-0470873663.html

LadybugPrimer

321Solar_Water_Heating_Surface

http://www.wiley.com/WileyCDA/WileyTitle/productCd-0470873663.html

https://sam.nrel.gov/system/tdf/SimpleSolarWaterHeatingModel_SAM_0.pdf?file=1&type=node&id=69521http://www.sciencedirect.com/science/article/pii/S0960148114004807-

Inputs

epwFile[Required]


heatingLoadPerHour[Required]

Heatingloadinelectricalenergyforeachhourduringayear.InkWh.Itrepresentsdomestichotwaterheatingload.Withaddedspaceheatingand/orspacecoolingheatingloads.-Tocalculatedomestichotwaterheatingload,useLadybug"ResidentialHotWater"or"CommercialPublicApartmentHotWater"components.-SpaceheatingandspacecoolingloadscanbeinputtedfromHoneybee's"ReadEPResult"component.Divideeachvalueofspaceheatingloadwith0.7,toaccountforCOP(coefficientofperformance)oftheheatingsystem.Spacecoolingvaluesdonotneedtobedividedwithanything(COP=1.0).

SWHsurface[Required]

InputplanarSurface(notpolysurface)onwhichtheSWHcollectorswillbeapplied.Ifyouhaveapolysurface,explodeit(using"DeconstructBrep"component)andthenfeeditsFaces(F)outputto_SWHsurface.Surfacenormalshouldbefacedtowardsthesun.

OrcreatetheSurfacebasedoninitialSWHsystemsizebyusing"PVSWHsystemsize"component.

SWHsurfacePercent[Optional]

ThepercentageofsurfacewhichwillbeusedforSWHcollectors(range0-100).-Therearenogeneralrulesorcodeswhichwouldlimitthepercentageoftheroof(surface)coveredwithSWHcollectors.-Ifnotsupplied,defaultvalueof100(allsurfaceareawillbecoveredwithSWHcollectors)isused.

SWHsystemSettings[Optional]

AlistofallSolarwaterheatingsystemsettings.Usethe"SolarWaterHeatingSystem"or"SolarWaterHeatingSystemDetailed"componentstogeneratethem.-Ifnotsupplied,thefollowingswhsystemsettingswillbeusedbydefault:

glazedflatplatecollectorsactive

LadybugPrimer


https://sam.nrel.gov/system/tdf/SimpleSolarWaterHeatingModel_SAM_0.pdf?file=1&type=node&id=69521

http://www.sciencedirect.com/science/article/pii/S0960148114004807

closedlooppipelength:20metersunshaded

north[Optional]

InputavectortobeusedasatrueNorthdirectionforthesunpath,oranumberbetween0and360thatrepresentstheclockwisedegreesofffromtheY-axistomakeNorth.-Ifnotsupplied,defaultNorthdirectionwillbesettotheY-axis(0degrees).

albedo[Optional]



AnoptionallistofhourlydatafromLadybug's"Importepw"component(e.g.dryBulbTemperature),whichwillbeusedfor"conditionalStatement_".


ThisinputallowsuserstocalculatetheSolarwaterheatingsurfacecomponentresultsonlyforthoseannualHourlyDatavalueswhichfitspecificconditionsorcriteria.Tousethisinputcorrectly,hourlydata,suchasdryBulbTemperatureorwindSpeed,mustbepluggedintothe"annualHourlyData"input.TheconditionalstatementinputhereshouldbeavalidconditionstatementinPython,suchas"a>25"or"b<3"(without=""the=""quotation=""marks).=""conditionalStatement_=""accepts="""and"=""and="""or"=""operators.=""To=""visualize=""hourly=""data,=""English=""letters=""should=""be=""used=""as=""variables,=""each=""letter=""alphabetically=""corresponds=""to=""of=""lists=""(in=""their=""respective=""order):="""a"=""always=""represents=""1st=""list,="""b"=""2nd=""etc.=""-=""For=""example,=""if=""you=""have=""an=""dryBulbTemperature=""connected=""first=""windSpeed=""second=""list=""(both=""annualHourlyData_=""input),=""want=""plot=""data=""for=""time=""period=""when=""temperature=""is=""between=""18°C=""23°C,=""larger=""than=""3m=""s,=""written="""183"(withoutthequotationmarks).-Thisinputcanalsobeusedforanalysisofdrainbacksystems.Inputa"dryBulbTemperature"datafrom"Importepw"componentintoupper"annualHourlyData"input.Theninput"a>5"tothis("conditionalStatement")input.

LadybugPrimer


runIt[Required]

...

Outputs

readMe!

...

heatFromTankPerHour

Thermalenergyprovidedbythestoragetankpereachhourduringayear.-InkWh.

heatFromTankPerYear

Totalthermalenergyprovidedbythestoragetankforawholeyear.-InkWh.

avrDailyheatFromTankPerYear

Anaveragethermalenergyprovidedbythestoragetankperdayforawholeyear.-InkWh/day.

heatFromAuxiliaryHeaterPerHour

ThermalenergyprovidedandElectricalenergyspentbyanauxiliaryheaterpereachhourduringayear.Electricauxiliaryheaterused.-InkWh.

dischargedHeatPerHour

Dischargedsurplusenergy("heatdump")pereachhourduringayear.Itcanbeusedtoheatapool,hottub,greenhouseorassnow-meltsystem(byusingradiantfloortubingbellowsidewalks,orradiatiorbeneaththeentrancestairs).-InkWh.

pumpEnergyPerHour

Electricalenergyspentbythecirculationpump(s)perhourduringayear.-InkWh.

tankWaterTemperaturePerHour

Tankwatertemperaturepereachhourduringayear.-In°C.

SWHsurfaceTiltAngle

TheanglefromhorizontaloftheinclinationoftheSWHsurface.Example:0=horizontal,90=vertical.Itrangesfrom0-180.-Indegrees.

LadybugPrimer


SWHsurfaceAzimuthAngle

Theorientationangle(clockwisefromthetruenorth)oftheSWHsurfacenormalvector.Itrangesfrom0-360.-Indegrees.

systemSize

RatedSWHsystemsize.-InkWt.

CheckHydraExampleFilesforSolarWaterHeatingSurface

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Solar Water Heating Surface

SolarWaterHeatingSystem

UsethiscomponenttodefineSolarwaterheatingsystemsettings.-Ifnothinginputed,thefollowingswhsystemwillbeusedbydefault:

glazedflatplatecollectorsactiveclosedloop1storyunshaded-

Inputs

LadybugPrimer

326Solar_Water_Heating_System

collectorType[Optional]

Typeofthecollector.Thefollowingonescanbeused:-0-unglazedflatplateLeastexpensive.Mostlyusedforsinglehomedomestichowwaterheatingandforheatingswimmingpools.Morecostefficientintropicalandsubtropicalenvironments.Theycanalsobeusedinmoderateclimatesforseasonalusage.Canoutputwatertemperaturesupto30°C(86°F).-1-glazedflatplateLessexpensive.Morecostefficientinwarmandmild-warmclimates.Butalsousedintemperateclimates.Mostlyusedforsinglehomedomestichowwaterheating,spaceheatingandspacecooling.Andforheatingswimmingpools.Canoutputwatertemperaturesupto60°C(140°F).-2-evacuatedtubeThemostexpensive.Morecostefficientincoldtemperateandcoldclimates(withlowambienttemperature,forexample:duringwinter)andduringovercastskies.Evacuatedtubecollectors(orconcentratingcollectors)aretypicallyusedforindustrialapplications,ormultiresidentialorcommercialbuildingsforspaceheatingandspacecooling.Canoutputwatertemperatureshigherthan90°C(194°F)degrees,upto177°C(350°F).--Ifnotsupplied,glazedflatplatecollectors(1)willbeused.

activeSWHsystem[Optional]

Definewhethertheswhsystemisactive(pumped)orpassive(notpumped).-0-passive(notpumped)swhsystemLessexpensive.Moreefficientinwarmandmild-warmclimates.Doesnotrequireelectricitytooperate.Isusedfordomestichotwaterheatingandspaceheatingofasinglehome.Ifpositionedonaroofrequireputtingastoragetankabovethecollector,andthereforimposetheroofconstructiontobeabletocarrytheweightofthestoragetank.SWHsurfacecomponentsupportspassiveswhsystemswithauxiliaryheater.-1-active(pumped)swhsystemMoreexpensive.Moreefficientintemperateandcoldclimates.Requireelectricitytooperateandbatteryback-upincaseofpoweroutage.Canbeusedfordomestichotwaterheating,spaceheatingandspacecoolingofasinglehome,buildingorseveralbuildings(centralheating).Moreefficientinwarmandmild-warmclimates,whereitrarelyfreezes--Ifnotsupplied,active(pumped)loopwillbeused.

openLoop[Optional]

Definewhethertheswhsystemhasanopen(indirect)orclosed(indirect)solarloop.-0-closed(indirect)loopUsageofheatexchanger.Antifreezeisaworkingfluid.Moreexpensive.Moreefficientintemperateandcoldclimateswherefreezingmayoccur.Alsosuitableforlocationswithhardwaterhardness(mineralcontent).-1-open(direct)loopNousageofheatexchangers.Wateristheworkingfluid.Lessexpensive.Moreefficientinwarmandmild-warmclimates,whereitrarelyfreezes(airtemperatureneverdropsbelow5°C(41°F)degrees).Onlysuitableforlocationswithlowwaterhardness(mineralcontent)otherwiselimescalewillforminsolarcollectors.--Ifnotsupplied,

LadybugPrimer


closed(indirect)loopwillbeused.

numberOfStories[Optional]

Totalnumberofstoriesplusbasement(ifthereisabasement).Thisinputisusedtocalculatethetotalpipinglengthinthesolarloop,basedonanassumptionthatthestoragetankwillbelocatedattheloweststory(basementorgroundfloor),andsolarcollectorsarelocatedattheroof.-Example1:ahousewithagroundfloor,firstfloorandabasement-has3storiestotal.Example2:ahousewithagroundfloor,firstfloor,secondfloorandwithoutabasement-has3storiestotal.-Ifsollarcollectorsareusedonagroundinsteadofroof,usethe"SolarWaterHeatingSystemDetailed"componentinsteadofthisonetoentertheexactpipelengthofthesolarloop.--Ifnotsupplied,"1"storywillbeusedasadefaultvalue(ahousewithonlyagroundfloor,withoutabasement).

skyViewFactor[Optional]

ContinuousSkyViewFactor-portionofthevisiblesky(dome).Itdefinestheshadingofthepartsofdiffuseirradiance.Itrangesfrom0to1.Importitfrom"Sunpathshading"component's"skyViewFactor"output.-Ifnotsupplied,1willbeusedasadefaultvalue(SWHsurfaceisunshaded).-Unitless.

beamIndexPerHour[Optional]

Transmissionindexofbeam(direct)irradianceforeachhourduringayear.Itrangesfrom0-1.Importitfrom"Sunpathshading"component's"beamIndexPerHour"output.-Ifnotsupplied,avalueof1foreachhourduringayear,willbeused(SWHsurfaceisunshaded).-Unitless.

Outputs

readMe!

...

SWHsystemSettings

AlistofallSolarwaterheatingsystemsettings.PlugittoSWHsurfacecomponent's"SWHsystemSettings_"input.

CheckHydraExampleFilesforSolarWaterHeatingSystem

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Solar Water Heating System

SolarWaterHeatingSystemDetailed

UsethiscomponenttodefineadetailedSolarwaterheatingsystemsettings.-Ifnothinginputed,thefollowingswhsystemwillbeusedbydefault:

glazedflatplatecollectorsactiveclosedlooppipelength:20metersunshaded-

Inputs

LadybugPrimer

329Solar_Water_Heating_System_Detailed

collectorOpticalEfficiency[Optional]

Fr(taualpha)Collector'sopticalefficiencycoefficient.AlsocalledCollectorheatremovalfactor.Variesbasedoncollector'stype.Somedefaultvaluesbytype:-0.87-unglazedflatplate0.70-glazedflatplate0.50-evacuatedtube-Ifnotsupplied,defaultvalue0.70(glazedflatplate)willbeused.-Unitless.

collectorThermalLoss[Optional]

(FrUL)Collector'sthermallosscoefficient.Variesbasedoncollector'stype.Somedefaultvaluesbytype:-21-unglazedflatplate4-glazedflatplate1.5-evacuatedtube-Ifnotsupplied,defaultvalue4(glazedflatplate)willbeused.-InW/m2/°C.

collectorActiveAreaPercent[Optional]

Percentageofthecollector'sareaexcludingcollectorframing,lateralinsulation,orgapsbetweenevacuatedtubes...Alsocalledaperturearea.Itrangesfrom70to95%dependingonthetypeofcollector.-Ifnotsupplied,defaultvalueof90(%)willbeused.-Inpercent.

workingFluidHeatCapacity[Optional]

Specificheatoftheworkingfluid.-Ifswhsystemisintendedtobeusedinanon-freezingorlightfreezingclimate(tropicalandsubtropicalregions),thenwatershouldbeusedasaworkingfluid.Thespecificheatofwateris:4180J/kg/°C.-Ifswhsystemisusedinfreezingclimates(temperate,polar...),anantifreezeneedstobeaddedtothewater.InmostcasesthisisPropylenglycol,EthylenglycolorBioglycoladdedincertainpercentagestothewater.Dependingonthefreezingtemperaturesoftheclimates,therearethefollowingspecificheatsofwater-glycolmixtures:upto-10°C:water-propylenglycol25%:4080J/kg/°C.upto-10°C:water-ethylenglycol20%:4020J/kg/°C.upto-20°C:water-propylenglycol38%:4000J/kg/°C.upto-20°C:water-ethylenglycol34%:3840J/kg/°C.upto-30°C:water-propylenglycol47%:3890J/kg/°C.upto-40°C:water-ethylenglycol52%:3560J/kg/°C.-Ifnotsupplied3840(water-ethylenglycol34%)J/kg/°Cwillbeused.-InJ/kg/°C.

flowRatePerM2[Optional]

Testflowrateofworkingfluidthroughthecollectorpersquaremeterofcollector'sarea.Thehighertheflowrate,thehigherthecollectorefficiencyis.Ontheotherhandhigherflowratesrequiremorepumppower,largerpipediametersandcancauseerosioncorrosion.-Ifnotsupplied,avalueof0.012kg/s/m2willbeused.-Inkg/s/m2.

IAMcoefficient[Optional]

LadybugPrimer


Incidenceanglemodifiercoefficient(bo)-Usethisinputtoaccountforcollectorefficiencylossesduetodifferentanglesofincidence.Dependsonthetypeofcollector,tiltangle...Somedefaultvaluesdependingonthetypeofcollector:-0.1-glazedflatplate0.1-unglazedflatplate-0.05-evacuatedtube-Ifnotsupplied,0.1(glazedflatplate)willbeused.-Unitless.

skyViewFactor[Optional]

ContinuousSkyViewFactor-portionofthevisiblesky(dome).Itdefinestheshadingofthepartsofdiffuseirradiance.Itrangesfrom0to1.Importitfrom"Sunpathshading"component's"skyViewFactor"output.-Ifnotsupplied,1willbeusedasadefaultvalue(SWHsurfaceisunshaded).-Unitless.

beamIndexPerHour[Optional]

Transmissionindexofbeam(direct)irradianceforeachhourduringayear.Itrangesfrom0-1.Importitfrom"Sunpathshading"component's"beamIndexPerHour"output.-Ifnotsupplied,avalueof1foreachhourduringayear,willbeused(SWHsurfaceisunshaded).-Unitless.

maxWorkingTemperature[Optional]

Maximalworkingtemperatureofthetankstorage.Itisusedtopreventtheoverheatingproblemsanddamageoftheswhsystemduetoexceedanceofallowabletemperature(andpressure)andappearanceoffluidboiling.Dependsonthequalityofpipes,valves,tank,workingfluidtype...Generallyrangesfrom93-99°C.-Ifnotsupplied95°C(203°F)willbeused.-In°C.

dischargeTemperature[Optional]

Storagetanktemperatureatwhichthedischargeoftheexcessheatandcoldwatermakeupstops.Itisgenerally2-3°Cdegreeslessthanmaximalworkingtemperature.-IfnotsuppliedmaxWorkingTemperature-3°Cwillbeused.-In°C.


Waterheaterlowerthermostatsetting.Dependsonthetypeofusageofsolarhotwatersystem.InCelsiusFordomestichotwater,itisrecommendednotbelowerthan60°C(140°F).Forspaceheating,itvariesfrom33to82°C(90to180°F)dependingonthetype(in-floortubes,radiators/baseboards,heatexchangerinsideaforced-airheater).Forspacecoolingitvariesfrom60to80°C(140to176°F)dependingonthecoolingsystemused.-Ifnotsupplied,defaultvalue:60°C(140°F)willbeused.-In°C.

avrJanuaryColdWaterTemperature[Optional]

LadybugPrimer


AverageJanuarycoldwaterinlettemperature.Thisisthetemperatureofthewaterfromthelocalpipegrid.Inputitfromfirstitemof"ColdWaterTemperature"component's"avrColdWaterTemperaturePerMonth"output.-Ifnotsupplieditwillbecalculatedforthefollowinginputdata:method"1"(ChristensenandBurch),pipesdepthfrom0.3to1meters.-In°C.

mechanicalRoomTemperature[Optional]

Temperatureoftheroomwherethestoragetankwillbelocated.Thisinputacceptslistofvalues(8760valuesor8767withheadingincluded)orasinglevalue.Ifyouinputasinglevalue,thismeansthatforeach8760hoursduringayear,themechanicalRoomTemperaturewillcorrespondtothatinputtedvalue.-Incaseyourstoragetankislocatedoutside,notinsidethebuilding(thermosyphon,ics-batchswhsystemsoractiveswhsystems),supplythe"dryBulbTemperature"datafromLadybug's"Importepw"componentto"mechanicalRoomTemperature_"input.-Ifnotsupplied,avalueof20°Cdegreeswillbeusedforeachhourduringayear(meaning:storagetankislocatedinsidethebuilding).-In°C.

pipeLength[Optional]

Totalpipeslengthruninthesolarloop.-Ifcollectorsarelocatedontheroof:aruleofathumbistoadd10metersforeachstory(basementiscalculatedasastorytoo)andadditionally10metersfortheroof.Forexample:fora3storybuildingwithabasement(basement,groundfloor,firstfloor,secondfloor,roof),ifstoragetankislocatedinthebasementandcollectorsareontheroof,thepipinglengthwouldbe:4stories*10m+10m(ontheroof)=50m.-Ifcollectorsarelocatedontheground,onewouldhavetoestimatethedistancefromthehousetocollectorsandmultiplyitby2(supplypipesgotocollectorsandreturnonesfromthem).-Ifnothinginputted,adefaultvalueof20meterswillbeused(Groundstoryhousewithoutabasement.Collectorsarelocatedonaroof,thestoragetankisatthegroundstory).-Inmeters.

pipeDiameter[Optional]

Averagepipesinnerdiameter,inmilimeters.Dependsonoverallcollectorarea,workingfluidtype,pipinglength...-Ifnotsupplied,foractiveswhsystems,itwillbecalculatedas:√(4flowRatePerM2collectorActiveArea/flowSpeed/pi),withflowSpeedassumedtobe0.7liters/sec.-Forpassiveswhsystemsas:1.5timesthevalueofupperformula.-Inmillimetres.

pipeInsulationThickness[Optional]

Thicknessofthepipesinsulation,inmilimeters.Forpipeswithinsulationthermalconductivitylowerthan0.04W/(m*K),basedonpipeDiameter,thefollowinginsulation

LadybugPrimer


thicknessescanbeused:-20mm-pipeDiameter<22mm25mm-pipeDiameter22to28mm30mm-pipeDiameter28to42mmequaltopipeDiameter-pipeDiameter42to100mm100mm-pipeDiameter>100mm-Ifnotsupplied,itwillbecalculatebasedonpipeDiameteranduppercriteria.-Inmillimetres.

pipeInsulationConductivity[Optional]

Pipe'sinsulationthermalconductivity(kvalue).Dependsonthetypeofinsulationmaterialused.Somecommonsolarpipinginsulationmaterialsare:-0.33-Polyethylene(PEL)0.04-Glasswool0.027-Polyurethane(PUR)=0.0270.0245-EthylenePropyleneDieneRubber(EPDM,EPT)0.023-Plyisocyanurate(PIR)=0.023-Ifnotsupplied,0.027(Polyurethane)willbeusedasadefaultvalue.-InW/(m*°C).

pumpPower[Optional]

Overallcirculationpumpspower.InSWHsystems,therearetypicallytwopumps:solarandstoragetankones.-CirculationpumpspowerdependsonSWHactivearea,flowrate,workingfluid,pipelengthanditsdisposition...Generallytheyrangefrom30Wforsmallswhsystem,uptoacoupleofhundredsforlargeones(SWHactivearea>30m2)-Incaseofpassivecirculation(thermosyphon,ICSorbatchsystems),setthepumpPowerto0.-Ifnotsupplied,itwillbecalculatedbasedonSWHsurfaceactivearea(that's"Surfaceactivearea"fromSWHsurfacecomponent's"readMe!"output)andpipeLength.-InWatts.

pumpEfficiency[Optional]

Circulationpumpsefficiency(ni)-ratiobetweenhydraulicandsupplied,electricalpower.Rangesfrom0.5to0.95dependingonthetype,andsizeofthecirculationpump.-Ifnotsupplied,0.85willbeused.-Unitless.

tankSize[Optional]

Storagetankvolumeinliters.ItvariesdependingonheatingloadandSWHsurfacearea.-Ifnotsupplied,adefaultvalueequalto1.5*dailyaveragehotwaterconsumptionperyear(with100litersminimum),willbeused.-InLiters.

tankLoss[Optional]

Storagetank'sheatlosscoefficient(U).Variesfrom0.30to0.50dependingonthetankvolume,insulationtype,thickness...-Ifnotsupplied,defaultvalue0.30willbeused.-InW/m2/°C.

heightDiameterTankRatio[Optional]

LadybugPrimer


Storagetankheightanddiameterratio.Itmostlyrangesfrom1to3.Thisinputisimportantforcalculationoftank'sarea.-Ifnotsupplied2.6willbeused.-Unitless.

heatExchangerEffectiveness[Optional]

Dependsonthetypeofheatexchanger:itstransfercoefficient,surface,flowrates,workingfluid...Itmostlyrangesfrom0.6to0.9forclosed(indirect)loopswhsystems.Accepteddefaultvaluecanbe0.8.-Setitto1.0incaseofopen(direct)loopswhsystem(noheatexchangerisused).-Ifnotsupplieditwillbesetto0.8.-Unitless.

Outputs

readMe!

...

SWHsystemSettings

AlistofallSolarwaterheatingsystemsettings.PlugittoSWHsurfacecomponent's"SWHsystemSettings_"input.

CheckHydraExampleFilesforSolarWaterHeatingSystemDetailed

LadybugPrimer


https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Solar Water Heating System Detailed

ShadingMask

Usethiscomponenttoseetheportionoftheskydomethatismaskedbycontextgeometryaroundagivenviewpoint.Thecomponentwillgenerateseparatemeshsfortheportionsoftheskydomethataremaskedandvisible.Thecomponentwillalsocalculatethepercentageoftheskythatismaskedbythecontextgeometryandthepercentagethatisvisible(theskyviewfactor).-

Inputs

testPt[Required]

LadybugPrimer

335Shading_Mask

Aviewpointforwhichonewantstoseetheportionoftheskymaskedbythecontextgeometrysurroundingthispoint.

context[Required]

Contextgeometrysurroundingthe_testPtthatcouldblocktheviewtothesky.GeometrymustbeaBreporlistofBreps.

skyDensity[Default]

Anintegerthatisgreaterthanorequalto0,whichtosetsthenumberoftimesthattheTergenzaskypatchesaresplit.Setto0toviewaskymaskwiththetypicalTregenzasky,whichwilldivideuptheskywithacoarsedensityof145skypatches.Setto1toviewaskymaskofaReinhartsky,whichwilldivideupeachoftheseTergenzapatchesinto4patchestomakeaskywithatotalof580skypatches.Highernumbersinputherewillensureagreateraccuracybutwillalsotakelonger.Thedefaultissetto3togiveyouahighaccuracy.

scale[Optional]

Scaleoftheskydome

Outputs

masked

Ameshoftheportionoftheskydomemaskedbythe_contextgeometry.

visible

Ameshoftheportionoftheskydomevisiblebythe_testPtthroughthe_contextgeometry.

percMasked

Thepercentageoftheskymaskedbythe_contextgeometryatthe_testPt.

skyView

Thepercentageoftheskyvisiblebythe_testPtthroughthe_contextgeometry.

CheckHydraExampleFilesforShadingMask

LadybugPrimer

336Shading_Mask

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Shading Mask

ShadingMask_II

Usethiscomponenttoseetheportionoftheskydomethatismaskedbycontextgeometryaroundagivenviewpoint.Thecomponentwillgenerateseparatemeshsfortheportionsoftheskydomethataremaskedandvisible.Thecomponentwillalsocalculatethepercentageoftheskythatismaskedbythecontextgeometryandthepercentagethatisvisible(theskyviewfactor).-

Inputs

testPt[Required]

LadybugPrimer

337Shading_Mask_II

Aviewpointforwhichonewantstoseetheportionoftheskymaskedbythecontextgeometrysurroundingthispoint.

context[Required]

Contextgeometrysurroundingthe_testPtthatcouldblocktheviewtothesky.GeometrymustbeaBreporlistofBreps.

radius[Optional]

Scaleoftheskydome

merge[Optional]

ScriptvariableshadingMask

Outputs

maskedSrfOnGound

ScriptvariablePython

maskedCrvsOnSky

ScriptvariableshadingMask

maskedSkyDome

ScriptvariableshadingMaskII

unmaskedSkyDome

ScriptvariableshadingMaskII

CheckHydraExampleFilesforShadingMask_II

LadybugPrimer

338Shading_Mask_II

https://hydrashare.github.io/hydra/index.html?keywords=Ladybug_Shading Mask_II