Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Run a an URBANopt geoJSON and scenario through OpenDSS.
The geoJSON must have a valid Electrical Network assigned to it in order to run correctly through OpenDSS.
geojson [Required]
The path to an URBANopt-compatible geoJSON file. This geoJSON file can be obtained form the "DF Model to geoJSON" component. The geoJSON must have a valid Electrical Network assigned to it in order to run correctly through OpenDSS.
scenario [Required]
The path to an URBANopt .csv file for the scenario. This CSV file can be obtained form the "DF Run URBANopt" component.
run_period
A ladybyg AnalysisPeriod object to describe the time period over which to run the simulation. The default is to run the simulation for the whole EnergyPlus run period.
autosize
A boolean to note whether undersized transformers should be automatically resized to meet demand over the course of the simulation. (Default: False).
run [Required]
Set to "True" to run the geojson and scenario through OpenDSS.
report
Reports, errors, warnings, etc.
buildings
A list of CSV files containing the voltage and over/under voltage results of the simulation at each timestep. There is one CSV per building in the dragonfly model. These can be imported with the "DF Read OpenDSS Result" component.
connectors
A list of CSV result files containing the power line loading and overloading results of the simulation at each timestep. There is one CSV per electrical connector in the network. These can be imported with the "DF Read OpenDSS Result" component.
transformers
A list of CSV result files containing the transformer loading and overloading results of the simulation at each timestep. There is one CSV per transformer in the network. These can be imported with the "DF Read OpenDSS Result" component.
Diversify the ProgramTypes assigned to a Building's Room2Ds.
This is useful when attempting to account for the fact that not all rooms are used by occupants according to a strict scheduled regimen. Some rooms will be used more than expected and others less.
This component uses a random number generator and gaussian distribution to generate loads that vary about the original "mean" programs. Note that the randomly generated values assigned by this component will be different every time that this component is run unless and input for seed_ has been specified.
In addition to diversifying load values, approximately 2/3 of the schedules in the resulting Room2Ds will be offset from the mean by the input schedule_offset (1/3 ahead and another 1/3 behind).
building [Required]
A Dragonfly Building, which will have its room programs diversified.
occ_stdev
A number between 0 and 100 for the percent of the occupancy people_per_area representing one standard deviation of diversification from the mean. (Default 20 percent).
lighting_stdev
A number between 0 and 100 for the percent of the lighting watts_per_area representing one standard deviation of diversification from the mean. (Default 20 percent).
electric_stdev
A number between 0 and 100 for the percent of the electric equipment watts_per_area representing one standard deviation of diversification from the mean. (Default 20 percent).
gas_stdev
A number between 0 and 100 for the percent of the gas equipment watts_per_area representing one standard deviation of diversification from the mean. (Default 20 percent).
hot_wtr_stdev
A number between 0 and 100 for the percent of the service hot water flow_per_area representing one standard deviation of diversification from the mean. (Default 20 percent).
infilt_stdev
A number between 0 and 100 for the percent of the infiltration flow_per_exterior_area representing one standard deviation of diversification from the mean. (Default 20 percent).
sched_offset
A positive integer for the number of timesteps at which all schedules of the resulting programs will be shifted - roughly 1/3 of the programs ahead and another 1/3 behind. (Default: 1).
timestep
An integer for the number of timesteps per hour at which the shifting is occurring. This must be a value between 1 and 60, which is evenly divisible by 60. 1 indicates that each step is an hour while 60 indicates that each step is a minute. (Default: 1).
seed
An optional integer to set the seed of the random number generator that is diversifying the loads. Setting a value here will ensure that the same "random" values are assigned every time that this component is run, making comparison of energy simulation results easier. If not set, the loads assigned by this component will be different every time it is run.
building
The input Dragonfly Building with its programs diversified. The diversified values can be checked by using the "DF Color Room2D Attributes" component.
Run a an URBANopt geoJSON and scenario through RNM.
The geoJSON must have a valid Road Network assigned to it in order to run correctly through RNM.
geojson [Required]
The path to an URBANopt-compatible geoJSON file. This geoJSON file can be obtained form the "DF Model to geoJSON" component. The geoJSON must have a valid Road Network assigned to it in order to run correctly through RNM.
scenario [Required]
The path to an URBANopt .csv file for the scenario. This CSV file can be obtained form the "DF Run URBANopt" component.
ug_ratio
A number between 0 and 1 for the ratio of overall cables that are underground vs. overhead in the analysis. (Default: 0.9).
include_hv
A boolean to note whether high voltage consumers should be included in the analysis. (Default: False).
nodes_per_bldg
A positive integer for the maximum number of low voltage nodes to represent a single building. (Default: 1).
run [Required]
Set to "True" to run the geojson and scenario through RNM.
report
Reports, errors, warnings, etc.
network
The ElectricalNetwork object output from the RNM simulation. The properties of this object can be visualized with the "DF Color Network Attributes" component. However, the network can not be used for OpenDSS simulation (the dss_files below should be used for this purpose).
dss_results
Path to the folder containing all of the OpenDSS files.
Run an URBANopt geoJSON through EnergyPlus using the URBANopt CLI.
This component requires the URBANopt CLI to be installed in order to run. Installation instructions for the URBANopt CLI can be found at: https://docs.urbanopt.net/installation/installation.html
geojson [Required]
The path to an URBANopt-compatible geoJSON file. This geoJSON file can be obtained form the "DF Model to geoJSON" component.
epw_file [Required]
Path to an .epw file on this computer as a text string.
sim_par
A honeybee Energy SimulationParameter object that describes all of the settings for the simulation. If None, some default simulation parameters will be automatically generated.
measures
An optional list of measures to apply to the OpenStudio model upon export. Use the "HB Load Measure" component to load a measure into Grasshopper and assign input arguments. Measures can be downloaded from the NREL Building Components Library (BCL) at
mappers
An optional list of dragonfly MapperMeasure objects to be included in the output osw. MapperMeasures are just like normal OpenStudio measures except they can accept a list of values for their arguments that align with the buildings in dragonfly Model. Each value in the list will be mapped to a different building.
report
Boolean to note whether to include the URBANopt default feature reporting measure as part of the simulation. If True, the measure will be run after all simulations are complete. (Default:True).
emiss_yr
An optional integer to set the year for which carbon emissions will be computed. Values must be an even number and be between 2020 and 2050. If unspecified, no carbon emission calculations will be included in the simulation. After the simulation is run, the hourly carbon emissions can be imported from the output sql files by using the "HB Read Custom Result" component and plugging in the following output name: Future_Hourly_Electricity_Emissions
cpus
A positive integer for the number of CPUs to use in the simulation. This number should not exceed the number of CPUs on the machine running the simulation and should be lower if other tasks are running while the simulation is running. If set to None, it should automatically default to one less than the number of CPUs currently available on the machine (or 1 if the machine has only one processor). (Default: None).
run [Required]
Set to "True" to run the geojson through URBANopt. This will ensure that all result files appear in their respective outputs from this component. This input can also be the integer "2", which will only run the setup of the URBANopt project folder (including the creation of the scenario file) but will not execute the simulations.
out
Reports, errors, warnings, etc.
scenario
File path to the URBANopt scenario CSV used as input for the URBANopt CLI run.
osm
File paths to the OpenStudio Models (OSM) that were generated in the process of running URBANopt.
idf
File paths to the EnergyPlus Input Data Files (IDF) that were generated in the process of running URBANopt.
sql
List of paths to .sqlite files containing all simulation results.
zsz
List of paths to .csv files containing detailed zone load information recorded over the course of the design days.
rdd
File paths of the Result Data Dictionary (.rdd) that were generated after running the file through EnergyPlus. This file contains all possible outputs that can be requested from the EnergyPlus model. Use the "Read Result Dictionary" component to see what outputs can be requested.
html
File paths of the HTMLs containting all Summary Reports.
Run a an URBANopt geoJSON and scenario through REopt using the URBANopt CLI.
This component requires the URBANopt CLI to be installed in order to run. Installation instructions for the URBANopt CLI can be found at: https://docs.urbanopt.net/installation/installation.html
geojson [Required]
The path to an URBANopt-compatible geoJSON file. This geoJSON file can be obtained form the "DF Model to geoJSON" component.
scenario [Required]
The path to an URBANopt .csv file for the scenario. This CSV file can be obtained form the "DF Run URBANopt" component.
urdb_label [Required]
Text string for the Utility Rate Database (URDB) label for the particular electrical utility rate for the optimization. The label is the last term of the URL of a utility rate detail page (eg. the urdb label at https://openei.org/apps/IURDB/rate/view/5b0d83af5457a3f276733305 is 5b0d83af5457a3f276733305). Utility rates for specific locations can be looked up in the REopt Lite tool (https://reopt.nrel.gov/tool) and the label can be obtained by clicking on "Rate Details" link for a particular selected rate.
financial_par
A REoptParameter object to describe the financial assumptions of the REopt analysis. This can be obtained from the "DF REopt Financial Parameters" component. If None, some default parameters will be generated for a typical analysis. (Default: None).
wind
A number for the maximum installed kilowatts of wind power. (Default: 0).
pv
A number for the maximum installed kilowatts of roof-mounted photovoltaic power. (Default: 1000000000).
pv_ground
A number for the maximum installed kilowatts of ground-mounted photovoltaic power. (Default: 1000000000).
storage
A number for the maximum installed kilowatts of electrical storage. (Default: 1000000).
generator
A number for the maximum installed kilowatts of generator power. Note that generators are only used in outages. (Default: 1000000000).
run [Required]
Set to "True" to run the geojson and scenario through REopt. This will ensure that all result files appear in their respective outputs from this component.
report
Reports, errors, warnings, etc.
values
A list of numerical values from the REopt analysis, all related to the cost and financial outcome of the optimization. These values align with the parameters below.
parameters
A list of text that correspond to the numerical values above. Each text item explains what the numerical value means.
wind
A number for the optimal capacity of wind power that should be installed in kW. This will be null unless a non-zero value is specified for the input wind.
pv
A number for the optimal capacity of roof-mounted photovlotaic power that should be installed in kW.
pv_ground
A number for the optimal capacity of ground-mounted photovlotaic power that should be installed in kW.
storage
A list of two numbers ordered as follows.
generator
A number for the optimal capacity of generator power that should be installed in kW. This will be null unless a non-zero value is specified for the input generator.
data
A list of hourly continuous data collections containing the detailed timeseties results of the REopt analysis.
-
Load OpenStudio measures into Grasshopper and assign the measure's input arguments in a manner that can be mapped to different buildings in a Dragonfly model.
The resulting measure object can be plugged into the "measures_" input of the "DF Run URBANopt" component in order to be included in the simulation.
measure_path [Required]
Path to the folder in which the measure exists. This folder must contain a measure.rb and a measure.xml file. Note that connecting an input here will transform the component, essentially removing this input and changing all of the other component inputs to be input arguments for the measure.
report
The execution information, as output and error streams
mapper
A mapper measure object can be plugged into the "measures_" input of the "DF Run URBANopt" component in order to be included in the simulation.
-
Apply a detailed Ironbug HVAC to Dragonfly Buildings, Stories or Room2Ds.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which the input Ironbug HVAC will be assigned. This can also be an etire dragonfly Model. Only the relevant Room2Ds referenced in the _hvac_system will be assigned the HVAC system.
hvac_system [Required]
A fully-detailed Irongbug HVAC system to be assigned to the input dragonfly objects.
name
Text to set the name for the HVAC system and to be incorporated into unique HVAC identifier. If the name is not provided, a random name will be assigned.
report
Reports, errors, warnings, etc.
df_objs
The input Rooms or Model with the detailed HVAC system applied.
-
Apply an All-Air template HVAC to a list of Dragonfly Buildings, Stories or Room2Ds.
All-air systems provide both ventilation and satisfaction of heating + cooling demand with the same stream of warm/cool air. As such, they often grant tight control over zone humidity. However, because such systems often involve the cooling of air only to reheat it again, they are often more energy intensive than systems that separate ventilation from the meeting of thermal loads.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which the input template HVAC will be assigned. If a list of Room2Ds is input, all objects will receive the same HVAC instance. Otherwise, each object gets its own instance (eg. each input Story will get its own HVAC). This can also be an etire dragonfly Model.
system_type [Required]
Text for the specific type of all-air system and equipment. The "HB All-Air HVAC Templates" component has a full list of the supported all-air system templates.
vintage
Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. The "HB Building Vintages" component has a full list of supported HVAC vintages. (Default: ASHRAE_2019).
name
Text to set the name for the HVAC system and to be incorporated into unique HVAC identifier. If the name is not provided, a random name will be assigned.
economizer
Text to indicate the type of air-side economizer used on the HVAC system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone. Choose from the options below. (Default: NoEconomizer).
NoEconomizer
DifferentialDryBulb
DifferentialEnthalpy
DifferentialDryBulbAndEnthalpy
FixedDryBulb
FixedEnthalpy
ElectronicEnthalpy
sensible_hr
A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. Typical values range from 0.5 for simple glycol loops to 0.81 for enthalpy wheels (the latter tends to be fiarly expensive for air-based systems). (Default: 0).
latent_hr
A number between 0 and 1 for the effectiveness of latent heat recovery within the system. Typical values are 0 for all types of heat recovery except enthalpy wheels, which can have values as high as 0.76. (Default: 0).
dcv
Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the zone. (Default: False).
report
Script variable OSHVACSystems
df_objs
The input Dragonfly objects with an all-air HVAC system applied.
-
Apply a Dedicated Outdoor Air System (DOAS) template HVAC to a list of Dragonfly Buildings, Stories or Room2Ds.
DOAS systems separate minimum ventilation supply from the satisfaction of heating + cooling demand. Ventilation air tends to be supplied at neutral temperatures (close to room air temperature) and heating / cooling loads are met with additional pieces of zone equipment (eg. Fan Coil Units (FCUs)).
Because DOAS systems only have to cool down and re-heat the minimum ventilation air, they tend to use less energy than all-air systems. They also tend to use less energy to distribute heating + cooling by puping around hot/cold water or refrigerant instead of blowing hot/cold air. However, they do not provide as good of control over humidity and so they may not be appropriate for rooms with high latent loads like auditoriums, kitchens, laundromats, etc.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which the input template HVAC will be assigned. If a list of Room2Ds is input, all objects will receive the same HVAC instance. Otherwise, each object gets its own instance (eg. each input Story will get its own HVAC). This can also be an etire dragonfly Model.
system_type [Required]
Text for the specific type of DOAS system and equipment. The "HB DOAS HVAC Templates" component has a full list of the supported DOAS system templates.
vintage
Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. The "HB Building Vintages" component has a full list of supported HVAC vintages. (Default: ASHRAE_2019).
name
Text to set the name for the HVAC system and to be incorporated into unique HVAC identifier. If the name is not provided, a random name will be assigned.
sensible_hr
A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. Typical values range from 0.5 for simple glycol loops to 0.81 for enthalpy wheels (the latter of which is a fairly common ECM for DOAS systems). (Default: 0).
latent_hr
A number between 0 and 1 for the effectiveness of latent heat recovery within the system. Typical values are 0 for all types of heat recovery except enthalpy wheels, which can have values as high as 0.76. (Default: 0).
dcv
Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the zone. (Default: False).
doas_avail_sch
An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on. (Default: None).
report
Script variable OSHVACSystems
df_objs
The input Dragonfly objects with a DOAS HVAC system applied.
-
Re-assign energy properties to any Dragonfly object (Building, Story, Room2D, Model).
This is useful for editing auto-generated child objects separately from their parent. For example, if you want to assign all of the ground floors of a given auto-generated Building to have a Retail ProgramType, this can help re-assign a Retail ProgramType to such stories.
df_obj [Required]
A Dragonfly Building, Story or Room2D which is to have its energy properties re-assigned. This can also be an entire Dragonfly Model.
program
Text to reassign the program of the input objects (to be looked up in the ProgramType library) such as that output from the "HB List Programs" component. This can also be a custom ProgramType object.
constr_set
Text to reassign construction set of the input objects, which is usedto assign all default energy constructions needed to create an energy model. Text should refer to a ConstructionSet within the library such as that output from the "HB List Construction Sets" component. This can also be a custom ConstructionSet object.
df_obj
The input Dragonfly object with its properties re-assigned based on the input.
-
Apply process loads to a Dragonfly Room2D or all Room2Ds of a Dragonfly Story, Building or Model.
Examples of process loads include wood burning fireplaces, kilns, manufacturing equipment, and various industrial processes. They can also be used to represent certain specialized pieces of equipment to be separated from the other end uses, such as MRI machines, theatrical lighting, elevators, etc.
df_obj [Required]
A Dragonfly Room2D, Story or Building to which process loads should be assigned.
name
Text to set the name for the Process load and to be incorporated into a unique Process load identifier. If None, a unique name will be generated.
watts [Required]
A number for the process load power in Watts.
schedule [Required]
A fractional schedule for the use of the process over the course of the year. The fractional values will get multiplied by the _watts to yield a complete process load profile.
fuel_type [Required]
Text to denote the type of fuel consumed by the process. Using the "None" type indicates that no end uses will be associated with the process, only the zone gains. Choose from the following.
use_category
Text to indicate the end-use subcategory, which will identify the process load in the EUI output. For example, “Cooking”, “Clothes Drying”, etc. (Default: General).
radiant_fract
A number between 0 and 1 for the fraction of the total process load given off as long wave radiant heat. (Default: 0).
latent_fract
A number between 0 and 1 for the fraction of the total process load that is latent (as opposed to sensible). (Default: 0).
lost_fract
A number between 0 and 1 for the fraction of the total process load that is lost outside of the zone and the HVAC system. Typically, this is used to represent heat that is exhausted directly out of a zone (as you would for a stove). (Default: 0).
report
Reports, errors, warnings, etc.
df_obj
The input Rooms with process loads assigned to them.
Apply a template system that only supplies heating and/or cooling (no ventilation) to a list of Dragonfly Buildings, Stories or Room2Ds.
These systems are only designed to satisfy heating + cooling demand and they cannot meet any minimum ventilation requirements.
As such, these systems tend to be used in residential or storage settings where meeting minimum ventilation requirements may not be required or the density of occupancy is so low that infiltration is enough to meet fresh air demand.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which the input template HVAC will be assigned. If a list of Room2Ds is input, all objects will receive the same HVAC instance. Otherwise, each object gets its own instance (eg. each input Story will get its own HVAC). This can also be an etire dragonfly Model.
system_type [Required]
Text for the specific type of heating/cooling system and equipment. The "HB HeatCool HVAC Templates" component has a full list of the supported Heating/Cooling system templates.
vintage
Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. The "HB Building Vintages" component has a full list of supported HVAC vintages. (Default: ASHRAE_2019).
name
Text to set the name for the heating/cooling system and to be incorporated into unique system identifier. If the name is not provided, a random name will be assigned.
report
Script variable OSHVACSystems
df_objs
The input Dragonfly objects with a heating/cooling system applied.
Apply a customized IdealAirSystem to Dragonfly Buildings, Stories or Room2Ds.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which the input ideal air properties will be assigned. This can also be an etire dragonfly Model.
economizer
Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone. Choose from the options below. Default: DifferentialDryBulb.
dcv
Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the zone. Default: False.
sensible_hr
A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. Default: 0.
latent_hr
A number between 0 and 1 for the effectiveness of latent heat recovery within the system. Default: 0.
heat_temp
A number for the maximum heating supply air temperature [C]. Default: 50, which is typical for many air-based HVAC systems.
cool_temp
A number for the minimum cooling supply air temperature [C]. Default: 13, which is typical for many air-based HVAC systems.
heat_limit
A number for the maximum heating capacity in Watts. This can also be the text 'autosize' to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be the text 'NoLimit' to indicate no upper limit to the heating capacity. Default: 'autosize'.
cool_limit
A number for the maximum cooling capacity in Watts. This can also be the text 'autosize' to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be the text 'NoLimit' to indicate no upper limit to the cooling capacity. Default: 'autosize'.
heat_avail
An optional on/off schedule to set the availability of heating over the course of the simulation. This can also be the identifier of an on/off schedule to be looked up in the schedule library (Default: None).
cool_avail
An optional on/off schedule to set the availability of cooling over the course of the simulation. This can also be the identifier of an on/off schedule to be looked up in the schedule library (Default: None).
report
The execution information, as output and error streams
df_objs
The input Dragonfly object with the custom Ideal Air System assigned.
-
Create an OpenDSS Electrical Network, which represents all electrical infrastructure for an OpenDSS simulation.
This includes a substation, transformers, and all electrical connectors needed to connect these objects to Dragonfly Buildings.
substation [Required]
A Substation object representing the electrical substation supplying the network with electricity.
transformers [Required]
An array of Transformer objects that are included within the electrical network. Generally, there should always be a transformer somewhere between the substation and a given building.
connectors [Required]
An array of ElectricalConnector objects that are included within the electrical network. In order for a given connector to be valid within the network, each end of the connector must touch either another connector, a transformer/substation or a Dragonfly Building footprint. In order for the network as a whole to be valid, all Buildings and Transformers must be connected back to the Substation via connectors.
name
Text to be used for the name and identifier of the Electrical Newtork. If no name is provided, it will be "unnamed".
report
Reports, errors, warnings, etc.
network
A Dragonfly Electrical Newtork object possessing all electrical infrastructure for an OpenDSS simulation. This should be connected to the network_ input of the "DF Model to GeoJSON" component.
-
Create a REopt ground-mounted photovoltaic system from its footprint geometry (horizontal Rhino surfaces).
geo [Required]
A horizontal Rhino surface (or closed polyline) representing a footprint to be converted into a ground-mounted photovoltaic system.
name
Text to set the name for the PV system, which will also be incorporated into unique PV system identifier. If the name is not provided, a random one will be assigned.
bldg
An optional Dragonfly Building with which the photovoltaic system is associated. If None, the PV system will be assumed to be a community PV field that isn't associated with a particular building meter.
ground_pv
A Dragonfly ground-mounted PV system object that can be exported to a GeoJSON in order to account for ground-mounted photovoltaics in a REopt simulation.
-
Apply a template Service Hot Water (SHW) system to Dragonfly Buildings, Stories or Room2Ds.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which the input template system will be assigned. This can also be a Honeybee Model for which all Rooms will be assigned the SHW system.
system_type [Required]
Text for the specific type of service hot water system and equipment. The "HB SHW Templates" component has a full list of the supported system templates.
name
Text to set the name for the Service Hot Water system and to be incorporated into unique system identifier. If the name is not provided, a random name will be assigned.
efficiency
A number for the efficiency of the heater within the system. For Gas systems, this is the efficiency of the burner. For HeatPump systems, this is the rated COP of the system. For electric systems, this should usually be set to 1. If unspecified this value will automatically be set based on the equipment_type. See below for the default value for each equipment type:
condition
A number for the ambient temperature in which the hot water tank is located [C]. This can also be a Room2D in which the tank is located. (Default: 22).
loss_coeff
A number for the loss of heat from the water heater tank to the surrounding ambient conditions [W/K]. (Default: 6 W/K).
report
Script variable OSHVACSystems
df_objs
The input Rooms with a Service Hot Water system applied.
-
Create an OpenDSS Electrical Connector from linear geometry and power line properties, which include the wires and their geometrical arrangement.
geo [Required]
A line or polyline representing an Electrical Connector.
power_line [Required]
Text for the ID of a PowerLine carried along the electrical connector, which will be looked up in the Power Lines library (the output from the "DF OpenDSS Libraries" component). This can also be a custom PowerLine object created using the Ladybug Tools SDK.
name
Text to set the base name for the Electrical Connector, which will also be incorporated into unique ElectricalConnector identifier. If the name is not provided, a random one will be assigned.
connector
A Dragonfly Electrical Connector object that can be used within an Electrical Network.
-
Create an RNM Road Network, which represents the streets along which electrical infrastructure will be placed by RNM.
This includes a substation and road geometries running between the buildings.
substation [Required]
A Substation object representing the electrical substation supplying the network with electricity.
road_geo [Required]
An array of Lines or Polylines that represent the roads within the network.
name
Text to be used for the name and identifier of the Road Newtork. If no name is provided, it will be "unnamed".
report
Reports, errors, warnings, etc.
network
A Dragonfly Road Newtork object possessing all roads needed for an RNM simulation. This should be connected to the network_ input of the "DF Model to GeoJSON" component.
Create an OpenDSS Substation from its footprint geometry (horizontal Rhino surfaces).
geo [Required]
A horizontal Rhino surface representing a footprint to be converted into a Substation.
name
Text to set the name for the Substation, which will also be incorporated into unique Substation identifier. If the name is not provided, a random one will be assigned.
substation
A Dragonfly Substation object that can be used within an Electrical Network.
-
Create an OpenDSS Transformer from its footprint geometry (horizontal Rhino surfaces).
geo [Required]
A horizontal Rhino surface representing a footprint to be converted into a Transformer.
properties [Required]
Text for the properties of the Transformer to be looked up in the TransformerProperties library (the output from the "DF OpenDSS Libraries" component). This can also be a custom TransformerProperties object.
name
Text to set the base name for the Transformer, which will also be incorporated into unique Transformer identifier. If the name is not provided, a random one will be assigned.
transformer
A Dragonfly Transformer object that can be used within an Electrical Network.
Create an Fourth Generation Thermal Loop, which represents all infrastructure for a District Energy Simulation (DES) simulation.
This includes a central hot and chilled water plant for the district.
chilled_temp
A number for the temperature of chilled water in the DES in degrees Celsius. (Default: 6).
hot_temp
A number for the temperature of hot water in the DES in degrees Celsius. (Default: 54).
name
Text to be used for the name and identifier of the Thermal Loop. If no name is provided, it will be "unnamed".
report
Reports, errors, warnings, etc.
des_loop
A Dragonfly Thermal Loop object possessing all infrastructure for a District Energy Simulation (DES) simulation. This should be connected to the loop_ input of the "DF Model to GeoJSON" component.
-
Parse any CSV file output from an OpenDSS simulation.
dss_csv [Required]
The file path of any CSV result file that has been generated from an OpenDSS simulation. This can be either a Building CSV with voltage information or transformers/connectors with loading information.
factors
A list of data collections containing the dimensionless fractional values from the CSV results. For buildings, these represent the voltage at a given timestep divided by the standard outlet voltage (120 V). For transformers and connectors, these represent the power along the wire or transformer divided by the kVA rating of the object.
condition
A list of data collections noting the condition of a given object. For example, whether the object is over or under voltage (in the case of a building) or whether it is overloaded (in the case of a transformer or electrical connector).
Search for available TransformerProperties, PowerLines, and Wires within the dragonfly OpenDSS standards library (aka. the URBANopt extended cataolog).
keywords
Optional keywords to be used to narrow down the output list of objects. If nothing is input here, all available objects will be output.
join_words
If False or None, this component will automatically split any strings of multiple keywords (spearated by spaces) into separate keywords for searching. This results in a greater liklihood of finding an item in the search but it may not be appropropriate for all cases. You may want to set it to True when you are searching for a specific phrase that includes spaces. (Default: False).
transformers
A list of all transformer properties within the dragonfly OpenDSS standards library (filtered by keywords_ if they are input).
power_lines
A list of all power lines within the dragonfly OpenDSS standards library (filtered by keywords_ if they are input).
wires
A list of all wires within the dragonfly OpenDSS standards library (filtered by keywords_ if they are input).
Create an Ground Heat Exchanger Thermal Loop, which represents all infrastructure for a District Energy Simulation (DES) simulation.
This includes a ground heat exchanger and all thermal connectors needed to connect these objects to Dragonfly Buildings.
ghe_geo [Required]
Horizontal Rhino surfaces representing the footprints of ground heat exchangers. These ground heat exchanging fields contain the boreholes that supply the loop with thermal capacity. Multiple borehole fields can be located along the loop created by the _connector_geo.
connector_geo [Required]
An array of lines or polylines representing the thermal connectors within the thermal loop. In order for a given connector to be valid within the loop, each end of the connector must touch either another connector, a building footprint, or a ground heat exchanger. In order for the loop as a whole to be valid, the connectors must form a single continuous loop when passed through the buildings and the heat exchanger field.
clockwise
A boolean to note whether the direction of flow through the loop is clockwise (True) when viewed from above in the GeoJSON or it is counterclockwise (False). (Default: False).
bore_depth
A number for the maximum depth of the heat-exchanging part of the boreholes in meters. This can also be a domain (aka interval) that sets the minimum and maximum depths of the boreholes (when the default minimum depth of 60 meters is not desirable). When the system demand cannot be met using boreholes with the minimum depth, the boreholes will be extended until either the loads or met or they reach the maximum depth specified here. So this typically represents the depth of bedrock or the point at which drilling deeper ceases to be practical. (Default: 135 meters).
bore_spacing
A number for the minimum spacing between boreholes in meters. This can also be a domain (aka interval) that sets the minimum and maximum spacing of the boreholes (when the default maximum spacing of 10 meters is not desirable). When the system demand cannot be met using boreholes with the maximum spacing, the borehole spacing will be reduced until either the loads or met or they reach this minimum spacing. So this typically represents the spacing at which each borehole will interfere with neighboring ones so much that it is not worthwhile to decrease the spacing further. (Default: 3 meters).
soil_conduct
A number for the soil conductivity in W/m-K. (Default: 2.3).
soil_heat_cap
A number for the volumetric heat capacity of the soil in J/m3-K. (Default: 2,343,500).
fluid_type
Text to indicate the type of fluid circulating through the ground heat exchanger loop. Choose from the options below. (Default: Water).
concentration
A number between 0 and 60 for the concentration of the fluid_type in water in percent. Note that this variable has no effect when the fluid_type is Water. (Default: 35).
name
Text to be used for the name and identifier of the Thermal Loop. If no name is provided, it will be "unnamed".
report
Reports, errors, warnings, etc.
des_loop
A Dragonfly Thermal Loop object possessing all infrastructure for a District Energy Simulation (DES) simulation. This should be connected to the loop_ input of the "DF Model to GeoJSON" component.
Customize the financial settings of a REopt analysis.
years
An integer for the number of years over which cost will be optimized. (Default: 25).
escalation
A number between 0 and 1 for the escalation rate over the analysis. (Default: 0.023).
tax
A number between 0 and 1 for the rate at which the owner/host of the system is taxed. (Default: 0.26).
discount
A number between 0 and 1 for the discount rate for the owner/host of the system. (Default: 0.083).
wind_cost
A number for the installation cost of wind power in US dollars per kW. (Default: 3013).
pv_cost
A number for the installation cost of photovoltaic power in US dollars per kW. (Default: 1600).
pv_grnd_cost
A number for the installation cost of photovoltaic power in US dollars per kW. (Default: 2200).
storage_cost
A number for the installation cost of power storage in US dollars per kW. (Default: 840).
gener_cost
A number for the installation cost of generators in US dollars per kW. (Default: 500).
financial_par
A REoptParameter object that can be plugged into the 'DF Run REopt' component.
-
Define the window opening properties for all apertures of a Dragonfly Building, Story, Room2D or Model.
df_objs [Required]
Dragonfly Buildings, Stories or Room2Ds to which window ventilation opening properties will be assigned. Note that this component assigns such properties to all Outdoor Apertures on the rooms. This can also be an entire Dragonfly Model.
vent_cntrl [Required]
A Ventilation Control object from the "HB Ventilation Control" component, which dictates the opening behaviour of the Room's apertures.
fract_area_oper
A number between 0.0 and 1.0 for the fraction of the window area that is operable. (Default: 0.5, typical of sliding windows).
fract_height_oper
A number between 0.0 and 1.0 for the fraction of the distance from the bottom of the window to the top that is operable. (Default: 1.0, typical of windows that slide horizontally).
discharge_coeff
A number between 0.0 and 1.0 that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. (Default: 0.45, for unobstructed windows with insect screens). This value should be lowered if windows are of an awning or casement type and not allowed to fully open. Some common values for this coefficient include the following.
wind_cross_vent
Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation. (Default: False)
report
...
df_objs
The input Dragonfly object with their window-opening properties edited.
Deconstruct an OpenDSS Wire, PowerLine, or Transformer Properties into its constituient attributes and values.
dss_obj [Required]
An OpenDSS Wire, PowerLine, or Transformer Properties to be deconstructed. This can also be text for a Wire, PowerLine, or Transformer to be looked up in the library.
values
List of values for the attributes that define the OpenDSS object.
attr_names
List of text that is the same length as the values, which notes the attribute name for each value.
Run a an URBANopt geoJSON and scenario through Modelica Distric Energy System (DES) simulation.
The geoJSON must have a valid DES Loop assigned to it in order to run correctly through Modelica DES simulation.
geojson [Required]
The path to an URBANopt-compatible geoJSON file. This geoJSON file can be obtained form the "DF Model to geoJSON" component. The geoJSON must have a valid District Energy System (DES) Loop assigned to it in order to run correctly through the DES simulation.
scenario [Required]
The path to an URBANopt .csv file for the scenario. This CSV file can be obtained form the "DF Run URBANopt" component.
write [Required]
Set to "True" to run the component, install any missing dependencies, and write the Modelica files for the Distric Energy System.
run
Set to "True" to translate the Modelica files to a Functional Mockup Unit (FMU) and then simulate the FMU. This will ensure that all result files appear in their respective outputs from this component.
report
Reports, errors, warnings, etc.
sys_param
A JSON file containing all of the specifications of the District Energy System, including the detailed Building load profiles.
modelica
A folder where all of the Modelica files of the District Energy System (DES) are written.
results
A folder containing the results of the Modelica simulation if run_ is True and the simulation is successful.
