=================================
OpenET - Core Functions and Tools
=================================
|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 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.
+ `Landsat Collection 2 SR cloud mask <examples/landsat_c2_sr_cloud_mask.ipynb>`__
+ `Sentinel 2 TOA cloud mask <examples/sentinel2_toa_cloud_mask.ipynb>`__
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:
.. code-block:: console
pip install openet-core
Dependencies
============
Modules needed to run the model:
* `earthengine-api <https://github.com/google/earthengine-api>`__
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,
.. code-block:: python
import openet.core.common
import openet.core.interpolate
import openet.ssebop
Development and Testing
=======================
Please see the `CONTRIBUTING.rst <CONTRIBUTING.rst>`__.
.. |build| image:: https://github.com/Open-ET/openet-core/actions/workflows/test.yml/badge.svg
:alt: Build status
:target: https://github.com/Open-ET/openet-core
.. |version| image:: https://badge.fury.io/py/openet-core.svg
:alt: Latest version on PyPI
:target: https://badge.fury.io/py/openet-core
Raw data
{
"_id": null,
"home_page": "",
"name": "openet-core",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "OpenET,Earth Engine,Evapotranspiration,Landsat",
"author": "",
"author_email": "Charles Morton <charles.morton@dri.edu>",
"download_url": "https://files.pythonhosted.org/packages/70/17/516726dd12c71d64e6a1c65b4ca3d3d8ebb09c6243ed050672fa7f7dc988/openet-core-0.4.1.tar.gz",
"platform": null,
"description": "=================================\nOpenET - Core Functions and Tools\n=================================\n\n|version| |build|\n\n**WARNING: This code is in development, is being provided without support, and is subject to change at any time without notification**\n\nThis repository provides core functions used by the OpenET models.\n\nCore Components\n===============\n\nCommon\n------\n\nThe 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.\n\nExamples of the cloud masking functions are provided in the \"examples\" folder.\n\n+ `Landsat Collection 2 SR cloud mask <examples/landsat_c2_sr_cloud_mask.ipynb>`__\n+ `Sentinel 2 TOA cloud mask <examples/sentinel2_toa_cloud_mask.ipynb>`__\n\nInterpolation\n-------------\n\nThe 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).\n\nEnsemble\n--------\n\nThe OpenET \"ensemble\" module provides the function used to calculate the OpenET ensemble median absolute deviation (mad).\n\nInstallation\n============\n\nThe OpenET core python module can be installed via pip:\n\n.. code-block:: console\n\n pip install openet-core\n\nDependencies\n============\n\nModules needed to run the model:\n\n * `earthengine-api <https://github.com/google/earthengine-api>`__\n\nOpenET Namespace Package\n========================\n\nEach 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,\n\n.. code-block:: python\n\n import openet.core.common\n import openet.core.interpolate\n import openet.ssebop\n\nDevelopment and Testing\n=======================\n\nPlease see the `CONTRIBUTING.rst <CONTRIBUTING.rst>`__.\n\n.. |build| image:: https://github.com/Open-ET/openet-core/actions/workflows/test.yml/badge.svg\n :alt: Build status\n :target: https://github.com/Open-ET/openet-core\n.. |version| image:: https://badge.fury.io/py/openet-core.svg\n :alt: Latest version on PyPI\n :target: https://badge.fury.io/py/openet-core\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "OpenET Core Components",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/Open-ET/openet-core"
},
"split_keywords": [
"openet",
"earth engine",
"evapotranspiration",
"landsat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7017516726dd12c71d64e6a1c65b4ca3d3d8ebb09c6243ed050672fa7f7dc988",
"md5": "ef27e037b8a5fff76686b113a1fabb18",
"sha256": "95e3ebcb0ae7b60cd1fa92d619269f54eadacac19eb6ae7eec4a352ce7ebe84b"
},
"downloads": -1,
"filename": "openet-core-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "ef27e037b8a5fff76686b113a1fabb18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 165964,
"upload_time": "2024-03-19T03:35:09",
"upload_time_iso_8601": "2024-03-19T03:35:09.712043Z",
"url": "https://files.pythonhosted.org/packages/70/17/516726dd12c71d64e6a1c65b4ca3d3d8ebb09c6243ed050672fa7f7dc988/openet-core-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 03:35:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Open-ET",
"github_project": "openet-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openet-core"
}
JSON
