Skip to content

Open-ET/openet-core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenET - Core Functions and Tools

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 core functions used by the OpenET models.

Core Components

Common

The OpenET "common" module provides functions that are common across many of the OpenET models. Currently these are limited to operations like cloud masking, but additional functions will be added as they are identified.

Examples of the cloud masking functions are provided in the "examples" folder.

Interpolation

The OpenET "interpolate" module provides functions for interpolating the image based ET estimates from the models (primarily from Landsat images) to a daily time step then aggregating to custom time periods (such as monthly or annual).

Ensemble

The OpenET "ensemble" module provides the function used to calculate the OpenET ensemble median absolute deviation (mad).

Installation

The OpenET core python module can be installed via pip:

pip install openet-core

Dependencies

Modules needed to run the model:

OpenET Namespace Package

Each OpenET model will be stored in sub-folders of the "openet" folder (namespace). The benefit of the namespace package is that each ET model can be tracked in separate repositories but called as a "dot" submodule of the main openet module,

import openet.core.common
import openet.core.interpolate
import openet.ssebop

Development and Testing

Please see the CONTRIBUTING.rst.