Hi
I am trying to automatically list the lamp lm/W or luminaire lm/W efficacy from my VE Compliance Actual model through the IES Python API.
I have examined the dictionary item ‘gain_detail’ which is where I would expect it to be, but efficacy variables appear to be missing from the key. The API can see the input method is inference but it does not go on to list the lm/W efficacy input. In addition, when inference is chosen, the ‘max_illuminance’ variable is also missing.
Is there a way to extract the lighting efficacy in lm/W and the max_illuminance when inference is chosen? Perhaps it is under a different dictionary item?
Thanks
CP
IES Python API - Trying to extract lighting efficacy lm/W
- Complex Potential
- VE Expert

- Posts: 467
- Joined: Wed Jan 09, 2013 11:57 am
- Location: Bristol, UK
Re: IES Python API - Trying to extract lighting efficacy lm/W
Hi,
get_ncm_lighting() in VERoomData might be what you're looking for? From the user guide:
get_ncm_lighting() in VERoomData might be what you're looking for? From the user guide:
Hope that helps.get_ncm_lighting() -> dictionary
Get NCM lighting data. Only use this on NCM models.
Returns:
Dictionary with the following entries:
automatic_daylight_zoning
automatic_daylight_zoning_percentage
constant_illuminance_control
control_type
design_illuminance
different_sensor_control_back
display_lighting_time_switching
has_display_lighting
lamp_efficacy
lamp_type
light_output_ratio
lighting_case
lumens_circuit_watt
luminaires_fitted
occupancy_parasitic_power
occupancy_parasitic_power_default
occupancy_parasitic_power_unit
occupancy_time_switch_control
occupancy_sensing
photoelectric_parasitic_power
photoelectric_parasitic_power_default
photoelectric_parasitic_power_unit
photoelectric_time_switch_control
sensor_type
use_efficient_lamps
use_photoelectric
wattage
wattage_unit
- Complex Potential
- VE Expert

- Posts: 467
- Joined: Wed Jan 09, 2013 11:57 am
- Location: Bristol, UK
Re: IES Python API - Trying to extract lighting efficacy lm/W
Many thanks
That does indeed look promising. I shall take a look and see if it works!
EDIT: BTW, where did you find that user guide?? I've searched at the below link and can find no mention of the get_ncm_lighting dictionary.
https://help.iesve.com/ve2018/conventio ... 3D&mw=MjQw
That does indeed look promising. I shall take a look and see if it works!
EDIT: BTW, where did you find that user guide?? I've searched at the below link and can find no mention of the get_ncm_lighting dictionary.
https://help.iesve.com/ve2018/conventio ... 3D&mw=MjQw
Re: IES Python API - Trying to extract lighting efficacy lm/W
I think the web version is a little out of date, if you contact support they can give you an updated PDF manual.
- Complex Potential
- VE Expert

- Posts: 467
- Joined: Wed Jan 09, 2013 11:57 am
- Location: Bristol, UK
Re: IES Python API - Trying to extract lighting efficacy lm/W
Thank you.
I have managed to get hold of the up to date user guide PDF.
Unfortunately the get_ncm_lighting() dictionary only seems to list data from SBEM which does not automatically match to the DSM which is what I use.
So it seems I'm back to square 1 unless you know of a way to force the 'lumens_circuit_watt' and 'design_illuminance' keys to get their entries from the NCM DSM model rather than the SBEM model?
I have managed to get hold of the up to date user guide PDF.
Unfortunately the get_ncm_lighting() dictionary only seems to list data from SBEM which does not automatically match to the DSM which is what I use.
So it seems I'm back to square 1 unless you know of a way to force the 'lumens_circuit_watt' and 'design_illuminance' keys to get their entries from the NCM DSM model rather than the SBEM model?
Re: IES Python API - Trying to extract lighting efficacy lm/W
Hi,
I don't have the answer to your question, but to the user guide problem, personally I use this command to get all the help:
Then I copy / paste somewhere to do my research
Regards,
Kevin
I don't have the answer to your question, but to the user guide problem, personally I use this command to get all the help:
Code: Select all
import iesve
help (iesve)Regards,
Kevin

