initial release

Author: gregory-halverson

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3  # This is already the latest version
+
+      - name: Set up Python
+        uses: actions/setup-python@v4  # This is also the latest version
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]  # Use dev to install pytest
+
+      - name: Run tests
+        run: |
+          pytest

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -1,2 +1 @@
-# SEBAL-soil-heat-flux
-Soil Heat Flux Remote Sensing Method from the Surface Energy Balance for Land (SEBAL) Evapotranspiration Model in Python
+# Soil Heat Flux Remote Sensing Method from the Surface Energy Balance for Land (SEBAL) Evapotranspiration Model in Python

SEBAL_soil_heat_flux/SEBAL_soil_heat_flux.py

@@ -0,0 +1,40 @@
+from typing import Union
+
+import numpy as np
+import rasters as rt
+from rasters import Raster
+
+def calculate_SEBAL_soil_heat_flux(
+        Rn: Union[Raster, np.ndarray], 
+        ST_C: Union[Raster, np.ndarray], 
+        NDVI: Union[Raster, np.ndarray], 
+        albedo: Union[Raster, np.ndarray]) -> Union[Raster, np.ndarray]:
+    """
+    This function calculates the soil heat flux (G) in the Surface Energy Balance Algorithm for Land (SEBAL) model.
+    The formula used in the function is a simplification of the more complex relationship between these variables in the energy balance at the surface.
+    
+    Parameters:
+    Rn (np.ndarray): Net radiation at the surface.
+    ST_C (np.ndarray): Surface temperature in Celsius.
+    NDVI (np.ndarray): Normalized Difference Vegetation Index, indicating the presence and condition of vegetation.
+    albedo (np.ndarray): Measure of the diffuse reflection of solar radiation.
+    
+    Returns:
+    np.ndarray: The soil heat flux (G), a key component in the energy balance.
+    
+    Reference:
+    "Evapotranspiration Estimation Based on Remote Sensing and the SEBAL Model in the Bosten Lake Basin of China" [^1^][1]
+    """
+    # Empirical coefficients used in the calculation
+    coeff1 = 0.0038
+    coeff2 = 0.0074
+    
+    # Vegetation cover correction factor
+    NDVI_correction = 1 - 0.98 * NDVI ** 4
+    
+    # Calculation of the soil heat flux (G)
+    G = Rn * ST_C * (coeff1 + coeff2 * albedo) * NDVI_correction
+    
+    G = rt.clip(G, 0, None)
+
+    return G

SEBAL_soil_heat_flux/__init__.py

@@ -0,0 +1,9 @@
+from .SEBAL_soil_heat_flux import *
+
+from os.path import join, abspath, dirname
+
+with open(join(abspath(dirname(__file__)), "version.txt")) as f:
+    version = f.read()
+
+__version__ = version
+__author__ = "Gregory H. Halverson"

SEBAL_soil_heat_flux/version.txt

@@ -0,0 +1 @@
+1.0.1

makefile

@@ -0,0 +1,59 @@
+PACKAGE_NAME = SEBAL-soil-heat-flux
+ENVIRONMENT_NAME = $(PACKAGE_NAME)
+DOCKER_IMAGE_NAME = $(PACKAGE_NAME)
+
+clean:
+	rm -rf *.o *.out *.log
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info
+	rm -rf .pytest_cache
+	find . -type d -name "__pycache__" -exec rm -rf {} +
+
+test:
+	pytest
+
+build:
+	python -m build
+
+twine-upload:
+	twine upload dist/*
+
+dist:
+	make clean
+	make build
+	make twine-upload
+
+remove-environment:
+	mamba env remove -y -n $(ENVIRONMENT_NAME)
+
+install:
+	pip install -e .[dev]
+
+uninstall:
+	pip uninstall $(PACKAGE_NAME)
+
+reinstall:
+	make uninstall
+	make install
+
+environment:
+	mamba create -y -n $(ENVIRONMENT_NAME) -c conda-forge python=3.10
+
+colima-start:
+	colima start -m 16 -a x86_64 -d 100 
+
+docker-build:
+	docker build -t $(DOCKER_IMAGE_NAME):latest .
+
+docker-build-environment:
+	docker build --target environment -t $(DOCKER_IMAGE_NAME):latest .
+
+docker-build-installation:
+	docker build --target installation -t $(DOCKER_IMAGE_NAME):latest .
+
+docker-interactive:
+	docker run -it $(DOCKER_IMAGE_NAME) fish 
+
+docker-remove:
+	docker rmi -f $(DOCKER_IMAGE_NAME)

pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=60", "setuptools-scm>=8.0", "wheel"]
+
+[project]
+name = "SEBAL-soil-heat-flux"
+version = "1.0.1"
+description = "Soil Heat Flux Remote Sensing Method from the Surface Energy Balance for Land (SEBAL) Evapotranspiration Model in Python"
+readme = "README.md"
+authors = [
+    { name = "Gregory Halverson", email = "[email protected]" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "numpy",
+    "rasters"
+]
+
+requires-python = ">=3.10"
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "pytest>=6.0",
+    "pytest-cov",
+    "jupyter",
+    "pytest",
+    "twine"
+]
+
+[tool.setuptools.package-data]
+SEBAL_soil_heat_flux = ["*.txt"]
+
+[project.urls]
+"Homepage" = "https://github.com/JPL-Evapotranspiration-Algorithms/SEBAL-soil-heat-flux"

tests/test_import_SEBAL_soil_heat_flux.py

@@ -0,0 +1,2 @@
+def test_import_SEBAL_soil_heat_flux():
+    from SEBAL_soil_heat_flux import calculate_SEBAL_soil_heat_flux

tests/test_import_dependencies.py

@@ -0,0 +1,12 @@
+import pytest
+
+# List of dependencies
+dependencies = [
+    "numpy",
+    "rasters"
+]
+
+# Generate individual test functions for each dependency
+@pytest.mark.parametrize("dependency", dependencies)
+def test_dependency_import(dependency):
+    __import__(dependency)