Skip to main content

Earth Engine implementation of the PTJPL model

Project description

Latest version on PyPI Build status

WARNING: This code is in development, is being provided without support, and is subject to change at any time without notification

This repository provides an Earth Engine Python API based implementation of the PT-JPL model for computing evapotranspiration (ET).

Through ecophysiological constraint functions, PT-JPL retrieves actual ET by reducing potential ET starting with the Priestley-Taylor equation (PriestleyTaylor1972). A series of ecophysiological scalar functions, based on atmospheric vapor pressure deficit, relative humidity, and vegetation indices simultaneously reduce potential ET to actual ET, and partition total ET into three sources for canopy transpiration, soil evaporation, and interception evaporation (Fisher2008). PT-JPL is run globally and continuously in space and time with no need for calibration or site-specific parameters.

Model Design

The primary component of the PT-JPL model is the Image() class. The Image class can be used to compute a single ET image from a single input image. The Image class should generally be instantiated from an Earth Engine Landsat image using the collection specific methods listed below. ET image collections can be built by computing ET in a function that is mapped over a collection of input images. Please see the Example Notebooks for more details.

Input Collections

PT-JPL can currently be computed for Landsat Collection 2 Level 2 (SR/ST) images images from the following Earth Engine image collections:

  • LANDSAT/LT05/C02/T1_L2

  • LANDSAT/LE07/C02/T1_L2

  • LANDSAT/LC08/C02/T1_L2

  • LANDSAT/LC09/C02/T1_L2

Landsat Collection 2 SR/ST Input Image

To instantiate the class for a Landsat Collection 2 SR/ST image, use the Image.from_landsat_c2_sr method.

The input Landsat image must have the following bands and properties:

SPACECRAFT_ID

Band Names

LANDSAT_5

SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B7, ST_B6, QA_PIXEL

LANDSAT_7

SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B7, ST_B6, QA_PIXEL

LANDSAT_8

SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B6, SR_B7, ST_B10, QA_PIXEL

LANDSAT_9

SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B6, SR_B7, ST_B10, QA_PIXEL

Property

Description

system:index

  • Landsat Scene ID

  • Must be in the Earth Engine format (e.g. LC08_044033_20170716)

  • Used to lookup the scene specific c-factor

system:time_start

Image datetime in milliseconds since 1970

SPACECRAFT_ID

  • Used to determine which Landsat type

  • Must be: LANDSAT_5, LANDSAT_7, LANDSAT_8, or LANDSAT_9

Model Output

The primary output of the PT-JPL model is the actual ET (ETa) in millimeters.

Example

import openet.ptjpl as ptjpl

landsat_img = ee.Image('LANDSAT/LC08/C02/T1_L2/LC08_044033_20170716')
et_actual = ptjpl.Image.from_landsat_c2_sr(landsat_img).et

Example Notebooks

Meteorology

The GEE NLDAS hourly image collection is the default and only currently supported meteorology source for the hourly air temperature, vapor pressure, windspeed, and incoming short and longwave solar radiation.

Ancillary Datasets

Optimal temperature (Topt)

Maximum fraction of absorbed photosynthetically active radiation (fAPARmax)

Installation

The OpenET PT-JPL python module can be installed via pip:

pip install openet-ptjpl

Dependencies

OpenET Namespace Package

Each OpenET model is stored in the “openet” folder (namespace). The model can then be imported as a “dot” submodule of the main openet module.

import openet.ptjpl as model

Development and Testing

Please see the CONTRIBUTING.rst.

References

[Fisher2008]
Fisher, J., K. Tu, and D. Baldocchi (2008). Global estimates of the land-atmosphere water flux based on monthly AVHRR and ISLSCP-II data, validated at 16 FLUXNET sites, Remote Sensing of Environment, 112(3), 901-919.
[PriestleyTaylor1972]
Priestley, C. and R. Taylor (1972). On the assessment of surface heat flux and evaporation using large scale parameters. Monthly Weather Review, 100, 81–92.

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

openet_ptjpl-0.4.0.tar.gz (68.3 kB view details)

Uploaded Source

File details

Details for the file openet_ptjpl-0.4.0.tar.gz.

File metadata

  • Download URL: openet_ptjpl-0.4.0.tar.gz
  • Upload date:
  • Size: 68.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.8

File hashes

Hashes for openet_ptjpl-0.4.0.tar.gz
Algorithm Hash digest
SHA256 276f519d40de55369064ad5201f6d5eb5222e89c32c33e1557f0aa8e41893267
MD5 4ac63d2c17f74db0e03284502e8ea7cc
BLAKE2b-256 153cf535615f6f5c08b6e1251cf9521927e7c0a8f150027e7844051a4d9f7c06

See more details on using hashes here.

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