OpenET

Provides Google Earth Engine Python API based implementation of the SSEBop ET model used within OpenET.
https://github.com/Open-ET/openet-ssebop

Category: Natural Resources
Sub Category: Water Supply and Quality

Last synced: 1 day ago
JSON representation

Repository metadata

Earth Engine SSEBop ET Model

• Host: GitHub
• URL: https://github.com/Open-ET/openet-ssebop
• Owner: Open-ET
• License: apache-2.0
• Created: 2018-08-30T17:40:24.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2026-05-27T19:18:07.000Z (21 days ago)
• Last Synced: 2026-06-11T06:04:32.301Z (6 days ago)
• Language: Python
• Homepage:
• Size: 81.5 MB
• Stars: 53
• Watchers: 8
• Forks: 32
• Open Issues: 4
• Releases: 14
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt

README.rst

          ===============
OpenET - SSEBop
===============

|version| |build|

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

This repository provides `Google Earth Engine `__ Python API based implementation of the SSEBop ET model.

The Operational Simplified Surface Energy Balance (SSEBop) model computes daily total actual evapotranspiration (ETa) using land surface temperature (Ts), maximum air temperature (Ta) and reference ET (ETr or ETo).
The SSEBop model does not solve all the energy balance terms explicitly; rather, it defines the limiting conditions based on "gray-sky" net radiation balance principles and an air temperature parameter.
This approach predefines unique sets of "hot/dry" and "cold/wet" limiting values for each pixel, allowing an operational model setup and a relatively shorter compute time. More information on the GEE implementation of SSEBop is published in Senay2022_ and Senay2023_ with additional details and model assessment.

*Basic SSEBop model implementation in Earth Engine:*

.. image:: docs/SSEBop_GEE_diagram.jpg

Model Design
============

The primary component of the SSEBop model is the Image() class.  The Image class can be used to compute a single fraction of reference ET (ETf) 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
=================

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

 * LANDSAT/LC09/C02/T1_L2
 * LANDSAT/LC08/C02/T1_L2
 * LANDSAT/LE07/C02/T1_L2
 * LANDSAT/LT05/C02/T1_L2

**Note:** Users are encouraged to prioritize use of Collection 2 data where available. Collection 1 was produced by USGS until 2022-01-01, and maintained by Earth Engine until 2023-01-01. [`More Information `__]

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
=================  ======================================

Model Output
------------

The primary output of the SSEBop model is the fraction of reference ET (ETf).  The actual ET (ETa) can then be computed by multiplying the Landsat-based ETf image with the reference ET (e.g. ETr from GRIDMET).

*Example SSEBop ETa from Landsat:*

.. image:: docs/ET_example.PNG

Example
-------

.. code-block:: python

    import openet.ssebop as ssebop

    landsat_img = ee.Image('LANDSAT/LC08/C02/T1_L2/LC08_044033_20170716')
    et_fraction = ssebop.Image.from_landsat_c2_sr(landsat_img).et_fraction
    et_reference = ee.Image('IDAHO_EPSCOR/GRIDMET/20170716').select('etr')
    et_actual = et_fraction.multiply(et_reference)

Example Notebooks
=================

Detailed Jupyter Notebooks of the various approaches for calling the OpenET SSEBop model are provided in the "examples" folder.

+ `Computing daily ET for a single Landsat image `__
+ `Computing a daily ET image collection from Landsat image collection `__
+ `Computing monthly ET from a collection `__

Ancillary Datasets
==================

Land Surface Temperature (LST)
------------------------------
Land Surface Temperature is currently calculated in the SSEBop approach two ways:

* Landsat Collection 2 Level-2 (ST band) images directly. More information can be found at: `USGS Landsat Collection 2 Level-2 Science Products `__

Temperature Difference (dT)
---------------------------
The SSEBop ET model uses dT as a predefined temperature difference between Thot and Tcold for each pixel.
In SSEBop formulation, hot and cold limits are defined on the same pixel; therefore, dT actually represents the vertical temperature difference between the surface temperature of a theoretical bare/dry condition of a given pixel and the air temperature at the canopy level of the same pixel as explained in Senay2018_. The input dT is calculated under "gray-sky" conditions and assumed not to change from year to year, but is unique for each day and location.

Default Asset ID: *projects/usgs-ssebop/dt/daymet_median_v7*

Cold Boundary Temperature (Tcold)
-----------------------------------
In order to determine the theoretical LST corresponding to cold/wet limiting environmental conditions (Tcold), the
SSEBop model uses a Forcing and Normalizing Operation (FANO) method, featuring a linear relation between a normalized
land surface temperature difference and NDVI difference using the dT parameter and a proportionality constant.

More information on parameter design and model improvements using the FANO method can be found in Senay2023_. Additional SSEBop model algorithm theoretical basis documentation can be found `here `__.

.. code-block:: python

    model_obj = model.Image.from_landsat_c2_sr(
        ee.Image('LANDSAT/LC08/C02/T1_L2/LC08_044033_20170716'),
    )

The FANO parameterization allows the establishment of the cold boundary condition regardless of vegetation cover density, improving the performance and operational implementation of the SSEBop ET model in sparsely vegetated landscapes, dynamic growing seasons, and varying locations around the world.

Installation
============

The OpenET SSEBop python module can be installed via pip:

.. code-block:: console

    pip install openet-ssebop

Dependencies
============

 * `earthengine-api `__
 * `openet-core `__

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.

.. code-block:: console

    import openet.ssebop as ssebop

Development and Testing
=======================

Please see the `CONTRIBUTING.rst `__.

References
==========

.. _references:

.. [Senay2013]
 | Senay, G., Bohms, S., Singh, R., Gowda, P., Velpuri, N., Alemu, H., Verdin, J. (2013). Operational Evapotranspiration Mapping Using Remote Sensing and Weather Datasets: A New Parameterization for the SSEB Approach. *Journal of the American Water Resources Association*, 49(3).
 | `https://doi.org/10.1111/jawr.12057 `__
.. [Senay2016]
 | Senay, G., Friedrichs, M., Singh, R., Velpui, N. (2016). Evaluating Landsat 8 evapotranspiration for water use mapping in the Colorado River Basin. *Remote Sensing of Environment*, 185.
 | `https://doi.org/10.1016/j.rse.2015.12.043 `__
.. [Senay2017]
 | Senay, G., Schauer, M., Friedrichs, M., Manohar, V., Singh, R. (2017). Satellite-based water use dynamics using historical Landsat data (1984\-2014) in the southwestern United States. *Remote Sensing of Environment*, 202.
 | `https://doi.org/10.1016/j.rse.2017.05.005 `__
.. [Senay2018]
 | Senay, G. (2018). Satellite Psychrometric Formulation of the Operational Simplified Surface Energy Balance (SSEBop) Model for Quantifying and Mapping Evapotranspiration. *Applied Engineering in Agriculture*, 34(3).
 | `https://doi.org/10.13031/aea.12614 `__
.. [Senay2019]
 | Senay, G., Schauer, M., Velpuri, N.M., Singh, R.K., Kagone, S., Friedrichs, M., Litvak, M.E., Douglas-Mankin, K.R. (2019). Long-Term (1986–2015) Crop Water Use Characterization over the Upper Rio Grande Basin of United States and Mexico Using Landsat-Based Evapotranspiration. *Remote Sensing*, 11(13):1587.
 | `https://doi.org/10.3390/rs11131587 `__
.. [Schauer2019]
 | Schauer, M., Senay, G. (2019). Characterizing Crop Water Use Dynamics in the Central Valley of California Using Landsat-Derived Evapotranspiration. *Remote Sensing*, 11(15):1782.
 | `https://doi.org/10.3390/rs11151782 `__
.. [Senay2022]
 | Senay, G.B., Friedrichs, M., Morton, C., Parrish, G. E., Schauer, M., Khand, K., ... & Huntington, J. (2022). Mapping actual evapotranspiration using Landsat for the conterminous United States: Google Earth Engine implementation and assessment of the SSEBop model. *Remote Sensing of Environment*, 275, 113011
 | `https://doi.org/10.1016/j.rse.2022.113011 `__
.. [Senay2023]
 | Senay, G.B., Parrish, G. E., Schauer, M., Friedrichs, M., Khand, K., Boiko, O., Kagone, S., Dittmeier, R., Arab, S., Ji, L. (2023). Improving the Operational Simplified Surface Energy Balance evapotranspiration model using the Forcing and Normalizing Operation. *Remote Sensing*, 15(1):260.
 | `https://doi.org/10.3390/rs15010260 `__

.. |build| image:: https://github.com/Open-ET/openet-ssebop/actions/workflows/tests.yml/badge.svg
   :alt: Build status
   :target: https://github.com/Open-ET/openet-ssebop
.. |version| image:: https://badge.fury.io/py/openet-ssebop.svg
   :alt: Latest version on PyPI
   :target: https://badge.fury.io/py/openet-ssebop

        

---

Owner metadata

• Name: Open ET
• Login: Open-ET
• Email:
• Kind: organization
• Description: Repositories for the Open ET project, which aims to provide open and easily accessible evapotranspiration data for improved water management
• Website: https://etdata.org/
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/18035656?v=4
• Repositories: 5
• Last ynced at: 2023-03-02T23:35:23.877Z
• Profile URL: https://github.com/Open-ET

---

GitHub Events

Total

• Release event: 2
• Delete event: 5
• Pull request event: 17
• Fork event: 3
• Issues event: 11
• Watch event: 8
• Issue comment event: 11
• Push event: 60
• Pull request review event: 2
• Create event: 13

Last Year

• Pull request event: 2
• Fork event: 3
• Issues event: 3
• Watch event: 2
• Issue comment event: 1
• Push event: 12
• Create event: 4

---

Committers metadata

Last synced: 4 days ago

Name	Email	Commits
Charles Morton	c****n@g****m	458
gabe-parrish	g****h@g****m	104
Mac Friedrichs	m****2@g****m	50
macfriedrichs	m****r@u****v	9
Peter ReVelle	p****e@g****m	2
Tyler Erickson	t****e@g****m	1

Committer domains:

• google.com: 1
• usgs.gov: 1

---

Issue and Pull Request metadata

Last synced: 6 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/Open-ET/openet-ssebop

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 170 last-month
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 2 (may contain duplicates)
• Total versions: 58
• Total maintainers: 1

---

Dependencies

Score: 10.988102331560384