Skip to content

fix: restore the ee_extra dependency #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: restore the ee_extra dependency #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2b6276
fix: restore the ee_extra dependency
12rambau Aug 12, 2025
f54312b
fix: restore the ee_extra dependency
12rambau Aug 12, 2025
473d1fa
refactor: remove deprecated functions
12rambau Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/unit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest]
# dropping 3.12 for now because of https://github.com/r-earthengine/ee_extra/issues/56
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
include:
- os: macos-latest # macos test
Expand Down
5 changes: 0 additions & 5 deletions geetools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@
# it needs to be imported first as it's the mother class
from .ee_computed_object import *

# reproduce older structure of the lib (deprecated)
# will be removed along the deprecation cycle
from . import _deprecated_algorithms as algorithms
from . import _deprecated_composite as composite
from .tools import imagecollection

# then we extend all the other classes
from .ee_asset import Asset
Expand Down
56 changes: 0 additions & 56 deletions geetools/_deprecated_algorithms.py
View file
Open in desktop

This file was deleted.

55 changes: 0 additions & 55 deletions geetools/_deprecated_composite.py
View file
Open in desktop

This file was deleted.

128 changes: 55 additions & 73 deletions geetools/ee_image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@
from typing import Any, Optional

import ee

# import ee_extra
# import ee_extra.Algorithms.core
# import ee_extra.QA.clouds
# import ee_extra.QA.pipelines
# import ee_extra.Spectral.core
# import ee_extra.STAC.core
import ee_extra
import ee_extra.Algorithms.core
import ee_extra.QA.clouds
import ee_extra.QA.pipelines
import ee_extra.Spectral.core
import ee_extra.STAC.core
import geopandas as gpd
import numpy as np
import requests
Expand Down Expand Up @@ -854,6 +853,7 @@ def spectralIndices(
beta: float | int = 0.05,
k: float | int = 0.0,
fdelta: float | int = 0.581,
epsilon: float | int = 1.0,
kernel: str = "RBF",
sigma: str = "0.5 * (a + b)",
p: float | int = 2.0,
Expand Down Expand Up @@ -891,6 +891,7 @@ def spectralIndices(
beta: Calibration parameter used for NDSIns, default = 0.05
k: Slope parameter by soil used for NIRvH2, default = 0.0
fdelta: Adjustment factor used for SEVI, default = 0.581
epsilon: Adjustment constant used for EBI, default to 1.0
kernel: Kernel used for kernel indices, default = 'RBF'
Available options:
- 'linear' : Linear Kernel.
Expand Down Expand Up @@ -919,16 +920,34 @@ def spectralIndices(
image = ee.Image('COPERNICUS/S2_SR/20190828T151811_20190828T151809_T18GYT')
image = image.geetools.spectralIndices(["NDVI", "NDFI"])
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
return ee_extra.Spectral.core.spectralIndices(
x=self._obj,
index=index,
G=G,
C1=C1,
C2=C2,
L=L,
cexp=cexp,
nexp=nexp,
alpha=alpha,
slope=slope,
intercept=intercept,
gamma=gamma,
omega=omega,
beta=beta,
k=k,
fdelta=fdelta,
epsilon=epsilon,
kernel=kernel,
sigma=sigma,
p=p,
c=c,
lambdaN=lambdaN,
lambdaR=lambdaR,
lambdaG=lambdaG,
online=online,
drop=False,
)
# return ee_extra.Spectral.core.spectralIndices(
# self._obj, index, G, C1, C2, L, cexp, nexp, alpha, slope, intercept, gamma, omega,
# beta, k, fdelta, kernel, sigma, p, c, lambdaN, lambdaR, lambdaG, online,
# drop=False,
# )

def getScaleParams(self) -> dict[str, float]:
"""Gets the scale parameters for each band of the image.
Expand All @@ -950,12 +969,7 @@ def getScaleParams(self) -> dict[str, float]:

ee.ImageCollection('MODIS/006/MOD11A2').first().geetools.getScaleParams()
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
)
# return ee_extra.STAC.core.getScaleParams(self._obj)
return ee_extra.STAC.core.getScaleParams(self._obj)

def getOffsetParams(self) -> dict[str, float]:
"""Gets the offset parameters for each band of the image.
Expand All @@ -977,12 +991,7 @@ def getOffsetParams(self) -> dict[str, float]:

ee.ImageCollection('MODIS/006/MOD11A2').first().geetools.getOffsetParams()
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
)
# return ee_extra.STAC.core.getOffsetParams(self._obj)
return ee_extra.STAC.core.getOffsetParams(self._obj)

def scaleAndOffset(self) -> ee.Image:
"""Scales bands on an image according to their scale and offset parameters.
Expand All @@ -1003,12 +1012,7 @@ def scaleAndOffset(self) -> ee.Image:

S2 = ee.ImageCollection('COPERNICUS/S2_SR').first().geetools.scaleAndOffset()
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
)
# return ee_extra.STAC.core.scaleAndOffset(self._obj)
return ee_extra.STAC.core.scaleAndOffset(self._obj)

def preprocess(self, **kwargs) -> ee.Image:
"""Pre-processes the image: masks clouds and shadows, and scales and offsets the image.
Expand Down Expand Up @@ -1037,12 +1041,7 @@ def preprocess(self, **kwargs) -> ee.Image:
.geetools.preprocess()
)
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
)
# return ee_extra.QA.pipelines.preprocess(self._obj, **kwargs)
return ee_extra.QA.pipelines.preprocess(self._obj, **kwargs)

def getSTAC(self) -> dict[str, Any]:
"""Gets the STAC of the image.
Expand Down Expand Up @@ -1099,9 +1098,8 @@ def getDOI(self) -> str:

ee.ImageCollection('NASA/GPM_L3/IMERG_V06').first().geetools.getDOI()
"""
stac = self.getSTAC()
error_msg = "DOI not found in the STAC"
return stac.get("sci:doi", error_msg)
return self.getSTAC().get("sci:doi", error_msg)

def getCitation(self) -> str:
"""Gets the citation of the image, if available.
Expand All @@ -1122,9 +1120,8 @@ def getCitation(self) -> str:

ee.ImageCollection('NASA/GPM_L3/IMERG_V06').first().geetools.getCitation()
"""
stac = self.getSTAC()
error_msg = "Citation not found in the STAC"
return stac.get("sci:citation", error_msg)
return self.getSTAC().get("sci:citation", error_msg)

def panSharpen(self, method: str = "SFIM", qa: str = "", **kwargs) -> ee.Image:
"""Apply panchromatic sharpening to the Image.
Expand All @@ -1151,14 +1148,9 @@ def panSharpen(self, method: str = "SFIM", qa: str = "", **kwargs) -> ee.Image:
source = ee.Image("LANDSAT/LC08/C01/T1_TOA/LC08_047027_20160819")
sharp = source.geetools.panSharpen(method="HPFA", qa=["MSE", "RMSE"], maxPixels=1e13)
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
return ee_extra.Algorithms.core.panSharpen(
img=self._obj, method=method, qa=qa, prefix="geetools", **kwargs
)
# return ee_extra.Algorithms.core.panSharpen(
# img=self._obj, method=method, qa=qa, prefix="geetools", **kwargs
# )

def tasseledCap(self) -> ee.Image:
"""Calculates tasseled cap brightness, wetness, and greenness components.
Expand Down Expand Up @@ -1218,12 +1210,7 @@ def tasseledCap(self) -> ee.Image:
image = ee.Image('COPERNICUS/S2_SR/20190828T151811_20190828T151809_T18GYT')
img = img.geetools.tasseledCap()
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
)
# return ee_extra.Spectral.core.tasseledCap(self._obj)
return ee_extra.Spectral.core.tasseledCap(self._obj)

def matchHistogram(
self,
Expand Down Expand Up @@ -1368,23 +1355,18 @@ def maskClouds(
.geetools.maskClouds(prob = 75,buffer = 300,cdi = -0.5)
)
"""
raise NotImplementedError(
"The ee_extra package is lacking maintainer for several years, it is now incompatible with "
"all the latest version of Python due to use of deprecated pkg_resources. "
" We will try to fix this in the future, but for now please use the ee_extra package directly."
return ee_extra.QA.clouds.maskClouds(
self._obj,
method,
prob,
maskCirrus,
maskShadows,
scaledImage,
dark,
cloudDist,
buffer,
cdi,
)
# return ee_extra.QA.clouds.maskClouds(
# self._obj,
# method,
# prob,
# maskCirrus,
# maskShadows,
# scaledImage,
# dark,
# cloudDist,
# buffer,
# cdi,
# )

def removeProperties(self, properties: list[str] | ee.List) -> ee.Image:
"""Remove a list of properties from an image.
Expand Down
Loading
Loading