RadGEEToolbox 1.7.3__tar.gz → 1.7.5__tar.gz

{radgeetoolbox-1.7.3 → radgeetoolbox-1.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RadGEEToolbox
-Version: 1.7.3
+Version: 1.7.5
 Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 Home-page: https://github.com/radwinskis/RadGEEToolbox
 Author: Mark Radwin
@@ -43,7 +43,7 @@ Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox m
 
 Although similar packages exist (eemont, geetools, etc.), `RadGEEToolbox` extends functionality and provides cohesive, chainable methods for research oriented projects working with Landsat TM & OLI, Sentinel-1 SAR, and/or Sentinel-2 MSI datasets (Table 1). The ultimate goal of `RadGEEToolbox` is to make satellite image processing easier and faster for real world applications relying on the most commonly utilized remote sensing platforms.
 
-As of version `1.7.3`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
+As of version `1.7.5`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
 
 ***Table 1.*** *Comparison of functionality between RadGEEToolbox, eemont, and geetools.*
 
@@ -185,15 +185,15 @@ _____________
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.7.3 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.5 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.7.3
+pip install RadGEEToolbox==1.7.5
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.7.3 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.5 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -224,7 +224,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.7.3` printed as the version number.
+You should see `1.7.5` printed as the version number.
 
 ### Want to Visualize Data? Install These Too
 

{radgeetoolbox-1.7.3 → radgeetoolbox-1.7.5}/README.md

@@ -14,7 +14,7 @@ Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox m
 
 Although similar packages exist (eemont, geetools, etc.), `RadGEEToolbox` extends functionality and provides cohesive, chainable methods for research oriented projects working with Landsat TM & OLI, Sentinel-1 SAR, and/or Sentinel-2 MSI datasets (Table 1). The ultimate goal of `RadGEEToolbox` is to make satellite image processing easier and faster for real world applications relying on the most commonly utilized remote sensing platforms.
 
-As of version `1.7.3`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
+As of version `1.7.5`, `RadGEEToolbox` supports any generic image collection via the `GenericCollection` module which allows for utilization of the same data management, temporal reduction, zonal statistics, and data export tools available for the `LandsatCollection`, `Sentinel1Collection`, and `Sentinel2Collection` modules. This allows users to provide their own image collection of choice, such as PRISM or MODIS data, to benefit from the tools available with `RadGEEToolbox`.
 
 ***Table 1.*** *Comparison of functionality between RadGEEToolbox, eemont, and geetools.*
 
@@ -156,15 +156,15 @@ _____________
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.7.3 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.5 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.7.3
+pip install RadGEEToolbox==1.7.5
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.7.3 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.7.5 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -195,7 +195,7 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.7.3` printed as the version number.
+You should see `1.7.5` printed as the version number.
 
 ### Want to Visualize Data? Install These Too
 

{radgeetoolbox-1.7.3 → radgeetoolbox-1.7.5}/RadGEEToolbox/CollectionStitch.py

@@ -1,7 +1,7 @@
 import ee
+import warnings
 
-
-def CollectionStitch(img_col1, img_col2, copy_properties_from=1):
+def collectionStitch(img_col1, img_col2, copy_properties_from=1):
     """
     Function to mosaic two RadGEETools image collection objects which share image dates.
     Mosaics are only formed for dates where both image collections have images. Server-side friendly.
@@ -42,8 +42,14 @@ def CollectionStitch(img_col1, img_col2, copy_properties_from=1):
     new_col = ee.ImageCollection.fromImages(image_list)
     return new_col
 
+def CollectionStitch(img_col1, img_col2, copy_properties_from=1):
+    warnings.warn(
+        "CollectionStitch is deprecated. Please use collectionStitch instead.",
+        DeprecationWarning,
+        stacklevel=2)
+    return collectionStitch(img_col1, img_col2, copy_properties_from)
 
-def MosaicByDate(img_col):
+def mosaicByDate(img_col):
     """
     Function to mosaic collection images that share the same date. Server-side friendly. Requires images to have date property of "Date_Filter"
 
@@ -80,3 +86,10 @@ def MosaicByDate(img_col):
 
     # Convert the list of mosaics to an ImageCollection
     return new_col
+
+def MosaicByDate(img_col):
+    warnings.warn(
+        "MosaicByDate is deprecated. Please use mosaicByDate instead.",
+        DeprecationWarning,
+        stacklevel=2)
+    return mosaicByDate(img_col)

{radgeetoolbox-1.7.3 → radgeetoolbox-1.7.5}/RadGEEToolbox/Export.py

@@ -11,6 +11,22 @@ class ExportToDrive:
     `.dates` property for naming files, ensuring readable filenames (e.g., 'MyExport_2023-06-01') 
     instead of long system IDs.
 
+    IMPORTANT: After creating an instance of this class, you must call the `export()` method
+    to initiate the export process.
+
+    For example, to export a RadGEEToolbox collection:
+    ```python
+        collection = LandsatCollection(...)  # Assume this is a RadGEEToolbox object
+        exporter = ExportToDrive(
+            input_data=collection,
+            description="Landsat_Export",
+            folder="GEE_Exports",
+            scale=30,
+            name_pattern="{date}",
+        )
+        exporter.export()
+    ```
+
     Args:
         input_data (ee.Image, ee.ImageCollection, or RadGEEToolbox object): The data to export.
             Can be a single image, a collection, or a RadGEEToolbox wrapper object.