dragonfly-uwg
  • Site
      • CLI Docs
        • Installation
        • Commands
          • simulate
            • dragonfly-uwg simulate
              • model
      • dragonfly_uwg
        • dragonfly_uwg package
          • Subpackages
            • dragonfly_uwg.cli package
              • Submodules
                • dragonfly_uwg.cli.simulate module
              • Module contents
            • dragonfly_uwg.properties package
              • Submodules
                • dragonfly_uwg.properties.building module
                  • BuildingUWGProperties
                    • ToString()
                    • apply_properties_from_dict()
                    • default_shgc()
                    • duplicate()
                    • from_dict()
                    • infer_program_from_energy_program()
                    • to_dict()
                    • PROGRAMS
                    • VINTAGES
                    • fract_heat_to_canyon
                    • host
                    • program
                    • program_uwg
                    • roof_albedo
                    • roof_veg_fraction
                    • shgc
                    • vintage
                    • vintage_uwg
                    • wall_albedo
                • dragonfly_uwg.properties.context module
                  • ContextShadeUWGProperties
                    • ToString()
                    • apply_properties_from_dict()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • host
                    • is_vegetation
                • dragonfly_uwg.properties.model module
                  • ModelUWGProperties
                    • ToString()
                    • apply_properties_from_dict()
                    • average_shgc()
                    • compute_horizontal_area()
                    • duplicate()
                    • grass_coverage_from_geometry()
                    • move()
                    • reflect()
                    • rotate_xy()
                    • scale()
                    • to_dict()
                    • to_uwg_dict()
                    • exposed_ground_area
                    • facade_to_site
                    • footprint_density
                    • grass_coverage_fraction
                    • host
                    • is_tree_coverage_autocalcualted
                    • terrain
                    • traffic
                    • tree_coverage_fraction
                • dragonfly_uwg.properties.room2d module
                  • Room2DUWGProperties
                    • ToString()
                    • apply_properties_from_dict()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • host
                • dragonfly_uwg.properties.story module
                  • StoryUWGProperties
                    • ToString()
                    • apply_properties_from_dict()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • host
              • Module contents
            • dragonfly_uwg.simulation package
              • Submodules
                • dragonfly_uwg.simulation.boundary module
                  • BoundaryLayerParameter
                    • ToString()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • circulation_coefficient
                    • day_boundary_layer_height
                    • exchange_coefficient
                    • inversion_height
                    • night_boundary_layer_height
                • dragonfly_uwg.simulation.parameter module
                  • UWGSimulationParameter
                    • ToString()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • to_uwg_dict()
                    • VALIDTIMESTEPS
                    • VALIDZONES
                    • boundary_layer_parameter
                    • climate_zone
                    • reference_epw_site
                    • run_period
                    • timestep
                    • vegetation_parameter
                • dragonfly_uwg.simulation.refsite module
                  • ReferenceEPWSite
                    • ToString()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • average_obstacle_height
                    • temp_measure_height
                    • vegetation_coverage
                    • wind_measure_height
                • dragonfly_uwg.simulation.runperiod module
                  • UWGRunPeriod
                    • ToString()
                    • duplicate()
                    • from_analysis_period()
                    • from_dict()
                    • to_dict()
                    • day_count
                    • end_date
                    • start_date
                • dragonfly_uwg.simulation.vegetation module
                  • VegetationParameter
                    • ToString()
                    • duplicate()
                    • from_dict()
                    • to_dict()
                    • end_month
                    • grass_latent_fraction
                    • start_month
                    • tree_latent_fraction
                    • vegetation_albedo
              • Module contents
          • Submodules
            • dragonfly_uwg.run module
              • run_uwg()
            • dragonfly_uwg.terrain module
              • Terrain
                • ToString()
                • duplicate()
                • from_building_bounding_rect()
                • from_dict()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • to_dict()
                • area
                • characteristic_length
                • geometry
                • horizontal_area
                • max
                • min
                • pavement_albedo
                • pavement_conductivity
                • pavement_heat_capacity
                • pavement_thickness
                • polygon2ds
            • dragonfly_uwg.traffic module
              • TrafficParameter
                • ToString()
                • duplicate()
                • from_dict()
                • to_dict()
                • SATURDAY_DEFAULT
                • SUNDAY_DEFAULT
                • WEEKDAY_DEFAULT
                • saturday_schedule
                • sunday_schedule
                • watts_per_area
                • weekday_schedule
            • dragonfly_uwg.writer module
              • model_to_uwg()
          • Module contents
  • Page
      • CLI Docs
      • dragonfly_uwg
        • dragonfly_uwg package
          • Subpackages
            • dragonfly_uwg.cli package
            • dragonfly_uwg.properties package
            • dragonfly_uwg.simulation package
          • Submodules
            • dragonfly_uwg.run module
            • dragonfly_uwg.terrain module
            • dragonfly_uwg.traffic module
            • dragonfly_uwg.writer module
          • Module contents
  • « dragonfly_uwg
  • dragonfly_uwg... »
  • Source
  • CLI Docs
  • dragonfly_uwg
    • dragonfly_uwg package
      • Subpackages
        • dragonfly_uwg.cli package
        • dragonfly_uwg.properties package
        • dragonfly_uwg.simulation package
      • Submodules
        • dragonfly_uwg.run module
        • dragonfly_uwg.terrain module
        • dragonfly_uwg.traffic module
        • dragonfly_uwg.writer module
      • Module contents

dragonfly_uwg package¶

Subpackages¶

  • dragonfly_uwg.cli package
    • Submodules
      • dragonfly_uwg.cli.simulate module
    • Module contents
  • dragonfly_uwg.properties package
    • Submodules
      • dragonfly_uwg.properties.building module
        • BuildingUWGProperties
      • dragonfly_uwg.properties.context module
        • ContextShadeUWGProperties
      • dragonfly_uwg.properties.model module
        • ModelUWGProperties
      • dragonfly_uwg.properties.room2d module
        • Room2DUWGProperties
      • dragonfly_uwg.properties.story module
        • StoryUWGProperties
    • Module contents
  • dragonfly_uwg.simulation package
    • Submodules
      • dragonfly_uwg.simulation.boundary module
        • BoundaryLayerParameter
      • dragonfly_uwg.simulation.parameter module
        • UWGSimulationParameter
      • dragonfly_uwg.simulation.refsite module
        • ReferenceEPWSite
      • dragonfly_uwg.simulation.runperiod module
        • UWGRunPeriod
      • dragonfly_uwg.simulation.vegetation module
        • VegetationParameter
    • Module contents

Submodules¶

  • dragonfly_uwg.run module
    • run_uwg()
  • dragonfly_uwg.terrain module
    • Terrain
      • ToString()
      • duplicate()
      • from_building_bounding_rect()
      • from_dict()
      • move()
      • reflect()
      • rotate_xy()
      • scale()
      • to_dict()
      • area
      • characteristic_length
      • geometry
      • horizontal_area
      • max
      • min
      • pavement_albedo
      • pavement_conductivity
      • pavement_heat_capacity
      • pavement_thickness
      • polygon2ds
  • dragonfly_uwg.traffic module
    • TrafficParameter
      • ToString()
      • duplicate()
      • from_dict()
      • to_dict()
      • SATURDAY_DEFAULT
      • SUNDAY_DEFAULT
      • WEEKDAY_DEFAULT
      • saturday_schedule
      • sunday_schedule
      • watts_per_area
      • weekday_schedule
  • dragonfly_uwg.writer module
    • model_to_uwg()

Module contents¶

dragonfly-uwg library.

Back to top

© Copyright 2025, Ladybug Tools.
Created using Sphinx 8.0.2.