Package: openet-sims
WARNING: This code is in development, is being provided without support, and is subject to change at any time without notificationThis repository provides an Earth Engine Python API based implementation of the SIMS model for computing evapotranspiration (ET).Input CollectionsThe SIMS model is currently implemented for the following Earth Engine image collections:Landsat SRLANDSAT/LC09/C02/T1_L2LANDSAT/LC08/C02/T1_L2LANDSAT/LE07/C02/T1_L2LANDSAT/LT05/C02/T1_L2LANDSAT/LT04/C02/T1_L2Model StructureThe primary way of interact with the SIMS model are through the “Collection” and “Image” classes.CollectionThe Collection class should be used to generate image collections of ET (and and other modelVariables).  These collections can be for image “overpass” dates only or interpolated to daily, monthly, or annual time steps.  The collections can be built for multiple input collections types, such as merging Landsat 8 and Sentinel 2.The Collection class is built based on a list of input collections ID’s, a date range, and a study area geometry.Required InputscollectionsList of Earth Engine collection IDs (seeInput Collections).start_dateISO format start date string (i.e. YYYY-MM-DD) that is passed directly to the collection .filterDate() calls.end_dateISO format end date string that is passed directly to .filterDate() calls.  The end date must be exclusive (i.e. data will go up to this date but not include it).geometryee.Geometry() that is passed to the collection .filterBounds() calls.
All images with a footprint that intersects the geometry will be included.et_reference_sourceReference ET source collection ID  (seeReference ET Sources).et_reference_bandReference ET source band name.Optional Inputscloud_cover_maxMaximum cloud cover percentage.
The input collections will be filtered to images with a cloud cover percentage less than this value.
Optional, the default is 70 (%).filter_argsCustom filter arguments for teh input collections.
This parameter is not yet fully implemented.model_argsA dictionary of argument to pass through to the Image class initialization.
This parameter is not yet fully implemented.Overpass MethodvariablesList of variables to calculate/return.Interpolate MethodvariablesList of variables to calculate/return.t_intervalTime interval over which to interpolate and aggregate values.
Choices: ‘daily’, ‘monthly’, ‘annual’, ‘custom’
Optional, the default is ‘custom’.interp_methodInterpolation method.
Choices: ‘linear’
Optional, the default is ‘linear’.interp_daysNumber of extra days before the start date and after the end date to include in the interpolation calculation.
Optional, the default is 32.Collection Examplesimportopenet.simsasmodeloverpass_coll=model.Collection(collections=['LANDSAT/LC08/C02/T1_L2'],start_date='2017-06-01',end_date='2017-09-01',geometry=ee.Geometry.Point(-121.5265,38.7399),et_reference_source='IDAHO_EPSCOR/GRIDMET',et_reference_band='eto')\.overpass(variables=['et','et_reference','et_fraction'])monthly_coll=model.Collection(collections=['LANDSAT/LC08/C02/T1_L2'],start_date='2017-06-01',end_date='2017-09-01',geometry=ee.Geometry.Point(-121.5265,38.7399),et_reference_source='IDAHO_EPSCOR/GRIDMET',et_reference_band='eto')\.interpolate(variables=['et','et_reference','et_fraction']t_interval='monthly')ImageThe Image class should be used to process a single image, an image collection with custom filtering, or to apply custom parameters to each image in a collection.Typically the SIMS Image is initialized using one of the collection/sensor specific helper methods listed below (see below).  These methods rename the bands to a common naming scheme, apply basic cloud masking, and .Image collections can be built by mapping one of the helper methods over an image collection.  Please see theImage Mappingexample notebook for more details.The Image class can also be initialized using any Earth Engine image with an ‘ndvi’ band and a ‘system:time_start’ property.Landsat Collection 2 Surface Reflectance (SR) Input ImageTo instantiate the class for a Landsat Collection 2 SR image, use the Image.from_landsat_c2_sr() method.The input Landsat image must have the following bands and properties:SATELLITEBand NamesLANDSAT_4SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B7, SR_B6, QA_PIXELLANDSAT_5SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B7, SR_B6, QA_PIXELLANDSAT_7SR_B1, SR_B2, SR_B3, SR_B4, SR_B5, SR_B7, SR_B6, QA_PIXELLANDSAT_8SR_B2, SR_B3, SR_B4, SR_B5, SR_B6, SR_B7, SR_B10, QA_PIXELLANDSAT_9SR_B2, SR_B3, SR_B4, SR_B5, SR_B6, SR_B7, SR_B10, QA_PIXELPropertyDescriptionsystem:indexLandsat Scene IDMust be in the Earth Engine format (e.g. LC08_044033_20170716)system:time_startImage datetime in milliseconds since 1970SPACECRAFT_IDUsed to determine which Landsat type (for band renaming)Must be: LANDSAT_4, LANDSAT_5, LANDSAT_7, LANDSAT_8, or LANDSAT_9Image Exampleimportopenet.simsasmodelet_img=model.Image.from_landsat_c2_sr(ee.Image('LANDSAT/LC08/C02/T1_L2/LC08_044033_20170716'),et_reference_source='IDAHO_EPSCOR/GRIDMET',et_reference_band='eto').etVariablesThe SIMS model can compute the following variables:ndviNormalized difference vegetation index [unitless]et_fractionFraction of reference ET [unitless]et_referenceReference ET [mm] (type will depend onReference ETparameters)etActual ET [mm]There is also a more general “calculate” method that can be used to return a multiband image of multiple variables (see example…)Reference ETThe reference ET data source is controlled using the “et_reference_source” and “et_reference_band” parameters.The model is expecting a grass reference ET (ETo) and will not return valid results if an alfalfa reference ET (ETr) is used.Reference ET SourcesGRIDMETCollection ID: IDAHO_EPSCOR/GRIDMEThttp://www.climatologylab.org/gridmet.htmlGrass reference ET band: etoSpatial CIMISCollection ID: projects/openet/cimis/dailyhttps://cimis.water.ca.gov/SpatialData.aspxGrass reference ET band: ETo_ASCEExample NotebooksDetailed Jupyter Notebooks of the various approaches for calling the OpenET SIMS model are provided in the “examples” folder.Computing daily ET for a single Landsat imageComputing a collection of “overpass” ET imagesComputing a collection of interpolated monthly ET imagesInstallationThe python OpenET SIMS module can be installed via pip:pip install openet-simsDependenciesearthengine-apiopenet-coreOpenET Namespace PackageEach 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.sims as modelDevelopment and TestingPlease see theCONTRIBUTING.rst.References