honeybee radiance
  • Site
      • CLI Docs
        • Installation
        • Commands
          • main
            • honeybee-radiance
              • config
          • grid
            • honeybee-radiance grid
              • enclosure-info
              • from-exterior-apertures
              • from-exterior-faces
              • from-face3ds
              • from-rooms
              • from-rooms-radial
              • merge
              • merge-folder
              • mirror
              • split
              • split-folder
          • mtx
            • honeybee-radiance mtxop
              • operate-three
              • operate-two
              • transpose
          • sky
            • honeybee-radiance sky
              • adjust-for-metric
              • cie
              • climate-based
              • illuminance
              • irradiance
              • leed-illuminance
              • mtx
              • skydome
              • uniform-sky
          • lib
            • honeybee-radiance lib
              • modifier-by-id
              • modifier-set-by-id
              • modifier-sets
              • modifier-sets-by-id
              • modifiers
              • modifiers-by-id
              • to-model-properties
          • octree
            • honeybee-radiance octree
              • from-abstracted-groups
              • from-folder
              • from-folder-multiphase
              • from-folder-static
              • from-shade-trans-groups
          • threephase
            • honeybee-radiance three_phase
              • combinations
              • multiplication
              • rmtxop
          • sunpath
            • honeybee-radiance sunpath
              • epw
              • location
              • parse-hours
              • radiance
              • wea
          • dc
            • honeybee-radiance dc
              • coeff
              • scoeff
              • scontrib
          • postprocess
            • honeybee-radiance post-process
              • annual-daylight
              • annual-daylight-en17037
              • annual-glare
              • annual-irradiance
              • average-irradiance-vis-metadata
              • average-row
              • convert-to-binary
              • count
              • cumulative-radiation
              • cumulative-radiation-config
              • cumulative-radiation-vis-metadata
              • daylight-factor-config
              • daylight-factor-vis-metadata
              • direct-sun-hours-config
              • direct-sun-hours-vis-metadata
              • electric-lighting
              • imageless-annual-glare-vis-metadata
              • leed-illuminance
              • point-in-time-config
              • point-in-time-vis-metadata
              • sky-view-config
              • sky-view-vis-metadata
              • solar-tracking
              • sum-row
          • glare
            • honeybee-radiance dcglare
              • two-phase
          • raytrace
            • honeybee-radiance raytrace
              • daylight-factor
              • point-in-time
              • rtrace
          • rpict
            • honeybee-radiance rpict
              • rpict
          • multiphase
            • honeybee-radiance multi_phase
              • dmtx-group
              • flux-transfer
              • prepare-multiphase
              • three-phase
                • combinations
                • multiplication
                • rmtxop
              • view-matrix
          • translate
            • honeybee-radiance translate
              • model-radiant-enclosure-info
              • model-to-rad
              • model-to-rad-folder
              • modifiers-from-rad
              • modifiers-to-rad
          • setconfig
            • honeybee-radiance set-config
              • radiance-path
              • standards-data-folder
          • edit
            • honeybee-radiance edit
              • add-aperture-sensors
              • add-face-sensors
              • add-face3d-sensors
              • add-room-radial-sensors
              • add-room-sensors
              • mirror-model-sensors
          • view
            • honeybee-radiance view
              • merge
              • split
              • split-count
          • viewfactor
            • honeybee-radiance view_factor
              • contrib
              • modifiers
          • schedule
            • honeybee-radiance schedule
              • epw-to-daylight-hours
      • honeybee_radiance
        • honeybee_radiance package
          • Subpackages
            • honeybee_radiance.cli package
              • Submodules
                • honeybee_radiance.cli.dc module
                • honeybee_radiance.cli.edit module
                • honeybee_radiance.cli.glare module
                • honeybee_radiance.cli.grid module
                • honeybee_radiance.cli.lib module
                • honeybee_radiance.cli.mtx module
                • honeybee_radiance.cli.multiphase module
                • honeybee_radiance.cli.octree module
                • honeybee_radiance.cli.postprocess module
                • honeybee_radiance.cli.raytrace module
                • honeybee_radiance.cli.rpict module
                • honeybee_radiance.cli.schedule module
                • honeybee_radiance.cli.setconfig module
                • honeybee_radiance.cli.sky module
                • honeybee_radiance.cli.sunpath module
                • honeybee_radiance.cli.threephase module
                • honeybee_radiance.cli.translate module
                • honeybee_radiance.cli.util module
                • honeybee_radiance.cli.view module
                • honeybee_radiance.cli.viewfactor module
              • Module contents
            • honeybee_radiance.dynamic package
              • Submodules
                • honeybee_radiance.dynamic.group module
                • honeybee_radiance.dynamic.state module
                • honeybee_radiance.dynamic.stategeo module
              • Module contents
            • honeybee_radiance.geometry package
              • Submodules
                • honeybee_radiance.geometry.bubble module
                • honeybee_radiance.geometry.cone module
                • honeybee_radiance.geometry.cup module
                • honeybee_radiance.geometry.cylinder module
                • honeybee_radiance.geometry.geometrybase module
                • honeybee_radiance.geometry.instance module
                • honeybee_radiance.geometry.mesh module
                • honeybee_radiance.geometry.polygon module
                • honeybee_radiance.geometry.ring module
                • honeybee_radiance.geometry.source module
                • honeybee_radiance.geometry.sphere module
                • honeybee_radiance.geometry.tube module
              • Module contents
            • honeybee_radiance.lib package
              • Submodules
                • honeybee_radiance.lib.modifiers module
                • honeybee_radiance.lib.modifiersets module
              • Module contents
            • honeybee_radiance.lightsource package
              • Subpackages
                • honeybee_radiance.lightsource.sky package
                  • Submodules
                    • honeybee_radiance.lightsource.sky.certainirradiance module
                    • honeybee_radiance.lightsource.sky.cie module
                    • honeybee_radiance.lightsource.sky.climatebased module
                    • honeybee_radiance.lightsource.sky.hemisphere module
                    • honeybee_radiance.lightsource.sky.skydome module
                    • honeybee_radiance.lightsource.sky.skymatrix module
                    • honeybee_radiance.lightsource.sky.strutil module
                    • honeybee_radiance.lightsource.sky.sunmatrix module
                  • Module contents
              • Submodules
                • honeybee_radiance.lightsource.dictutil module
                • honeybee_radiance.lightsource.ground module
                • honeybee_radiance.lightsource.sunpath module
              • Module contents
            • honeybee_radiance.modifier package
              • Subpackages
                • honeybee_radiance.modifier.material package
                  • Submodules
                    • honeybee_radiance.modifier.material.absdf module
                    • honeybee_radiance.modifier.material.antimatter module
                    • honeybee_radiance.modifier.material.ashik2 module
                    • honeybee_radiance.modifier.material.brtdfunc module
                    • honeybee_radiance.modifier.material.bsdf module
                    • honeybee_radiance.modifier.material.dielectric module
                    • honeybee_radiance.modifier.material.glass module
                    • honeybee_radiance.modifier.material.glow module
                    • honeybee_radiance.modifier.material.illum module
                    • honeybee_radiance.modifier.material.interface module
                    • honeybee_radiance.modifier.material.light module
                    • honeybee_radiance.modifier.material.materialbase module
                    • honeybee_radiance.modifier.material.metal module
                    • honeybee_radiance.modifier.material.metal2 module
                    • honeybee_radiance.modifier.material.metdata module
                    • honeybee_radiance.modifier.material.metfunc module
                    • honeybee_radiance.modifier.material.mirror module
                    • honeybee_radiance.modifier.material.mist module
                    • honeybee_radiance.modifier.material.plasdata module
                    • honeybee_radiance.modifier.material.plasfunc module
                    • honeybee_radiance.modifier.material.plastic module
                    • honeybee_radiance.modifier.material.plastic2 module
                    • honeybee_radiance.modifier.material.prism1 module
                    • honeybee_radiance.modifier.material.prism2 module
                    • honeybee_radiance.modifier.material.spotlight module
                    • honeybee_radiance.modifier.material.trans module
                    • honeybee_radiance.modifier.material.trans2 module
                    • honeybee_radiance.modifier.material.transdata module
                    • honeybee_radiance.modifier.material.transfunc module
                  • Module contents
                • honeybee_radiance.modifier.mixture package
                  • Submodules
                    • honeybee_radiance.modifier.mixture.mixdata module
                    • honeybee_radiance.modifier.mixture.mixfunc module
                    • honeybee_radiance.modifier.mixture.mixpict module
                    • honeybee_radiance.modifier.mixture.mixtext module
                    • honeybee_radiance.modifier.mixture.mixturebase module
                  • Module contents
                • honeybee_radiance.modifier.pattern package
                  • Submodules
                    • honeybee_radiance.modifier.pattern.brightdata module
                    • honeybee_radiance.modifier.pattern.brightfunc module
                    • honeybee_radiance.modifier.pattern.brighttext module
                    • honeybee_radiance.modifier.pattern.colordata module
                    • honeybee_radiance.modifier.pattern.colorfunc module
                    • honeybee_radiance.modifier.pattern.colorpict module
                    • honeybee_radiance.modifier.pattern.colortext module
                    • honeybee_radiance.modifier.pattern.patternbase module
                  • Module contents
                • honeybee_radiance.modifier.texture package
                  • Submodules
                    • honeybee_radiance.modifier.texture.texdata module
                    • honeybee_radiance.modifier.texture.texfunc module
                    • honeybee_radiance.modifier.texture.texturebase module
                  • Module contents
              • Submodules
                • honeybee_radiance.modifier.modifierbase module
              • Module contents
            • honeybee_radiance.postprocess package
              • Submodules
                • honeybee_radiance.postprocess.annual module
                • honeybee_radiance.postprocess.annualdaylight module
                • honeybee_radiance.postprocess.annualglare module
                • honeybee_radiance.postprocess.annualirradiance module
                • honeybee_radiance.postprocess.electriclight module
                • honeybee_radiance.postprocess.en17037 module
                • honeybee_radiance.postprocess.leed module
                • honeybee_radiance.postprocess.solartracking module
              • Module contents
            • honeybee_radiance.properties package
              • Submodules
                • honeybee_radiance.properties.aperture module
                • honeybee_radiance.properties.door module
                • honeybee_radiance.properties.face module
                • honeybee_radiance.properties.model module
                • honeybee_radiance.properties.room module
                • honeybee_radiance.properties.shade module
              • Module contents
          • Submodules
            • honeybee_radiance.config module
            • honeybee_radiance.dictutil module
            • honeybee_radiance.lightpath module
            • honeybee_radiance.modifierset module
            • honeybee_radiance.mutil module
            • honeybee_radiance.primitive module
            • honeybee_radiance.putil module
            • honeybee_radiance.reader module
            • honeybee_radiance.sensor module
            • honeybee_radiance.sensorgrid module
            • honeybee_radiance.view module
            • honeybee_radiance.writer module
          • Module contents
  • Page
      • CLI Docs
      • honeybee_radiance
  • CLI Docs »
  • Source
  • CLI Docs
  • honeybee_radiance

Welcome to Honeybee Radiance’s documentation!¶

http://www.ladybug.tools/assets/img/honeybee.png

Radiance extension for honeybee

Honeybee-radiance adds radiance functionalities to honeybee for daylight simulation.

Installation¶

pip install -U honeybee-radiance

To check if the command line interface is installed correctly use honeybee-radiance --help.

CLI Docs¶

For command line interface documentation and API documentation see the pages below.

  • CLI Docs
    • Installation
    • Commands

honeybee_radiance¶

  • honeybee_radiance
    • honeybee_radiance package
      • Subpackages
        • honeybee_radiance.cli package
        • honeybee_radiance.dynamic package
        • honeybee_radiance.geometry package
        • honeybee_radiance.lib package
        • honeybee_radiance.lightsource package
        • honeybee_radiance.modifier package
        • honeybee_radiance.postprocess package
        • honeybee_radiance.properties package
      • Submodules
        • honeybee_radiance.config module
        • honeybee_radiance.dictutil module
        • honeybee_radiance.lightpath module
        • honeybee_radiance.modifierset module
        • honeybee_radiance.mutil module
        • honeybee_radiance.primitive module
        • honeybee_radiance.putil module
        • honeybee_radiance.reader module
        • honeybee_radiance.sensor module
        • honeybee_radiance.sensorgrid module
        • honeybee_radiance.view module
        • honeybee_radiance.writer module
      • Module contents

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Back to top

© Copyright 2023, Ladybug Tools.
Created using Sphinx 3.3.1.