Skip to main content

Python tools for generating vegetation index timeseries from PhenoCam images.

Project description

PyPI Package latest release Travis-CI Build Status Documentation Status Supported versions

Python tools for generating vegetation index timeseries from PhenoCam images.

  • Free software: MIT license


The PhenoCam Network is a project designed to study the patterns of seasonal variation (phenology) of vegetation. The project website is at The network consists of many cameras collecting images of various types of vegetation. By analysing the images we can quantify the seasonal changes at a particular camera site.

A “vegetation index” refers to a quantity calculated using information from various spectral bands of an image of a vegetated area. The image is typically obtained from a remote-sensing instrument on an earth orbiting satellite. There are several vegetation index values in common usage. The most widely used are NDVI (Normalized Difference Vegetation Index) and EVI (Enhanced Vegetation Index). For the PhenoCam project the Green Chromatic Coordinate or GCC is our standard vegetation index.

For the PhenoCam network, the images are obtained from webcams (usually installed on towers) looking across a vegetated landscape. These images are typically in JPEG format and have 3-bands (Red, Green, and Blue). For some cameras a separate image dominated by an IR (infrared) band is collected.

The algorithms used in in this package have been discussed in numerous publications. You can find a list of publications for the PhenoCam Network project here. The details of the calculation of GCC are presented in this jupyter notebook .

After the package is installed two python scripts should be available:

  • generate_roi_timeseries

  • generate_summary_timeseries

These scripts allow you to reproduce the PhenoCam network “standard timeseries products” from downloaded data. For a description of the products see the project Tools Page.

Quick Installation

From the command line type:

pip install vegindex

Some of the packages that vegindex depends on may not install automatically (using pip) since they depend on system libraries. If the above command does not work you can try:

pip install Pillow
pip install vegindex

The latest version of the documentation can be found at


0.7.2 (2030-04-12)

  • Add 3.8 tox environment to tox.ini

0.7.0 (2020-04-01)

  • Add checks when reading an ROI List CSV file that the time ranges are in order and don’t overlap

0.6.1 (2019-07-15)

  • Update installation doc.

  • Simple test for reading roistats file.

0.6.0 (2019-07-12)

  • Add awbflag (auto white-balance) to roistats file

0.5.3 (2019-04-03)

  • Update requirements for python 3.7

  • Add prefix to regular expressions

0.5.2 (2018-04-09)

  • Really fix bug in plot_roistats when no data are filtered.

0.5.1 (2018-04-09)

  • Fix bug in plot_roistats when no data are filtered.

  • Update docs

0.5.0 (2017-11-29)

  • Fix header on roistats.csv file

  • Add plotting script (matplotlib library is now required)

  • Remove timeout on requests query which was causing tests to fail.

  • Update usage docs

0.4.0 (2017-11-27)

  • Add fallback to local site_info.csv file to get basic site metadata

  • Update exception handling (removed bare exceptions)

0.3.1 (2017-10-06)

  • Change data product name from _roi_statistics.csv to _roistats.csv

0.3.0 (2017-09-12)

  • Added support for .meta files

  • Change data product name from _timeseries.csv to _roi_statistics.csv

0.2.0rc1 (2017-06-14)

  • Added support for python3

0.1.1rc3 (2017-06-13)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vegindex-0.7.2.tar.gz (3.2 MB view hashes)

Uploaded Source

Built Distributions

vegindex-0.7.2-py3.8.egg (71.9 kB view hashes)

Uploaded Source

vegindex-0.7.2-py2.py3-none-any.whl (36.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page