Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.14 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.14 KB

Python library for calculating eco benefit data for trees

Generally you need a region code, species code, and factor type. You can also use some convenience functions to get around factor type all together.

Install

eco.py isn't up on pypi yet so get it with git:

pip install git+git://github.com/azavea/eco.py.git

Example

from eco import benefits

dbh_cm = 311 # Diameter at breast height in
             # centimeters

# Get a list of all regions
regions = benefits.regions

# Regions use the original iTree Streets code names
# in this example we can use the Northeast region:
region = 'NoEastXXX'

# Get a list of all factors that can be looked up
# in a given region (such as "aq_nox_avoided", etc)
factors = benefits.factors_for_region(region)

species_code = benefits.lookup_species_code(region,
                       genus='Cedrus', species='atlantica')

# Get the amount of nox avoided:
nox_avoided =
     benefits.get_factor_for_tree(region,
                  'aq_nox_avoided', [(species_code, dbh_cm)])

# Get total energy saved
kwh_saved =
    benefits.get_energy_conserved(region, [(species_code, dbh_cm)])